HostedSuite

<back to all web services

ListReservationsRequest

Retrieve a list of reservations for the specified date range

The following routes are available for this service:
POST/api/scheduling/reservations
ListReservationsRequest Parameters:
NameParameterData TypeRequiredDescription
MeetingRoomIdsbodyList<string>NoSpecific meeting rooms. Leave blank for all
CenterIdbodystringNoSpecify a center. Leave blank for all
ClientIdbodystringNoSpecify a client ID. Leave blank for all
StartTimebodystringNoStart of date range
EndTimebodystringNoEnd of date range
StatusbodyReservationStatuses?NoFilter by reservation status or null to not filter
PaymentStatusbodyPaymentStatus?NoFilter by reservation payment status or null to not filter
LastModifiedAfterbodystringNoFilter by only reservations that were modified after the specified date
LastModifiedBeforebodystringNoFilter by only reservations that were modified before the specified date
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
ReservationStatuses Enum:
Scheduled
Cancelled
PendingApproval
Denied
PaymentStatus Enum:
None
NotPaid
PartiallyPaid
Overdue
Paid
Included
Cancelled
NoCharge
Confirmed
BillOther
Other

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/reservations HTTP/1.1 
Host: cpo.hostedsuite.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<ListReservationsRequest 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>
  <CenterId>String</CenterId>
  <ClientId>String</ClientId>
  <EndTime>String</EndTime>
  <LastModifiedAfter>String</LastModifiedAfter>
  <LastModifiedBefore>String</LastModifiedBefore>
  <MeetingRoomIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </MeetingRoomIds>
  <PaymentStatus>None</PaymentStatus>
  <StartTime>String</StartTime>
  <Status>Scheduled</Status>
</ListReservationsRequest>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ArrayOfReservationInfo xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Evo.HostedSuite.Core.ServiceModel">
  <ReservationInfo>
    <Attendees>
      <AttendeeInfo>
        <EmailAddress>String</EmailAddress>
        <Name>String</Name>
      </AttendeeInfo>
    </Attendees>
    <CenterAddress>String</CenterAddress>
    <CenterId>String</CenterId>
    <CenterName>String</CenterName>
    <ClientId>String</ClientId>
    <ClientName>String</ClientName>
    <CustomFields>
      <CustomFieldInfo>
        <Name>String</Name>
        <Value>String</Value>
      </CustomFieldInfo>
    </CustomFields>
    <DateLastModified>String</DateLastModified>
    <EndTime>String</EndTime>
    <EntityStatus>String</EntityStatus>
    <Id>String</Id>
    <IsRecurring>false</IsRecurring>
    <LastModifiedBy>String</LastModifiedBy>
    <MeetingRoomId>String</MeetingRoomId>
    <MeetingRoomName>String</MeetingRoomName>
    <Notes>String</Notes>
    <NumAttendees>0</NumAttendees>
    <Organizer>
      <EmailAddress>String</EmailAddress>
      <Name>String</Name>
    </Organizer>
    <OriginalDate>String</OriginalDate>
    <PaymentStatus>String</PaymentStatus>
    <StartTime>String</StartTime>
    <Status>String</Status>
    <Subject>String</Subject>
  </ReservationInfo>
</ArrayOfReservationInfo>