Get Glue: API: Errors

In the case that the Glue API encounters one of a list of expected errors, it will set the applicable HTTP status code and return an error document. In the case that an unexpected error occurs, an HTTP 500 will be sent with a blank document.

Error documents are in the following form:

<adaptiveblue>
	<request>
    	<method>methodName</method>
    	<params>
        	<paramName1>paramValue1</paramName1>
        	<paramName2>paramValue2</paramName2>
        	...
    	</params>
	</request>
	<error>
		<code>###</code>
		<name>ShortName</name>
		<message>Human-readable message</message>
	</error>
</adaptiveblue>

Missing Input

MissingParameter

A parameter required by the method was left unset or blank.

Code - 101
HTTP Status - 400 (Bad Request)

Authentication

AuthenticationFailed

The user's authentication credentials are incorrect.

Code - 201
HTTP Status - 401 (Unauthorized)

PermissionError

The authenticated user does not have permission to access the requested resource (i.e. a protected user's interactions).

Code - 202
HTTP Status - 401 (Unauthorized)

Invalid Input

InvalidURL

The URL provided as an objectId is invalid.

Code - 301
HTTP Status - 400 (Bad Request)

InvalidObject

The objectKey provided as an objectId is invalid or could not be found.

Code - 302
HTTP Status - 400 (Bad Request)

InvalidInteraction

The interaction requested could not be found.

Code - 303
HTTP Status - 400 (Bad Request)

InvalidUser

The userId provided is invalid.

Code - 304
HTTP Status - 400 (Bad Request)

GetGlue

Glue API: Errors