Home > Agendize Scheduling

Staff Groups


Resource representation

{ "id": {string}, "name": {string}, "color": {string}, "workingHours": [ { "day": "monday", "hours": [ { "start": "09:00", "end": "18:00" } ] } ], "members": [ { "id": {string}, "firstName": {string}, "lastName": {string}, "selfLink": {string} } ] }
Parameter name Value Description
id string Identifier of the company's staff member.
name string Name of the group.
color string Group color, for dashboard displaying. Hexadecimal web color. Default Color: #EFEFEF.
workingHours list Working hours of the group.
members list Staff list of the group.
members[].firstName string First name of the staff member
members[].lastName string Last name of the staff member
members[].id string Identifier of the staff member
members[].selfLink string API link of the staff member

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/scheduling/companies/{companyId}/staffGroups/{groupId}

Parameters

Parameter name Value Description
Path parameters
companyId string Company identifier.
groupId string Group 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/scheduling/companies/{companyId}/staffGroups/{groupId}

Parameters

Parameter name Value Description
Path parameters
companyId string Company identifier.
groupId string Group identifier.

Request body

Do not supply a request body with this method.

Response

If successful, this method returns a Group 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://az2.agendize.com/api/2.0/scheduling/companies/{companyId}/staffGroups

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: [Group 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/scheduling/companies/{companyId}/staffGroups

Parameters

Parameter name Value Description
Path parameters
companyId string Company identifier.

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.
email string Email address of the company's staff member.
phone string Phone number of the company's staff member.
mobilePhone string Mobile phone number of the company's staff member.
color string Staff member color, for dashboard displaying. Format: xxxxxx. The default value is EFEFEF.
description string Description of the company's staff member.
picture object Staff picture url and mime type.
picture.url string Url of the staff picture.
picture.mimeType string Mime type of the staff picture file.
workingHours list Working hours of the company's staff member. The default values are company's working hours.
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

Response

If successful, this method returns a Group 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/scheduling/companies/{companyId}/staffGroups/{groupId}

Parameters

Parameter name Value Description
Path parameters
companyId string Company identifier.
groupId string Group identifier.

Request body

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

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

Response

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