Overview

Overview

Jfamerwork exposes the following APIs for developers to consume in their applications.

Compatibility rules

Input parameters

• Requests are compatible irrespective of the order in which the query parameters appear.

• Requests are compatible irrespective of the order in which the properties of the JSON parameters appear.

• New query parameters may be added to future versions of requests.

• Existing query parameters can’t be removed from future versions of requests.

• Existing properties can’t be removed from the JSON parameters in future versions of requests.

JSON responses

• Responses are compatible irrespective of the order in which the properties appear.

• New properties may be added to future versions of the response.

• Existing properties can’t be removed from future versions of the response.

• Properties with null values may be omitted by responses.

Media types

The API currently supports only JSON as an exchange format. Be sure to set both the Content-Type and Accept headers for every request as application/json.

HTTP verbs

Where possible, the Jframework API strives to use appropriate HTTP verbs for each action.

Verb	Description
GET	Used to retrieve objects.
POST	Used to create objects or perform custom actions.
PUT	Used to replace objects or collections.
DELETE	Used to delete objects.

Pagination

Requests that return a list of objects may support pagination. Pagination is implemented using a cursor-based system, rather than traditional page numbers. The cursor is an opaque value (not interpretable by the client) and is specified using either the pageNumber or pageSize query parameter.

Param	Description
pageNumber	Specifies the cursor for pagination. The value is opaque and client-specific.
pageSize	Specifies the number of items to return per page.

Response Object

The response object includes the following field:

• totalItems: The total number of items available across all pages.

Errors

Errors

Rate Limiting

Rate Limiting

Authentication

Authentication