Agendize queues API

Registrations

Resource representation

{ "id": {string}, "author": {string}, "queue": { "id": {string}, "name": {string} }, "registered": { "datetime": {string}, "timeZone": {string} }, "client": { "id": {string}, "firstName": {string}, "lastName": {string}, "emailAddress": {string}, "phoneNumber": {string}, "selfLink" : {string} }, "status": {string} }

Parameter name	Value	Description
`id`	`string`	Identifier of the result.
`author`	`string`	Author of the result's form.
`queue`	`object`	The queue of the registration queue.
`queue.id`	`string`	Identifier of the queue. Writable.
`queue.name`	`string`	Name of the queue.
`registered`	`object`	The registration time of the registration queue.
`registered.dateTime`	`string`	The time, as a combined date-time value (formatted according to RFC 3339, without time zone information).
`registered.timeZone`	`string`	The time zone. Possible values can be found here. The default value is the time zone of the company.
`client`	`object`	The client linked with the registration queue.
`client.id`	`string`	Identifier of the client. Writable.
`client.firstName`	`string`	First name of the client. Writable. Max length: 127.
`client.lastName`	`string`	Last name of the client. Writable. Max length: 127.
`client.emailAddress`	`string`	Email address of the client. Writable. Max length: 127.
`client.phoneNumber`	`string`	Phone number of the client. Writable. Max length: 127.
`client.selfLink`	`string`	URL link to the client resource description.
`status`	`string`	The status of the registration queue. Values: "registered", "noShow", "onGoing", "finished".

Delete

Authentication is required to execute this request. Please refer to Authentication for more.

Request

HTTP Request

DELETE https://api.agendize.com/api/2.0/queues/{queueId}/registrations/{registrationId}

Parameters

Parameter name	Value	Description
Path parameters
`queueId`	`string`	Queue identifier.
`registrationId`	`string`	Registration identifier.

Request body

Do not supply a request body with this method.

Response

If successful, this method returns an empty response body.

Get

Authentication is required to execute this request. Please refer to Authentication for more.

Request

HTTP Request

GET https://api.agendize.com/api/2.0/queues/{queueId}/registrations/{registrationId}

Parameters

Parameter name	Value	Description
Path parameters
`queueId`	`string`	Queue identifier.
`registrationId`	`string`	Registration identifier.

Request body

Do not supply a request body with this method.

Response

If successful, this method returns a Registration resource in the response body.

List

Authentication is required to execute this request. Please refer to Authentication for more.

Request

HTTP Request

GET https://api.agendize.com/api/2.0/queues/{queueId}/registrations

Parameters

Parameter name	Value	Description
Path parameters
`queueId`	`string`	Queue identifier.
Optional query parameters
`status`	`string`	Gets registrations by status.

Request body

Do not supply a request body with this method.

Response

If successful, this method returns a response body with the following structure:

{ items: [Registrations Resource] }

Insert

Authentication is required to execute this request. Please refer to Authentication for more.

Request

HTTP Request

POST https://api.agendize.com/api/2.0/queues/{queueId}registrations


Parameters

	
		
			Parameter name
			Value
			Description
		
	
	
		
			Path parameters
		
		
			queueId
			string
			Queue identifier.
		
	

Request body
In the request body, supply a Registration Resource with the following properties:

	
		
			Parameter name
			Value
			Description
		
	
	
		
			Required Properties
		
		
			queue
			string
			Id of the queue.
		
		
			Optional Properties
		
		
			client.id
			string
			Identifier of the client.
		
		
			client.firstName
			string
			First name of the client.
		
		
			client.lastName
			string
			Last name of the client.
		
		
			client.emailAddress
			string
			Email address of the client.
		
		
			client.selfLink
			string
			URL link to the client resource description.
		
		
			status
			string
			The status of the registration queue. Values: "registered", "noShow", "ingoing", "finished".
		
	

Response
If successful, this method returns a Registration resource in the response body.


Update
Authentication is required to execute this request. Please refer to Authentication for more.
Request
HTTP Request
PUT https://api.agendize.com/api/2.0/queues/{queueId}/registrations/{registrationId}
Parameters

	
		
			Parameter name
			Value
			Description
		
	
	
		
			Path parameters
		
		
			queueId
			string
			Queue identifier.
		
		
			registrationId
			string
			Queue registration identifier.
		
	

Request body
In the request body, supply a Registration resource with the following properties:

	
		
			Parameter name
			Value
			Description
		
	
	
		
			Optional Properties
		
		
			id
			string
			Id of the queue inscription.
		
	

Response
If successful, this method returns a Registration resource in the response body.


Next
Authentication is required to execute this request. Please refer to Authentication for more.
Request
HTTP Request
GET https://api.agendize.com/api/2.0/queues/{queueId}/registrations/next
Parameters

	
		
			Parameter name
			Value
			Description
		
	
	
		
			Path parameters
		
		
			queueId
			string
			Queue identifier.
		
	

Request body
Do not supply a request body with this method.
Response
If successful, this method returns a Registration resource in the response body.

Parameter name	Value	Description
Required Properties
`queue`	`string`	Id of the queue.
Optional Properties
`client.id`	`string`	Identifier of the client.
`client.firstName`	`string`	First name of the client.
`client.lastName`	`string`	Last name of the client.
`client.emailAddress`	`string`	Email address of the client.
`client.selfLink`	`string`	URL link to the client resource description.
`status`	`string`	The status of the registration queue. Values: "registered", "noShow", "ingoing", "finished".

Agendize Developers API

Registrations

Resource representation

Delete

Request

HTTP Request

Parameters

Request body

Response

Get

Request

HTTP Request

Parameters

Request body

Response

List

Request

HTTP Request

Parameters

Request body

Response

Insert

Request

HTTP Request

Parameters

Request body

Response

Update

Request

HTTP Request

Parameters

Request body

Response

Next

Request

HTTP Request

Parameters

Request body

Response