Agendize Developers API

Home > Agendize Scheduling

Resource Groups

Resource representation

{ "id": {string}, "name": {string}, "description": {string}, "members": [ { "id": {string}, "name": {string}, "selfLink": {string} } ] }
Parameter name Value Description
id string Identifier of the group.
name string Name of the group. Max length 127.
members list Resource list of the group.
members[].name string Name of the resource member
members[].id string Identifier of the resource member. Max length 16.
members[].selfLink string API link of the resource member

Delete

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}/resourceGroups/{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 https://api.agendize.com/api/2.1/scheduling/companies/{companyId}/resourceGroups/{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 resource 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}/resourceGroups

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

Parameters

Parameter name Value Description
Path parameters
companyId string Company identifier.

Request body

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

Parameter name Value Description
Required Properties
name string Name of the group.
Optional Properties
color string Group color, for dashboard displaying. Hexadecimal web color. Default Color: #EFEFEF.
description string Description of the group.
members list Resource list of the group.
members[].id string Identifier of the resource member

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 https://api.agendize.com/api/2.1/scheduling/companies/{companyId}/resourceGroups/{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.
color string Group color, for dashboard displaying. Hexadecimal web color. Default Color: #EFEFEF.
description string Description of the group.
members list Resource list of the group.
members[].id string Identifier of the resource member

Response

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

Agendize | Support | Status

Last update: Mar 18, 2024 - Copyright © 2024 Agendize. All rights reserved.