Authentication token for either an application or session.
View of session object you would like returned.
If passed as true, the API will return a count key which contains the full amount of results.
View of application object you would like returned.
The view attribute controls the params passed back in the results.
Search parameters for filtering results
Term that is being searched against.
Attributes that search term is compared against.
Array of filters that can be applied to filter results.
Pagination parameters for controlling page results
Number of items returned in paginated results.
Page number that controls the offset of the paginated results.
Sorting parameters for controlling the order of the results
Attribute that results are sorted by.
Controls whether the result are sorted in ascending or descending order.
Request Body Example:
This status indicates that the request was successful. If the request returns data, it can be found in the data key.
This status is returned when the authentication token passed is invalid.
This status is returned a session is older than seven days or hasn't been used in 72 hours. The user will need to reauthenticate. We allow our users to save a remember_me preference which will make there sessions last indefinitely.
This status is returned when the user makeing the request doesn't have a client, employee or liaison record. This means that they don't have any roles or permissions. Because we only allow our clients to register as a client, the user should be redirected to the PlanoAuth clients registration page where they can use the `/api/v1/users/client_register` API to register as a client. Eventhough the request will not be successful, this status will still return a `session` object because a session token is needed to register as a user.
This status is returned when a required param was not passed with the request.
This status is returned when a param was invalid when passed. For example, passing an id that doesn't exist or passing an invalid email address.
This status is returned when there is an internal server error. Please try again later.
This status is returned when there was an issue using Mandrill to send an email. Any time this response is returned, there will be a notification in the production notifications tab so the dev team will be away of the failure. These errors will most likely correlate with a data issue and will need to be invesigated.
This status is returned if the request was made with the incorrect content-type so the request params could not be read. For more infromation on content-type, please refer to https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Type.
Response returned when HTTP route does not exist.
The responses below are not very common.
This status is returned the request body was decoded, but no params where found.
This status is returned when the request body could not be decoded properly. This generally means that you are requesting a sensative_params API and your request body was not base64 encoded.
This status is returned when the route record being requested hasn't been deployed yet.
This status is returned when there is an internal server error before the route could be identified. Please try again later.
This status is returned when the route's API service record being requested hasn't been deployed yet.