REST API HTTP INTERFACE

The table below describes the routes that the HTTP interface provides. This HTTP interface is available for all models in Learning Locker.

For example, to get a count of stores via this API, you’d use the following route.

To access this interface, you must additionally supply your Basic Auth details with each request in the Authorization header. Your Basic Auth details can be found under Settings > Clients.

MODELS

The table below lists the models supported by this interface, you can view the model schemas by clicking the model names.

ROUTES

GET /COUNT

This route returns a count of the models. A request to this route would look something like the request below.

A request like the one above, will respond with a 200 response like the one below containing a count of the models in the body.

For more information about the acceptable URL query parameters, view the Restify documentation. Note that the limit parameter will default to 10 if not given and cannot exceed 1,000 if it is given.

Important: In case of User route, query parameter will be ignored and search parameter should be used instead (only available in Enterprise). search query parameter is a simple string and will be transformed into filter shown below.

GET /

This route returns an array of models. A request to this route would look something like the request below.

A request like the one above, will respond with a 200 response like the one below containing the models as JSON in the body. Different models will respond with a different schema, you can view the schemas by clicking the model names in the model table above.

For more information about the acceptable URL query parameters, view the Restify documentation.

Important: In case of User route, query parameter will be ignored and search parameter should be used instead. search query parameter is a simple string and will be transformed into filter shown below.

POST /

This route creates a model. A request to this route would look something like the request below. Different models will require and respond with a different schema, you can view the schemas by clicking the model names in the model table above.

A request like the one above, will respond with a 201 response like the one below containing the created model in the JSON body.

GET /:ID

This route returns a single model that has the specified identifier from the URL. A request to this route would look something like the request below.

A request like the one above, will respond with a 200 response like the one below containing the model as JSON in the body. Different models will respond with a different schema, you can view the schemas by clicking the model names in the model table above. Note that the request will return a 404 response if the model doesn’t exist.

For more information about the acceptable URL query parameters, view the Restify documentation.

PUT OR POST /:ID

This route creates or updates a single model that has the specified identifier from the URL. A request to this route would look something like the request below. Different models will require and respond with a different schema, you can view the schemas by clicking the model names in the model table above.

A request like the one above, will respond with a 200 response like the one below containing the model as JSON in the body.

PATCH /:ID

This route patches a single model that has the specified identifier from the URL. A request to this route would look something like the request below. Different models will require and respond with a different schema, you can view the schemas by clicking the model names in the model table above.

A request like the one above, will respond with a 200 response like the one below containing the model as JSON in the body.

DELETE /:ID

This route deletes a single model that has the specified identifier from the URL. A request to this route would look something like the request below.

A request like the one above, will respond with a 204 response like the one below.