IEE REST API general guidelines

• The body of request and response messages of the REST APIs is a JSON (JavaScript Object Notation) data format.

• All request and response date times are specified in ISO 8601 format, YYYY-MM-DDThh:mmZ.

  Examples:

  2020-01-01T00:00:00Z

  2020-01-01T23:00:00-05:00

  2020-01-01T01:15:00+01:00

• Standard Response Status Code

  Success: 200 - OK , 204 - No Content

  Failure: 401 - Unauthorized,403 - Access Forbidden

• Each endpoint is associated with one or more HTTP methods, such as GET, POST, PUT, DELETE, that define the action to be performed on the resource.

• Endpoints can accept parameters to filter, sort, or specify the requested data. These parameters can be passed as query parameters in the URL or as part of the request body in POST or PUT requests.

Related topics:

• REST APIs

• Generating an Authorization token from the Identity Sync service