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 .xml suffix or ?format=xml

HTTP + XML

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: application/xml
Content-Type: application/xml
Content-Length: length

<CheckResourceAvailabilityRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Evo.HostedSuite.Core.ServiceModel">
  <CustomerName>String</CustomerName>
  <Password>String</Password>
  <UserName>String</UserName>
  <EndTime>String</EndTime>
  <ResourceIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </ResourceIds>
  <StartTime>String</StartTime>
</CheckResourceAvailabilityRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<CheckResourceAvailabilityResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Evo.HostedSuite.Core.ServiceModel">
  <Availability>
    <ResourceAvailability>
      <IsAvailable>false</IsAvailable>
      <ResourceId>String</ResourceId>
    </ResourceAvailability>
  </Availability>
</CheckResourceAvailabilityResponse>