Home > Agendize Scheduling

Service Resources


Service resources

{ "id": {string}, "name": {string}, "description": {string}, "color": {string}, "quantity": {integer},
"ownersRequirement": {boolean}, "owners": [ { "ownerType": {string}, "ownerData": {string} } ],
"availability": {boolean}, "workingHours": [ { "day": {string}, "hours": [ { "start": {string}, "end": {string} } ] } ], "services": [ { "id" : {string}
, "bookingMode" : {string}
} ] }
Parameter name Value Description
id string Identifier of the resource of service.
name string Name of the resource of service.
color string Resource of service color, for dashboard displaying. Hexadecimal web color. Default Color: #EFEFEF.
quantity integer Number of resource of service available.
availability boolean Set to True if this resource of service has specific availability
workingHours list Working hours of the resource of service.
services list List of all services link to this resource of service
services[].id string Identifier of the service.

Delete

Deletes an entry on the company's service list.

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

Request

HTTP Request

DELETE http://api.agendize.com/api/2.1/scheduling/companies/{companyId}/service-resources/{serviceResourceId}

Parameters

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

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://api.agendize.com/api/2.1/scheduling/companies/{companyId}/service-resources/{serviceResourceId}

Parameters

Parameter name Value Description
Path parameters
companyId string Company identifier.
serviceResourceId string Resource of service identifier.

Request body

Do not supply a request body with this method.

Response

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


List

Returns entries on the company's staff group list.

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

Request

HTTP Request

GET http://api.agendize.com/api/2.1/scheduling/companies/{companyId}/service-resources

Parameters

Parameter name Value Description
Path parameters
companyId string Company 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:


Insert

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

Request

HTTP Request

POST http://api.agendize.com/api/2.0/scheduling/companies/{companyId}/service-resources

Parameters

Parameter name Value Description
Path parameters
companyId string Company identifier.

Request body

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

Parameter name Value Description
Required Properties
name string Name of the resource of service.
Optional Properties
color string Resource of service color, for dashboard displaying. Hexadecimal web color. Default Color: #EFEFEF.
quantity integer Number of resource of service available.
availability boolean Set to True if this resource of service has specific availability
workingHours list Working hours of the resource of service.
services list List of all services link to this resource of service
services[].id string Identifier of the service.

Response

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


Update

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

Request

HTTP Request

PUT http://api.agendize.com/api/2.0/scheduling/companies/{companyId}/service-resources/{serviceResourceId}

Parameters

Parameter name Value Description
Path parameters
companyId string Company identifier.
serviceResourceId string Resource of service identifier.

Request body

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

Parameter name Value Description
Optional Properties
name string Name of the resource of service.
color string Resource of service color, for dashboard displaying. Hexadecimal web color. Default Color: #EFEFEF.
quantity integer Number of resource of service available.
availability boolean Set to True if this resource of service has specific availability
workingHours list Working hours of the resource of service.
services list List of all services link to this resource of service
services[].id string Identifier of the service.

Response

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