Agendize queues API

Registrations


Resource representation

{ "id": {string}, "client": { "id": {string}, "firstName": {string}, "lastName": {string}, "selfLink": {string} }, "assigned": { "datetime": {string}, "timeZone": {string} }, "expiration": { "datetime": {string}, "timeZone": {string} }, "status": {string} }
Parameter name Value Description
id string Identifier of the result.
assigned object The assigned time of the discount's assignment.
assigned.dateTime string The time, as a combined date-time value (formatted according to RFC 3339, without time zone information).
assigned.timeZone string The time zone. Possible values can be found here. The default value is the time zone of the company.
expiration object The expiration time of the discount's assignment.
expiration.dateTime string The time, as a combined date-time value (formatted according to RFC 3339, without time zone information).
assigned.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 discount.
client.id string Identifier of the client.
client.firstName string First name of the client.
client.lastName string Last name of the client.
client.selfLink string URL link to the client resource description.
status string The status of the assignment. Values: "enabled", "disabled".

Delete

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

Request

HTTP Request

DELETE http://az2.agendize.com/api/2.0/discounts/{discountId}/assignments/{assignmentId}

Parameters

Parameter name Value Description
Path parameters
discountId string Discount identifier.
assignmentId string Assignment 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 http://az2.agendize.com/api/2.0/discounts/{discountId}/assignments/{assignmentId}

Parameters

Parameter name Value Description
Path parameters
discountId string Queue identifier.
assignmentId string Assignment identifier.

Request body

Do not supply a request body with this method.

Response

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


List

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

Request

HTTP Request

GET http://az2.agendize.com/api/2.0/discounts/{discountId}/assignments

Parameters

Parameter name Value Description
Path parameters
discountId string Discount identifier.

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: [Assignment Resource] }

Insert

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

Request

HTTP Request

POST http://az2.agendize.com/api/2.0/discounts/{discountId}/assignments

Parameters

Parameter name Value Description
Path parameters
discountId string Discount identifier.

Request body

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

Parameter name Value Description
Required Properties
client object Id of the queue.

Response

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


Update

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

Request

HTTP Request

PUT http://az2.agendize.com/api/2.0/discounts/{discountId}/assignments/{assignmentId}

Parameters

Parameter name Value Description
Path parameters
discountId string Discount identifier.
assignmentId string Discount assignment identifier.

Request body

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

Parameter name Value Description
Optional Properties
id string Id of the discount assignment.

Response

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