Create Calendar Resource

POST 
/calendars/resources/:resourceType

deprecated

This endpoint has been deprecated and may be replaced or removed in future versions of the API.

Create calendar resource by resource type (Services V1)

Request

Version stringrequired

API Version

Available optionsv3

resourceType stringrequired

Calendar Resource Type

Available optionsequipmentsrooms

application/json

application/json

Body

Bodyrequired

locationIdstringrequired

Location ID

namestringrequired

Name of the calendar resource

descriptionstringrequired

Description of the calendar resource

quantitynumberrequired

Quantity of the equipment.

outOfServicenumberrequired

Quantity of the out of service equipment.

capacitynumberrequired

Capacity of the room.

calendarIdsstring[]required

Service calendar IDs to be mapped with the resource.

One equipment can only be mapped with one service calendar.

One room can be mapped with multiple service calendars.

Possible values: <= 100

Example (auto)

{
  "locationId": "ocQHyuzHvysMo5N5VsXc",
  "name": "Projector",
  "description": "Main conference room projector",
  "quantity": 5,
  "outOfService": 1,
  "capacity": 20,
  "calendarIds": [
    "Jsj0xnlDDjw0SuvX1J13"
  ]
}

application/json

Calendar resource created

application/json

Schema

Schema

locationIdstringrequired

Location ID of the resource

namestringrequired

Name of the resource

resourceTypestringrequired
Type of the calendar resource
Available optionsequipmentsrooms
isActivebooleanrequired

Whether the resource is active

descriptionstring

Description of the resource

quantitynumber

Quantity of the resource

outOfServicenumber

Indicates if the resource is out of service

capacitynumber

Capacity of the resource

calendarIdsstring[]required

Calendar IDs

Example (auto)

{
  "locationId": "ocQHyuzHvysMo5N5VsXc",
  "name": "yoga room",
  "resourceType": "rooms",
  "isActive": true,
  "description": "Spacious yoga studio",
  "quantity": 3,
  "outOfService": 0,
  "capacity": 85,
  "calendarIds": [
    "Jsj0xnlDDjw0SuvX1J13",
    "oCM5feFC86FAAbcO7lJK"
  ]
}