These are the endpoints that are available under the /resource path, which lists all the different resources you have added to the services or locations on your business account.
Endpoint | Description |
|---|---|
GET /resource | Returns all resource objects on an account in array format. |
GET /resource/{resourceId} | Returns a JSON object for specified resource. |
| GET /resource/{resourceId}/isBusy/{apptDate YYYY-MM-DD}/{Appt startTim HHMM}/{Appt endTime HHMM} | Returns as true or false depending on whether the resource is or isn’t busy during the date and time passed in the call. |
| POST /resource | Creates a new resource object on an account. Request body/payload: Must pass a resource object in the request body/payload. For these calls, you need to pass a resource object with all required fields and any fields you want to set filled in the body of the payload. We have an example of a resource object in the responses section below and have indicated the required fields in the object values table at the bottom of this page. |
| PUT /resource | Updates specified resource object. Request body/payload: Must pass a resource object with desired changes made in the request body/payload. For these calls, you need to pass a resource object with all required fields and any fields you want to update filled in the body of the payload. We have an example of a resource object in the responses section below and have indicated the required fields in the object values table at the bottom of this page. |
| DELETE /resource/{resourceId} | Removes a resource object from view by setting its active property to false. |
There are no parameters included with resource calls.
The objects below represent the minimum viable objects to pass that are needed to create or update a resource object. Check whether or not a property can be written to by looking at the Object Values table below to see if the property is writable.
| Code Block | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
{ "locationId": 282639, "name": "Furminator", "reasonIdList": [255109, 159330] } |
| Code Block | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
{
“active”"active": true,
“businessId”"businessId": 43111,
“createdDate”"createdDate": 15317751076391531934814568,
“createdUser”"createdUser": "JoeSchmo",
"locationId": 8118187877,
“locationName”"locationName": "BeachOffice Office1",
"modifiedDate": 15317751076391531934814568,
"modifiedUser": "JoeSchmo",
"name": "Surfboard ABall",
"reasonIdList": [159578240094, 436103],
"reasonIdListText": "159564159578,159330,158196",
"reasons": ["BbPooch primping"],
"resourceId": 29192985
}] |
| Code Block | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
[{
“active”: true,
“businessId”: 43111,
“createdDate”: 15288202156701531775107639,
“createdUser”: "JoeSchmo",
"locationId": 81181,
“locationName”: "Beach Office",
"modifiedDate": 15288202156701531775107639,
"modifiedUser": "JoeSchmo",
"name": "LargeSurfboard movable tableA",
"reasonIdList": [158196159578],
"reasonIdListText": "158196159564",
"reasons": ["HipHopBb"],
"resourceId": 25892919
}] |
| Code Block | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
[{ “active”: true, “businessId”: 43111, “createdDate”: 1528820215670, “createdUser”: "JoeSchmo", "locationId": 81181, “locationName”: "Beach Office", "modifiedDate": 1528820215670, "modifiedUser": "JoeSchmo", "name": "StrobeLarge movable Lighttable", "reasonIdList": [158196], "reasonIdListText": "158196", "reasons": ["HipHop"], "resourceId": 36122589 }] |
| Code Block | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
{
“active”: true,
“businessId”: 43111,
“createdDate”: 15317751076391528820215670,
“createdUser”: "JoeSchmo",
"locationId": 81181,
“locationName”: "Beach Office",
"modifiedDate": 15317751076391528820215670,
"modifiedUser": "JoeSchmo",
"name": "SurfboardStrobe ALight",
"reasonIdList": [159578158196],
"reasonIdListText": "159578158196",
"reasons": ["BbHipHop"],
"resourceId": 29193612
} |
| Code Block | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
{
"locationId": 282639,
"name": "Furminator",
"reasonIdList": [255109, 159330]
} | ||||||||
| Code Block | ||||||||
| ||||||||
{
"active"“active”: true,
"businessId"“businessId”: 43111,
"createdDate"“createdDate”: 15319348145681531775107639,
"createdUser"“createdUser”: "JoeSchmo",
"locationId": 8787781181,
"locationName"“locationName”: "Beach Office 1",
"modifiedDate": 15319348145681531775107639,
"modifiedUser": "JoeSchmo",
"name": "BallSurfboard A",
"reasonIdList": [240094, 436103159578],
"reasonIdListText": "159578,159330,158196",
"reasons": ["Pooch primpingBb"],
"resourceId": 29852919
} |
| Property name | Type | Required | Writable | Description |
|---|---|---|---|---|
| active | boolean | Yes | Indicates whether or not specified resource should return on GET calls. | |
| businessId | integer | Yes | Provides unique numeric ID of the business to which the specified resource belongs. | |
| createdDate | integer | Displays as the date the specified resource was created in milliseconds elapsed since January 1, 1970 00:00:00 UTC form. | ||
| createdUser | string | Displays the username of user who created the specified resource. | ||
| locationId | integer | Yes | Provides unique numeric ID of location of the specified resource. | |
| locationName | string | Yes | Yes | Provides the public name of location of the specified resource. |
modifiedDate | integer | Displays as date the specified resource was last modified in milliseconds elapsed since January 1, 1970 00:00:00 UTC form. | ||
| modifiedUser | string | Displays the username of user who last modified the specified resource. | ||
| name | string | Yes | Displays as name given to the specified resource on your account. | |
| reasonIdList | array | Yes | Displays as list of IDs of services that use the specified resource. | |
| reasonIdListText | string | Yes | Displays the list of IDs of services that use the specified resource in text format. | |
| reasons | array | Yes | Displays as list of service names that use the specified resource in array format. | |
| resourceId | integer | Yes, on PUT calls | Provides unique numerical ID of the specified resource. |