REST Conventions
The following table describes general conventions related to the Lookout Mobile Risk API’s RESTful style:
Convention | Meaning |
---|---|
Endpoints | Endpoints use plural nouns for resource names, e.g.,
/events , unless existing Lookout conventions apply, e.g.,
/health . |
Fields | Fields are named using a camelcase format, e.g.,
emailAddress . |
Dates | Date values are formatted based on the ISO-8601 standard of
yyyymmdd , e.g.,
20170510 . |
Links | Where appropriate, links are shown in the HATEOAS style, e.g.,
https://api.lookout.com/devices/1 . |
Objects |
Objects are shown and defined using a discriminator field type as in this JSON object example:
|