Agendize Developers API

Home > Agendize Scheduling

Staff

Resource representation

{ "id": {string}, "firstName": {string}, "lastName": {string}, "gender": {string}, "title": {string}, "email": {string}, "phone": {string}, "otherPhone": {string}, "color": {string}, "description": {string}, "picture": { "url": {string}, "mimeType": {string} } "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}, "name": {string}, "price": {string}, "externalId": {string} } ], "vacations": [ { "startDate": {string}, "endDate": {string} } ], "availableForWidget": {boolean}, "role": {string}, "updated": { "dateTime": {datetime}, "timeZone": {string} }, "externalId": {string}, "additionalFields" : [ { "id": {string}, "type": {string}, "name": {string}, "values": [ { "id": {string}, "value": {string}, "otherValue": {string} }, { "id": {string}, "name": {string}, "values": [ { "id": {string}, "value": {string}, } ] } ] } ], "externalCalendars": [ { "url":{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": {string} }, "start": {string}, "end": {string} } ] } ], "connectors": [ { "name": {string) } ], "calendarLink": { "mimeType": {string}, "url": {string} }, "extendedProperties": { "private": {object}, "public": {object} }, "created": { "dateTime": {string}, "timeZone": {string} } }
Parameter name Value Description Notes
id string Identifier of the company's staff member.
firstName string First name of the company's staff member. writable. Max length 127.
lastName string Last name of the company's staff member. writable. Max length 127.
gender string Gender of the company's staff member. Values (male/female) writable
title string Title of the company's staff member. Values (mr/mrs/dr) writable
email string Email address of the company's staff member. writable. Max length 127.
phone string Mobile Phone number of the company's staff member. writable. Max length 127.
otherPhone string Other phone number of the company's staff member. writable. Max length 127.
color string Staff member color, for dashboard displaying. Hexadecimal web color. Default Color: #EFEFEF. writable
description string Description of the company's staff member. writable. Max length 65535.
picture object Staff picture url and mime type. writable
picture.url string Url of the staff picture.
picture.mimeType string Mime type of the staff picture file. writable
workingHours list Working hours of the company's staff member.
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 Service list of the company's staff member. writable
services[].id string Identifier of the service.
services[].name string Name of the service.
services[].price string Service pricing.
services[].externalId string Unique service identifier from another (external) system.
vacations list Vacation dates of the company's staff member. writable
vacations[].startDate string Start date of the vacation period, in the format "yyyy/mm/dd" writable
vacations[].endDate string End date of the vacation period, in the format "yyyy/mm/dd" writable
availableForWidget boolean Sets if the staff is available for online scheduling. Default value: true writable
role string Role of th staff rattached to his user account. Values: administrator, scheduler, reader. writable
updated object The last updated time of the company.
end.dateTime string The time, as a combined date-time value (formatted according to RFC 3339, without time zone information). writable
end.timeZone string The time zone. Possible values can be found here. The default value is the time zone of the company. writable
externalId string Unique staff identifier from another (external) system. Max length 255.
additionalFields list List of additional staff field. writable
additionalFields[].id string Identifier of the additional staff field. writable
additionalFields[].type string Type of the additional staff field (input, checkbox, radio, select , ...). writable
additionalFields[].values list List of values for the additional staff field. Required for type checkbox, radio and select. writable
additionalFields[].values[].id string Identifier of the additional staff field value or staff field category name. Required for type checkbox, radio and select.
additionalFields[].values[].value string Value of the additional staff field value. Required for type checkbox, radio and select with option 'Group by category' set to False or with option 'Custom Value' set to True. writable
additionalFields[].values[].name string Name of the staff field category name. Required for typ select with option 'Group by category' set to True.
additionalFields[].values[].otherValue string Other value of the additional staff field value. Default : "". Set when staff enter custom value on the additional field (option not available on all field type) (OPTIONAL) writable
additionalFields[].values[].values list Available only with input type 'select' and with 'Group by category' set to True. List of values of the addtional staff field. writable
additionalFields[].values[].values[].id string Available only with input type 'select' and with 'Group by category' set to True. Identifier of the additional staff field value
additionalFields[].values[].values[].value string Available only with input type 'select' and with 'Group by category' set to True. Value of the additional staff field. writable
externalCalendars list List of external ICS Calendar URL. writable
externalCalendars[].url string URL of the calendar.
calendarLink.mimeType string Mime type of the staff calendar.
calendarLink.url string Staff ICS calendar URL.
customWorkingHours list Custom Working hours (per period) of the company's staff member.
customWorkingHours[].name object Name of the custom period. writable
customWorkingHours[].startPeriod object Start date 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.
connectors list List of calendar synchronization and other connectors activated on the staff member. Values "googleCalendar", "outlookCalendar", "office365Calendar". Read only.
connectors[].name list Name of connector. Values "googleCalendar", "outlookCalendar", "office365Calendar".
calendarLink object Staff ICS calendar.
calendarLink.mimeType string Mime type of the staff calendar.
calendarLink.url string Staff ICS calendar URL.
extendedProperties object Extended Properties. You can defined your custom properties. Size limit: 22KB.
extendedProperties.private object Private properties. These properties are not retrieve in widget.
extendedProperties.public object Private properties. These properties are retrieve in widget.
created object The created date time of the staff member. read-only
created.dateTime string The time, as a combined date-time value (formatted according to RFC 3339, without time zone information).
created.timeZone string The time zone. Possible values can be found here. The default value is the time zone of the company.

Delete

Deletes an entry on the company's staff member 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}/staff/{staffId}

Parameters

Parameter name Value Description
Path parameters
companyId string Company identifier.
staffId string Staff member identifier of staff.

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 staff member 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}/staff/{staffId}

Parameters

Parameter name Value Description
Path parameters
companyId string Company identifier.
staffId string Staff member identifier or external id of staff member.
Optional query parameters
fields string Specify the fields returned. Comma separated field names (ex: "id,firstName").

Request body

Do not supply a request body with this method.

Response

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

List

Returns entries on the company's staff member 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}/staff

Parameters

Parameter name Value Description
Path parameters
companyId string Company identifier.
Optional query parameters
emailAddress datetime Gets staff members who match an email address.
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 separated field names (ex: "id,firstName").

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: [Staff Member resource] }

Insert

Adds an entry to the company's staff member 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}/staff

Parameters

Parameter name Value Description
Path parameters
companyId string Company identifier.
Optional query parameters
services string Values: "all". If services=all, all existing services are linked to th service. Only if the "services" property is not set in the JSON.

Request body

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

Parameter name Value Description
Required Properties
lastName string Last name of the company's staff member.
Optional Properties
firstName string First name of the company's staff member. Required according to the reseller configuration.
gender string Gender of the company's staff member. Values (male/female)
title string Title of the company's staff member. Values (mr/mrs/dr). Required according to the reseller configuration.
email string Email address of the company's staff member. Required according to the reseller configuration.
phone string Mobile Phone number of the company's staff member. Required according to the reseller configuration.
otherPhone string Other phone number of the company's staff member. Required according to the reseller configuration.
color string Staff member color, for dashboard displaying. Format: xxxxxx. The default value is EFEFEF.
description string Description of the company's staff member. Required according to the reseller configuration.
picture object Staff picture .
picture.data string Data URI of the staff picture (eg: image/png;base64, xxxxx). See Data URI scheme. Max size: 1MB. If the size is exceeded the picture is ignored.
workingHours list Working hours of the company's staff member. The default values are company's working hours.
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 Service list of the company's staff member. The default list is empty.
availableForWidget boolean Sets if the staff is available for online scheduling. Default value: true
additionalFields list List of additional staff field. The default list is empty.

Response

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

Update

Updates an entry on the company's staff member 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}/staff/{staffId}

Parameters

Parameter name Value Description
Path parameters
companyId string Company identifier.
staffId string Staff member identifier or external id of staff member.
Optional query parameters
services string Values: "all". If services=all, all existing services are linked to th service. Only if the "services" property is not set in the JSON.

Request body

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

Parameter name Value Description
Optional Properties
firstName string First name of the company's staff member. Required according to the reseller configuration.
lastName string Last name of the company's staff member. Required according to the reseller configuration.
gender string Gender of the company's staff member. Values (male/female)
title string Title of the company's staff member. Values (mr/mrs/dr). Required according to the reseller configuration.
email string Email address of the company's staff member. Required according to the reseller configuration.
phone string Mobile Phone number of the company's staff member. Required according to the reseller configuration.
otherPhone string Other phone number of the company's staff member. Required according to the reseller configuration.
color string Staff member color, for dashboard displaying. Format: xxxxxx. The default value is EFEFEF.
description string Description of the company's staff member. Required according to the reseller configuration.
picture object Staff member picture .
picture.data string Data URI of the staff member picture (eg: image/png;base64, xxxxx). See Data URI scheme. Max size: 1MB. If the size is exceeded the picture is ignored.
workingHours list Working hours of the company's staff member. The default values are company's working hours.
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 Service list of the company's staff member. The default list is empty.
availableForWidget boolean Sets if the staff is available for online scheduling. Default value: true
additionalFields list List of additional staff field. The default list is empty.

Response

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

Patch

Add values in arrays of properties of an entry on the company's staff member list. Only properties listed bellow are supported

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

Request

HTTP Request

PATCH https://api.agendize.com/api/2.1/scheduling/companies/{companyId}/staff/{staffId}

Parameters

Parameter name Value Description
Path parameters
companyId string Company identifier.
staffId string Staff member identifier or external id of staff member.

Request body

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

Parameter name Value Description
Optional Properties
customWorkingHours list Custom Working hours (per period) of the company's staff member.
customWorkingHours[].startPeriod object Start date 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. writable
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. writable
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.

Response

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

Watch

Watch for changes to Staff resources.

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

The watch send an Staff resource in the request body

Request

HTTP Request

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

Parameters

Parameter name Value Description
Path parameters
companyId string Company identifier.

Request body

{ "address": {string}, "name": {string}, "basicAuth": { "username": {string}, "password": {string} }, "httpRequestHeader": { {name}: {string} }, "schema": {object} "method": {string}, "status": {string}, "oauth2Auth": { "grantType": {string}, "clientId": {string}, "clientSecret": {string}, "refreshToken": {string}, "authUrl": {string}, "accessTokenUrl": {string}, "redirectUri": {string} }, "signature": { "enabled": {boolean}, "cryptoKeyIds": [ {string} ] } }
Required Properties
address string The address where notifications are delivered for this watch.
Optional Properties
name string Name of the watch.
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.
schema object Custom json schema to apply for resource properties.
method string HTTP Method to use for sending content. DELETE Method doesn't accept body content.
status string Status of the watcher. Values: "enabled", "disabled"
oauth2Auth string Credentials parameters for HTTP OAuth2 authentication on the destination watch address. Only if you use this authentication method.
oauth2Auth.grantType string OAuth2 grant type. Values: "refresh_token" (default), "client_credentials".
oauth2Auth.clientId string OAuth2 client id.
oauth2Auth.refreshToken string OAuth2 refresh token. Only for grantType "refresh_token"
oauth2Auth.authUrl string OAuth2 interactive end point to initiate the generation of the refresh token. Only for grantType "refresh_token"
oauth2Auth.accessTokenUrl string OAuth2 end point to generation an access token from the refresh token.
oauth2Auth.scope string OAuth2 api scope. Only for grantType "refresh_token"
signature object Produces a crypto signature of the watched content.
signature.enabled boolean Sets if the signature is enabled or not.
signature.cryptoKeyIds list Arrays of string of crypto keys identifier.

Response

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

Examples of schema:

With JSON, only for string value:

{ "schema": { "my_id_key": "{id}", "dataContent": { "givenName": "{firstName}" } } }

With string to support typed values:

{ "schema": "\"my_id_key\": ${$.id}, \"dataContent\": { \"fullName\": \"${$.firstName} ${$.lastName}\"}" }

Replacement string can by defined with jsonpath expressions.

Watch event supported

  • Staff member added in dashboard. In this case, the watch request add the following header property in http request:
    X-Agendize-objectEvent: created
  • Staff member modified in dashboard. In this case, the watch request add the following header property in http request:
    X-Agendize-objectEvent: updated
  • Staff member delete in dashboard. In this case, the watch request add the following header property in http request:
    X-Agendize-objectEvent: deleted

Agendize | Support | Status

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