Requests and Responses

Request URLs

Each resource or resource collection in a RESTful API is identified by a unique URL.
For example:

http://<localhost>:<port>/<servername>/PublicApi/<Endpoints>

<localhost> is the hostname with port number if IID is installed on any particular port.

<servername> is the site name which is configured in IIS.

Example: https://localhost/IdentityDirector/PublicApi/Authentication/Login

Format

The response format used (including for error responses) is JSON, a lightweight serialization language that is compatible with many different languages.

Standard Response Codes

Conventional HTTP response codes are used to indicate the success or failure of an API request.

• 2xx-range codes indicate success

• 4xx-range codes indicate an error that resulted from the caller provided information (e.g. a required parameter was missing, a charge failed, etc.)

• 5xx-range codes indicate an error with the server

Errors are returned using standard HTTP error code syntax. Any additional info is included in the body of the return call, JSON-formatted.