Agendize Developers API

Home > Agendize Scheduling

Service Resources

Service resources

{ "id": {string}, "name": {string}, "description": {string}, "color": {string}, "quantity": {integer},
"ownersRequirement": {boolean}, "owners": [ { "ownerType": {string}, "ownerData": {string} } ],
"i18n": { "en": { "name": {string}, "description": {string} }, "fr": { "name": {string}, "description": {string} }, "es": { "name": {string}, "description": {string} }, "pt: { "name": {string}, "description": {string} }, "de": { "name": {string}, "description": {string} }, "nl": { "name": {string}, "description": {string} }, "it": { "name": {string}, "description": {string} } }, "availability": {boolean}, "workingHours": [ { "day": "sunday", "hours": [ { "start": {string}, "end": {string} } ] }, { "day": "monday", "hours": [ { "start": {string}, "end": {string} } ] }, { "day": "tuesday", "hours": [ { "start": {string}, "end": {string} } ] }, { "day": "wednesday", "hours": [ { "start": {string}, "end": {string} } ] }, { "day": "thursday", "hours": [ { "start": {string}, "end": {string} } ] }, { "day": "friday", "hours": [ { "start": {string}, "end": {string} } ] }, { "day": "saturday", "hours": [ { "start": {string}, "end": {string} } ] } ], "services": [ { "id" : {string}
, "bookingMode" : {string}
} ], "customWorkingHours": [ { "name":(string}, "startPeriod": { "dateTime": {string}, "timeZone": {string} }, "endPeriod": { "dateTime": {string}, "timeZone": {string} }, "sunday": [ { "service": { "name": {string}, "id": {string} }, "start": {string}, "end": {string} } ], "monday": [ { "service": { "name": {string}, "id": {string} }, "start": {string}, "end": {string} } ], "tuesday": [ { "service": { "name": {string}, "id": {string} }, "start": {string}, "end": {string} } ], "wednesday": [ { "service": { "name": {string}, "id": {string} }, "start": {string}, "end": {string} } ], "thursday": [ { "service": { "name": {string}, "id": {string} }, "start": {string}, "end": {string} } ], "friday": [ { "service": { "name": {string}, "id": {string} }, "start": {string}, "end": {string} } ], "saturday": [ { "service": { "name": {string}, "id": {s: {string} }, "start": {string}, "end": {string} } ] } ] }
Parameter name Value Description
id string Identifier of the resource of service.
name string Name of the resource of service. Max length 255.
color string Resource of service color, for dashboard displaying. Hexadecimal web color. Default Color: #EFEFEF.
quantity integer Number of resource of service available. Max length 11.
availability boolean Set to True if this resource of service has specific availability
workingHours list Working hours of the resource of service.
workingHours[].sunday list List of working hours for sunday. Only if hours are defined for the day. writable
workingHours[].sunday[].start string Start hour. Format: HH:mm. writable
workingHours[].sunday[].end string End hour. Format: HH:mm. writable
workingHours[].monday list List of working hours for monday. Only if hours are defined for the day. writable
workingHours[].monday[].start string Start hour. Format: HH:mm. writable
workingHours[].monday[].end string End hour. Format: HH:mm. writable
workingHours[].tuesday list List of working hours for tuesday. Only if hours are defined for the day. writable
workingHours[].tuesday[].start string Start hour. Format: HH:mm. writable
workingHours[].tuesday[].end string End hour. Format: HH:mm. writable
workingHours[].wednesday list List of working hours for wednesday. Only if hours are defined for the day. writable
workingHours[].wednesday[].start string Start hour. Format: HH:mm. writable
workingHours[].wednesday[].end string End hour. Format: HH:mm. writable
workingHours[].thursday list List of working hours for thursday. Only if hours are defined for the day. writable
workingHours[].thursday[].start string Start hour. Format: HH:mm. writable
workingHours[].thursday[].end string End hour. Format: HH:mm. writable
workingHours[].friday list List of working hours for friday. Only if hours are defined for the day. writable
workingHours[].friday[].start string Start hour. Format: HH:mm. writable
workingHours[].friday[].end string End hour. Format: HH:mm. writable
workingHours[].saturday list List of working hours for saturday. Only if hours are defined for the day. writable
workingHours[].saturday[].start string Start hour. Format: HH:mm. writable
workingHours[].saturday[].end string End hour. Format: HH:mm. writable
i18n object Service resource translation. writable
services list List of all services link to this resource of service
services[].id string Identifier of the service. Max length 16.
customWorkingHours list Custom Working hours (per period) of the company's resource.
customWorkingHours[].startPeriod object Start date of the custom period. writable
customWorkingHours[].name object Name of the custom period. writable
customWorkingHours[].startPeriod.dateTime string The time, as a combined date-time value (formatted according to RFC 3339, without time zone information). writable
customWorkingHours[].startPeriod.timeZone string The time zone. Possible values can be found here. The default value is the time zone of the company. read-only
customWorkingHours[].endPeriod object Start date of the custom period. writable
customWorkingHours[].endPeriod.dateTime string The time, as a combined date-time value (formatted according to RFC 3339, without time zone information). writable
customWorkingHours[].endPeriod.timeZone string The time zone. Possible values can be found here. The default value is the time zone of the company. read-only
customWorkingHours[].sunday list List of custom working hours for sunday. Only if hours are defined for the day. writable
customWorkingHours[].sunday[].start string Start hour. Format: HH:mm. writable
customWorkingHours[].sunday[].end string End hour. Format: HH:mm. writable
customWorkingHours[].sunday[].service object Service concerned by the working hour. Only if a service is defined for the working hour writable
customWorkingHours[].sunday[].service.id object Id of service. writable
customWorkingHours[].sunday[].service.name object Name of service.
customWorkingHours[].monday list List of custom working hours for monday. Only if hours are defined for the day. writable
customWorkingHours[].monday[].start string Start hour. Format: HH:mm. writable
customWorkingHours[].monday[].end string End hour. Format: HH:mm. writable
customWorkingHours[].monday[].service object Service concerned by the working hour. Only if a service is defined for the working hour writable
customWorkingHours[].monday[].service.id object Id of service. writable
customWorkingHours[].monday[].service.name object Name of service.
customWorkingHours[].tuesday list List of custom working hours for tuesday. Only if hours are defined for the day. writable
customWorkingHours[].tuesday[].start string Start hour. Format: HH:mm. writable
customWorkingHours[].tuesday[].end string End hour. Format: HH:mm. writable
customWorkingHours[].tuesday[].service object Service concerned by the working hour. Only if a service is defined for the working hour writable
customWorkingHours[].tuesday[].service.id object Id of service. writable
customWorkingHours[].tuesday[].service.name object Name of service.
customWorkingHours[].wednesday list List of custom working hours for wednesday. Only if hours are defined for the day. writable
customWorkingHours[].wednesday[].start string Start hour. Format: HH:mm. writable
customWorkingHours[].wednesday[].end string End hour. Format: HH:mm. writable
customWorkingHours[].wednesday[].service object Service concerned by the working hour. Only if a service is defined for the working hour writable
customWorkingHours[].wednesday[].service.id object Id of service. writable
customWorkingHours[].wednesday[].service.name object Name of service.
customWorkingHours[].thursday list List of custom working hours for thursday. Only if hours are defined for the day. writable
customWorkingHours[].thursday[].start string Start hour. Format: HH:mm. writable
customWorkingHours[].thursday[].end string End hour. Format: HH:mm. writable
customWorkingHours[].thursday[].service object Service concerned by the working hour. Only if a service is defined for the working hour writable
customWorkingHours[].thursday[].service.id object Id of service. writable
customWorkingHours[].thursday[].service.name object Name of service.
customWorkingHours[].friday list List of custom working hours for friday. Only if hours are defined for the day. writable
customWorkingHours[].friday[].start string Start hour. Format: HH:mm. writable
customWorkingHours[].friday[].end string End hour. Format: HH:mm. writable
customWorkingHours[].friday[].service object Service concerned by the working hour. Only if a service is defined for the working hour writable
customWorkingHours[].friday[].service.id object Id of service. writable
customWorkingHours[].friday[].service.name object Name of service.
customWorkingHours[].saturday list List of custom working hours for saturday. Only if hours are defined for the day. writable
customWorkingHours[].saturday[].start string Start hour. Format: HH:mm. writable
customWorkingHours[].saturday[].end string End hour. Format: HH:mm. writable
customWorkingHours[].saturday[].service object Service concerned by the working hour. Only if a service is defined for the working hour writable
customWorkingHours[].saturday[].service.id object Id of service. writable
customWorkingHours[].saturday[].service.name object Name of 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 https://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 https://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 https://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:

{ items: [Resource of service 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.1/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.
workingHours[].sunday list List of working hours for sunday. Only if hours are defined for the day. writable
workingHours[].sunday[].start string Start hour. Format: HH:mm. writable
workingHours[].sunday[].end string End hour. Format: HH:mm. writable
workingHours[].monday list List of working hours for monday. Only if hours are defined for the day. writable
workingHours[].monday[].start string Start hour. Format: HH:mm. writable
workingHours[].monday[].end string End hour. Format: HH:mm. writable
workingHours[].tuesday list List of working hours for tuesday. Only if hours are defined for the day. writable
workingHours[].tuesday[].start string Start hour. Format: HH:mm. writable
workingHours[].tuesday[].end string End hour. Format: HH:mm. writable
workingHours[].wednesday list List of working hours for wednesday. Only if hours are defined for the day. writable
workingHours[].wednesday[].start string Start hour. Format: HH:mm. writable
workingHours[].wednesday[].end string End hour. Format: HH:mm. writable
workingHours[].thursday list List of working hours for thursday. Only if hours are defined for the day. writable
workingHours[].thursday[].start string Start hour. Format: HH:mm. writable
workingHours[].thursday[].end string End hour. Format: HH:mm. writable
workingHours[].friday list List of working hours for friday. Only if hours are defined for the day. writable
workingHours[].friday[].start string Start hour. Format: HH:mm. writable
workingHours[].friday[].end string End hour. Format: HH:mm. writable
workingHours[].saturday list List of working hours for saturday. Only if hours are defined for the day. writable
workingHours[].saturday[].start string Start hour. Format: HH:mm. writable
workingHours[].saturday[].end string End hour. Format: HH:mm. writable
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 https://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

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.
workingHours[].sunday list List of working hours for sunday. Only if hours are defined for the day. writable
workingHours[].sunday[].start string Start hour. Format: HH:mm. writable
workingHours[].sunday[].end string End hour. Format: HH:mm. writable
workingHours[].monday list List of working hours for monday. Only if hours are defined for the day. writable
workingHours[].monday[].start string Start hour. Format: HH:mm. writable
workingHours[].monday[].end string End hour. Format: HH:mm. writable
workingHours[].tuesday list List of working hours for tuesday. Only if hours are defined for the day. writable
workingHours[].tuesday[].start string Start hour. Format: HH:mm. writable
workingHours[].tuesday[].end string End hour. Format: HH:mm. writable
workingHours[].wednesday list List of working hours for wednesday. Only if hours are defined for the day. writable
workingHours[].wednesday[].start string Start hour. Format: HH:mm. writable
workingHours[].wednesday[].end string End hour. Format: HH:mm. writable
workingHours[].thursday list List of working hours for thursday. Only if hours are defined for the day. writable
workingHours[].thursday[].start string Start hour. Format: HH:mm. writable
workingHours[].thursday[].end string End hour. Format: HH:mm. writable
workingHours[].friday list List of working hours for friday. Only if hours are defined for the day. writable
workingHours[].friday[].start string Start hour. Format: HH:mm. writable
workingHours[].friday[].end string End hour. Format: HH:mm. writable
workingHours[].saturday list List of working hours for saturday. Only if hours are defined for the day. writable
workingHours[].saturday[].start string Start hour. Format: HH:mm. writable
workingHours[].saturday[].end string End hour. Format: HH:mm. writable
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.

Agendize | Support | Status

Last update: Oct 15, 2024 - Copyright © 2024 Agendize. All rights reserved.