POST | /api/scheduling/check-resource/availability |
---|
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
ResourceIds | body | List<string> | No | The ID of the resource you want to check |
StartTime | body | string | No | Start of the date range |
EndTime | body | string | No | End of the date range |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
CustomerName | form | string | Yes | The HostedSuite Customer Name |
UserName | form | string | Yes | The HostedSuite User Name. Data visibility and security is based on this user's permissions. |
Password | form | string | Yes | The HostedSuite User's Password |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Availability | form | List<ResourceAvailability> | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
ResourceId | form | string | No | |
IsAvailable | form | bool | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Availability | form | List<ResourceAvailability> | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /api/scheduling/check-resource/availability HTTP/1.1
Host: cpo.hostedsuite.com
Accept: text/csv
Content-Type: text/csv
Content-Length: length
{"ResourceIds":["String"],"StartTime":"String","EndTime":"String","CustomerName":"String","UserName":"String","Password":"String"}
HTTP/1.1 200 OK Content-Type: text/csv Content-Length: length {"Availability":[{"ResourceId":"String","IsAvailable":false}]}