Editor REST api - users

This API is a RESTful service which provides methods for accessing specific resources at canonical URLs and for searching and filtering sets of resources by various criteria. Our webapp is build on this API. The list of API methods below is not a complete list of all available methods.

All representations are encoded as JSON objects.

• GET: Used for retrieving resources. Safe and idempotent method.
• POST: Used for creating new resources. Unsafe and non-idempotent method.
• PUT: Used for changing the attributes of a model. Unsafe and idempotent method.
• DELETE: Used for deleting resources. Unsafe and idempotent method.

Safe methods?

Safe methods are HTTP methods that do not modify resources.

Idempotent methods?

An idempotent HTTP method is a HTTP method that can be called many times without different outcomes.

Bearer authentication (also called token authentication) is an HTTP authentication scheme that involves security tokens called bearer tokens. The name “Bearer authentication” can be understood as “give access to the bearer of this token.” The bearer token is a cryptic string, usually generated by the server in response to a login request. The client must send this token in the Authorization header when making requests to protected resources. The bearer token is short-lived.

POST and PUT requests should send the data in the body of the request as JSON object.

All PUT and POST requests accept single objects as request data. Some methods also accept batch requests, for which the request data will be an array of objects.

Request for a single object

{
	"key1": "string1",
	"key2": 2,
	"key3": "string3"
}

Batch request data (i.e. POST /api/price)

[{
	"key1": "string1a",
	"key2": 2,
	"key3": "string3a
},
{
	"key1": "string1b",
	"key2": 2,
	"key3": "string3b"
}]

When a request is successful, a response body will typically be sent back in the form of a JSON object. An exception to this is when a DELETE request is processed, which will result in a successful HTTP 204 status.

The value of the response will generally be a JSON object for a request on a single object and an array of objects for a request on a collection of objects.

Response for a single object (i.e. /api/user/83654)

{
	"id": 83654,
	"first_name": "John",
	"last_name": "Doe"
}

Response for a collection of objects (i.e. /api/user)

[{
	"id": 83654,
	"first_name": "John",
	"last_name": "Doe"
},
{
	"id": 83655,
	"first_name": "Mickey",
	"last_name": "Mouse"
}]

GET requests without id parameters return a limited result set. The size of the result set is subject to the provided limit parameter in the request, with a maximum value of 1000. The index of the first record in the result set is subject to the offset parameter in the request.

GET requests (without id) will return three headers that can be used for pagination of the result set:

1. X-Total-Records: The total number of records found in the database for the requested resource
2. X-Pagination-Next: This header will be set when there are additional results available not included in the returned result set. The value is the API URL to get the next set of results.
3. X-Pagination-Previous: This header will be set when there are previous results available. The value is the API URL to navigate back to the previous result set.