About RESTful API

Version 1 by Bren Eckles
on Nov 02, 2017 16:57.

compared with
Current by Bren Eckles
on Oct 30, 2018 12:37.

This line was removed.
This word was removed. This word was added.
This line was added.

Changes (11)

View Page History
h4. 1.8 Date Formats

All dates returned by the Rest API will be in ISO-8601 + RFC-822 Extended Combined Date and Time format:


ss = second
SSS = millisecond
ZZZZZ = Timezone in format of 5 required characters: ±HHmm
ZZZZZZ = Timezone in format of 6 required characters: ±HH:mm
± either plus \(+) or minus \(-) to represent the UTC offset from UTC (Coordinated Universal Time (GMT))
HH (hour) mm(minute) format

GMT time would be \-0000 (zero hour, zero minute offset from UTC)
GMT time would be \+00:00 (zero hour, zero minute offset from UTC; the ’Zulu’ form will not be returned)


See [http://en.wikipedia.org/wiki/ISO_8601#UTC]
h4. 1.11 HTTP Responses

The HTTP response depends on the type of operation.  There are three general types of responses:
# GET single entity - returns a single entity in JSON or XML
# GET collection - used on queries, returns a collection of entities in JSON or XML
h6. Get Operations

When looking up by primary key, GET operations return a single entity. All other GET operations like queries, will return a collection of one or more entities, wrapped by a container element.  GET operation responses are dependent on the HTTP code. Your code should always check the HTTP status code prior to looking at the HTTP response:
* 200 - a successful request. The HTTP response body contains a single entity or collection of entities
* 404 - not found. There will be no response body in this case