Response Data

Responses

This document lays out the format of the responses from the API. Response data will be formatted as a JSON object in the body of the response. Some requests may not return any JSON (see below). The http code returned by the server should be used to determine the format of the JSON in the response (see URIs for http code info). Values will be stored in the upper-level JSON object and there is no nesting of objects/arrays. Values will be primitives like strings, boolean, numbers, or null.

Example

{
    "authKey": "h3r3-is-s0m3-k1nd-0f-4uth-k3y",
}

The formats below only apply for 200 SUCCESS responses. 'Failure' responses (see URIs for the failure HTTP codes for a given request) usually return a special JSON object that takes the form detailed in the table below. Be careful though, not all failure responses will have this object. If there are timeouts or exceptions thrown that are not caught, the API may not create a nicely packaged failure response.

Key	Type	Length	Description	Always Exists
niceMessage	string	??	A 'nice' error message this could be shown to the user	Yes
debugMessage	string	??	A more technical error message that could be used to debug why a failure was returned	Yes

Authentication

Key	Type	Length	Description	Always Exists (when 200 SUCCESS)
authKey	string	36	authKey for session. See [requests](Request Data) for what to do with this.	Yes

Employee Information Storage

An empty JSON object is always returned in the case of 200 SUCCESS.

Ticket Submission

An empty JSON object is always returned in the case of 200 SUCCESS.