Resource
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.
Property name | Type | Required | Writable | Description |
---|---|---|---|---|
active | boolean | Yes | Indicates whether or not specified resource should return on GET calls. | |
bundleResourceIdList | array | Displays as list of IDs of resources that are bundled with the specified resource. | ||
bundleResourceSet | array | Displays as an array of resource objects for resources in bundle. | ||
bundledResources | string | Displays as a string of the names of the resources in bundle. | ||
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. | |
professionalIdList | array | Displays as list of IDs of staff that are connected to the specified resource. | ||
professionalIdListText | string | Displays the list of IDs of staff that are connected to the specified resource in text format. | ||
reasonIdList | array | Yes | Displays as list of IDs of services that are connected to the specified resource. | |
reasonIdListText | string | Yes | Displays the list of IDs of services that are connected to the specified resource in text format. | |
reasonSet | array | Displays as an array of reasons that the specified resource is connected to. | ||
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. |