HostedSuite

<back to all web services

CheckResourceAvailabilityRequest

The following routes are available for this service:
POST/api/scheduling/check-resource/availability
CheckResourceAvailabilityRequest Parameters:
NameParameterData TypeRequiredDescription
ResourceIdsbodyList<string>NoThe ID of the resource you want to check
StartTimebodystringNoStart of the date range
EndTimebodystringNoEnd of the date range
RequestBase<TResponse> Parameters:
NameParameterData TypeRequiredDescription
CustomerNameformstringYesThe HostedSuite Customer Name
UserNameformstringYesThe HostedSuite User Name. Data visibility and security is based on this user's permissions.
PasswordformstringYesThe HostedSuite User's Password
CheckResourceAvailabilityResponse Parameters:
NameParameterData TypeRequiredDescription
AvailabilityformList<ResourceAvailability>No
ResourceAvailability Parameters:
NameParameterData TypeRequiredDescription
ResourceIdformstringNo
IsAvailableformboolNo
CheckResourceAvailabilityResponse Parameters:
NameParameterData TypeRequiredDescription
AvailabilityformList<ResourceAvailability>No

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + 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: evo.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}]}