{{warning}}

API Errors

The following describe the various errors which may be returned by the CoreSpring API.

Invalid Object Id

The provided object id was not valid.

{
  "message" : "Invalid object id: id, context: context",
  "errorType" : "invalidObjectId"
}

Missing Required Field

A field that was required was missing

{
  "message" : "Missing the following required field(s): name : type",
  "errorType" : "missingRequiredField"
}

Encryption Failed

Attempting to encrypt player options failed.

{
  "message" : "encryption failed: msg",
  "errorType" : "encryptionFailed"
}

Permission Not Granted

The requested permission was not granted.

{
  "message" : "msg",
  "errorType" : "permissionNotGranted"
}

Compound Error

There were multiple errors processing the request.

{
  "message" : "msg",
  "errorType" : "compoundError",
  "subErrors" : [ ]
}

Invalid Query String

The provided query string was not valid.

{
  "message" : "Bad query string parameter name: badName - you should be using expectedName",
  "errorType" : "invalidQueryStringParameter"
}

No API Client and Player Token in Query String

An API client and player token were required in order to perform the operation, but they were not provided in the request.

{
  "message" : "/ - No 'apiClient' and 'playerToken' in queryString",
  "errorType" : "noApiClientAndPlayerTokenInQueryString"
}

No Access Token

An access token was required to perform the operation, but it was not provided by the request.

{
  "message" : "/path - No access token",
  "errorType" : "noToken"
}

No User Session

A user session was required to perform the operation, but it was not provided by the request.

{
  "message" : "/path - No user session",
  "errorType" : "noUserSession"
}

Invalid Access Token

An access token was provided by the request, but it was not valid.

{
  "message" : "/path - Invalid access token",
  "errorType" : "invalidToken"
}

Expired Access Token

An access token was provided by the request, but it has expired.

{
  "message" : "/path - Expired access token",
  "errorType" : "expiredToken"
}

No Organization For Token

The access token provided by the request is not associated with any known organization.

{
  "message" : "/path - No organization for access token Some(access_token)",
  "errorType" : "noOrgForToken"
}

No Default Collection

There was no default collection associated with the organization obtained from the request.

{
  "message" : "No default collection defined for org 55a3ea8877c80afb3dea3b65",
  "errorType" : "noDefaultCollection"
}

General Error

There was a general, non-specific error processing the request.

{
  "message" : "msg",
  "errorType" : "generalError"
}

No JSON

The body of the provided request was required to contain JSON, but it was not found.

{
  "message" : "No json in request body",
  "errorType" : "noJson$"
}

Invalid JSON

The JSON body provided by the request was not valid.

{
  "message" : "Invalid json str",
  "errorType" : "invalidJson"
}

Error Saving

There was an error attempting the requested save operation.

{
  "message" : "Error saving",
  "errorType" : "errorSaving$"
}

Need JSON Header

The server expected the request to contain the Content-Type: application/json header.

{
  "message" : "You need to set the Content-Type to 'application/json'",
  "errorType" : "needJsonHeader$"
}

Property Not Found In JSON

The request's JSON body was expected to contain the provided property, but it was not fonud.

{
  "message" : "can't find name in request body",
  "errorType" : "propertyNotFoundInJson"
}

No Organization ID and Options

The organization id and player options could not be read from the request.

{
  "message" : "can not load orgId and PlayerOptions from session: Map()",
  "errorType" : "noOrgIdAndOptions"
}

No Collection ID for Item

The item did not have a corresponding collection identifier.

{
  "message" : "This item has no collection id 55a3ea8977c80afb3dea3b66:0",
  "errorType" : "noCollectionIdForItem"
}

Invalid Collection ID

The idem did not have a valid collection identifier.

{
  "message" : "invalid collectionId in item collectionId in item 55a3ea8977c80afb3dea3b67:0",
  "errorType" : "invalidCollectionId"
}

Organization Can't Access Collection

The request is not valid because the associated organization does not have the requested access for the collection.

{
  "message" : "The org: 55a3ea8977c80afb3dea3b68 can't access (read) collection: collectionId",
  "errorType" : "orgCantAccessCollection"
}

Can't Load Session

The provided session cannot be loaded.

{
  "message" : "Can't load session with id sessionId",
  "errorType" : "cantLoadSession"
}

No Item ID in Session

The session specified by the request did not correspond to an item id.

{
  "message" : "no item id in session: sessionId",
  "errorType" : "noItemIdInSession"
}

Can't Parse Item ID

The item id provided by the request could not be parsed.

{
  "message" : "Can't parse itemId: itemId",
  "errorType" : "cantParseItemId"
}

Can't Find Item with ID

The item with the id provided by the request could not be found.

{
  "message" : "Can't find item with id 55a3ea8977c80afb3dea3b69:0",
  "errorType" : "cantFindItemWithId"
}

Can't Find Organization with ID

The organization with the id provided by the request could not be found.

{
  "message" : "Can't find org with id 55a3ea8977c80afb3dea3b6a",
  "errorType" : "cantFindOrgWithId"
}

Adding an Answer Requires Participant ID

The request specified to add an answer to the assessment, but an identifier for the participant was not specified.

{
  "message" : "Cannot add an answer to assessment 55a3ea8977c80afb3dea3b6b without id",
  "errorType" : "addAnswerRequiresId"
}

Aggregate Requires Item Id

The request specified to aggregate the data for an assessment, but item_id was not specified in the query string.

{
  "message" : "Aggregate for 55a3ea8977c80afb3dea3b6c requires item_id in query string",
  "errorType" : "aggregateRequiresItemId"
}

Invalid Permission Value

The permission value for the request was not valid for the collection and organization.

{
  "message" : "Unknown pval: 3 for collection collectionId in org: 55a3ea8977c80afb3dea3b6d",
  "errorType" : "invalidPval"
}

Incorrect JSON format

The format of the JSON specific by the request was incorrect for the request asked to be performed.

{
  "message" : "Bad json format {}",
  "errorType" : "incorrectJsonFormat"
}

Organization Doesn't Refer to Collection

The orgianization provided by the request does not refer to the collection provided by the request.

{
  "message" : "org 55a3ea8977c80afb3dea3b6e doesn't refer to collection: collectionId",
  "errorType" : "orgDoesntReferToCollection"
}

Inaccessible Item

The organization specified by the request cannot access the item with the specified permission.

{
  "message" : "org: 55a3ea8977c80afb3dea3b70 can't access item: 55a3ea8977c80afb3dea3b6f:0 with permission write",
  "errorType" : "inaccessibleItem"
}

Unauthorized

The request was not authorized with the provided credentials.

{
  "message" : "error, error",
  "errorType" : "unAuthorized"
}

Insufficient Permission

The provided authentication does not have the permissions necessary to process the request.

{
  "message" : "read does not allow write",
  "errorType" : "insufficientPermission"
}

Can't Find Session

The session with the id provided by the request could not be found.

{
  "message" : "Can't find session with id: sessionId",
  "errorType" : "cantFindSession"
}

Session Does Not Contain Responses

The session specified by the request does not contain any responses.

{
  "message" : "session: sessionId does not contain any responses",
  "errorType" : "sessionDoesNotContainResponses"
}