Home > Agendize Scheduling

Resources


Resource representation

{ "id": {string}, "name": {string}, "duration": {integer}, "count": {integer}, "color": {color}, "description": {string}, "price": {float}, "payable": {boolean}, "picture": { "url": {string}, "mimeType": {string} }, "workingHours": [ { "day": "monday", "hours": [ { "start": "09:00", "end": "18:00" } ] } ], "externalId": {string} }
Parameter name Value Description Notes
id string Identifier of the resource.
name string Name of the resource. writable
duration integer Resource duration, in minutes. writable
count integer Resource quantity available. writable
color string Resource color, for dashboard displaying. Hexadecimal web color. Default Color: #EFEFEF. writable
description string Description of the resource. writable
picture object Resource picture url and mime type. writable
picture.url string Url of the resource picture.
picture.mimeType string Mime type of the resource picture file. writable
price float Resource pricing. writable
payable boolean Sets if the client can pay with paypal. writable
workingHours list Working hours of the company's resource. writable
externalId string Unique resource identifier from another (external) system.

Delete

Deletes an entry on the company's resource list.

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

Request

HTTP Request

DELETE https://api.agendize.com/api/2.10/scheduling/companies/{companyId}/resources/{resourceId}

Parameters

Parameter name Value Description
Path parameters
companyId string Company identifier.
resourceId string Resource identifier or external id of resource.

Request body

Do not supply a request body with this method.

Response

If successful, this method returns an empty response body.


Get

Returns an entry of the company's resource list.

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

Request

HTTP Request

GET https://api.agendize.com/api/21/scheduling/companies/{companyId}/resources/{resourceId}

Parameters

Parameter name Value Description
Path parameters
companyId string Company identifier.
resourceId string Resource identifier or external id of resource.
Optional query parameters
fields string Specify the fields returned. Comma seperated field names (ex: "id,name").

Request body

Do not supply a request body with this method.

Response

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


List

Returns entries on the company's resource list.

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

Request

HTTP Request

GET https://api.agendize.com/api/2.1/scheduling/companies/{companyId}/resources

Parameters

Parameter name Value Description
Path parameters
companyId string Company identifier.
Optional query parameters
showDeleted boolean Whether to include deleted company list entries in the result. Optional. The default is false.
syncToken string Token obtained from the nextSyncToken field returned on the last page of results from the previous list request.
fields string Specify the fields returned. Comma seperated field names (ex: "id,name").

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

Insert

Adds an entry to the company's resource list.

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

Request

HTTP Request

POST https://api.agendize.com/api/2.1/scheduling/companies/{companyId}/resources

Parameters

Parameter name Value Description
Path parameters
companyId string Company identifier.

Request body

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

Parameter name Value Description
Required Properties
name string Name of the resource.
Optional Properties
duration integer Resource duration, in minutes. The default value is 0 minute.
count integer Resource quantity available. The default value is 1.
color string Resource color, for dashboard displaying. Format: xxxxxx. The default value is EFEFEF.
description string Description of the resource.
picture object Resource picture url and mime type.
picture.url string Url of the resource picture.
picture.mimeType string Mime type of the resource picture file.
price float Resource pricing. The default value is 0.
payable boolean Sets if the client can pay with paypal. The default value is false.
workingHours list Working hours of the company's resource. The default values are the company's working hours.

Response

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


Update

Updates an entry on the company's resource list.

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

Request

HTTP Request

PUT https://api.agendize.com/api/2.1/scheduling/companies/{companyId}/resources/{resourceId}

Parameters

Parameter name Value Description
Path parameters
companyId string Company identifier.
resourceId string Resource identifier or external id of resource.

Request body

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

Parameter name Value Description
Optional Properties
name string Name of the resource.

Response

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


Watch

Watch for changes to Resource resources.

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

The watch send an Resource resource in the request body

Request

HTTP Request

POST https://api.agendize.com/api/2.1/scheduling/companies/{companyId}/resources/watch

Parameters

Parameter name Value Description
Path parameters
companyId string Company identifier.

Request body

{ "address": {string}, "basicAuth": { "username": {string}, "password": {string} }, "httpRequestHeader": { (name): {string} } }
Required Properties
address string The address where notifications are delivered for this watch.
Optional Properties
basicAuth string Credentials parameters for HTTP Basic authentication on the destination watch address. Only if you use this authentication method.
basicAuth.username string Username.
basicAuth.password string Password.
httpRequestHeader string Custom header parameters to send with the http request on the destination watch address.
httpRequestHeader.name string header parameter name.

Response

If successful, this method returns an of Watch resource in the response body.

Watch event supported

  • Resource added in dashboard.
  • Resource modified in dashboard.
  • Resource delete in dashboard. In this case, the watch request add the following header propert in http request:
    X-Agendize-objectEvent: deleted