Sample API Doc

/users/{id}

GET

Request

Name	Type	Description	Default	Required	Constraints	Example
id	string	User ID		Required
options	string	User Options	guest	Optional

Response

Object: User

Name	Type	Description	Required	Constraint	Example
id	string	The unique ID of the user	Optional	{"maxLength":30}
firstName	string	The first name of the user	Optional	{"maxLength":30,"pattern":"[a-z\d~+-]+"}
lastName	string	The last name of the user	Optional	{"maxLength":30,"pattern":"[a-z\d~+-]+"}
created	string	When the user record was created	Optional	{"format":"date-time"}	2018-01-01T12:00:00Z
modified	string	When the user record was last modified	Optional	{"format":"date-time"}	2018-01-01T12:00:00Z
email	string	The email address of the user	Optional	{"format":"email"}
enabled	boolean	Whether the user is enabled or not	Optional
age	int	The age of the user	Optional	{"$ref":"age.json"}	29

Embedded

rel	src
ticket	/ticket/{id}

Links

rel	href
person	/person
calendar	/calendar

POST

Create user

Create user with given name and age

Request

Name	Type	Description	Default	Required	Constraints	Example
name	string	The name of the user		Required
age	int	The age of the user		Required

Response

(n/a)