| Parameter name | Value | Description | Notes |
|---|---|---|---|
id |
string |
Identifier of the resource. | |
name |
string |
Name of the resource. | writable |
duration |
integer |
Resource duration, in minutes. | writable |
count |
integer |
Resource quantity available. | writable |
color |
string |
Resource color, for dashboard displaying. Hexadecimal web color. Default Color: #EFEFEF. | writable |
description |
string |
Description of the resource. | writable |
picture |
object |
Resource picture url and mime type. | writable |
picture.url |
string |
Url of the resource picture. | |
picture.mimeType |
string |
Mime type of the resource picture file. | writable |
price |
float |
Resource pricing. | writable |
payable |
boolean |
Sets if the client can pay with paypal. | writable |
workingHours |
list |
Working hours of the company's resource. | writable |
externalId |
string |
Unique resource identifier from another (external) system. |
Deletes an entry on the company's resource list.
Authentication is required to execute this request. Please refer to Authentication for more.
{companyId}/resources/{resourceId}| Parameter name | Value | Description |
|---|---|---|
| Path parameters | ||
companyId |
string |
Company identifier. |
resourceId |
string |
Resource identifier or external id of resource. |
Do not supply a request body with this method.
If successful, this method returns an empty response body.
Returns an entry of the company's resource list.
Authentication is required to execute this request. Please refer to Authentication for more.
{companyId}/resources/{resourceId}| Parameter name | Value | Description |
|---|---|---|
| Path parameters | ||
companyId |
string |
Company identifier. |
resourceId |
string |
Resource identifier or external id of resource. |
| Optional query parameters | ||
fields |
string |
Specify the fields returned. Comma separated field names (ex: "id,name"). |
Do not supply a request body with this method.
If successful, this method returns a Resource resource in the response body.
Returns entries on the company's resource list.
Authentication is required to execute this request. Please refer to Authentication for more.
{companyId}/resources| Parameter name | Value | Description |
|---|---|---|
| Path parameters | ||
companyId |
string |
Company identifier. |
| Optional query parameters | ||
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,name"). |
Do not supply a request body with this method.
If successful, this method returns a response body with the following structure:
Adds an entry to the company's resource list.
Authentication is required to execute this request. Please refer to Authentication for more.
| Parameter name | Value | Description |
|---|---|---|
| Path parameters | ||
companyId |
string |
Company identifier. |
In the request body, supply a Resource resource with the following properties:
| Parameter name | Value | Description |
|---|---|---|
| Required Properties | ||
name |
string |
Name of the resource. |
| Optional Properties | ||
duration |
integer |
Resource duration, in minutes. The default value is 0 minute. |
count |
integer |
Resource quantity available. The default value is 1. |
color |
string |
Resource color, for dashboard displaying. Format: xxxxxx. The default value is EFEFEF. |
description |
string |
Description of the resource. |
picture |
object |
Resource picture url and mime type. |
picture.url |
string |
Url of the resource picture. |
picture.mimeType |
string |
Mime type of the resource picture file. |
price |
float |
Resource pricing. The default value is 0. |
payable |
boolean |
Sets if the client can pay with paypal. The default value is false. |
workingHours |
list |
Working hours of the company's resource. The default values are the company's working hours. |
If successful, this method returns a Resource resource in the response body.
Updates an entry on the company's resource list.
Authentication is required to execute this request. Please refer to Authentication for more.
{companyId}/resources/{resourceId}| Parameter name | Value | Description |
|---|---|---|
| Path parameters | ||
companyId |
string |
Company identifier. |
resourceId |
string |
Resource identifier or external id of resource. |
In the request body, supply a Resource resource with the following properties:
| Parameter name | Value | Description |
|---|---|---|
| Optional Properties | ||
name |
string |
Name of the resource. |
If successful, this method returns a Resource resource in the response body.