CenResService

<back to all web services

ResSummaryRequest

The following routes are available for this service:
GET/v2/reservation/summary/{Query}
GET/v2/reservation/summary/{Query}/{CendynPropertyId}
Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports CenResSS.ServiceModel
Imports Cendyn.CenRes.DataLib.ViewModels

Namespace Global

    Namespace Cendyn.CenRes.DataLib.ViewModels

        Public Partial Class ReservationSummary
            Public Overridable Property FirstName As String
            Public Overridable Property LastName As String
            Public Overridable Property ExternalProfileId As String
            Public Overridable Property ExternalProfileId2 As String
            Public Overridable Property ExternalResID1 As String
            Public Overridable Property ExternalResID2 As String
            Public Overridable Property CendynPropertyId As String
            Public Overridable Property PropertyName As String
            Public Overridable Property ResTypeCode As String
            Public Overridable Property ResStatusCode As String
            Public Overridable Property ConfirmationNum As String
            Public Overridable Property CentralResNum As String
            Public Overridable Property ResArriveDate As Nullable(Of Date)
            Public Overridable Property ResDepartDate As Nullable(Of Date)
            Public Overridable Property NumRooms As Nullable(Of Integer)
            Public Overridable Property RoomTypeCode As String
            Public Overridable Property RoomNumber As String
            Public Overridable Property RateCode As String
            Public Overridable Property MarketSegmentCode As String
            Public Overridable Property MarketCodeCategory As String
            Public Overridable Property MarketRegionCode As String
            Public Overridable Property CompanyName As String
            Public Overridable Property NumAdults As Nullable(Of Integer)
            Public Overridable Property NumYouths As Nullable(Of Integer)
            Public Overridable Property NumChildren As Nullable(Of Integer)
            Public Overridable Property TotalRoomNights As Nullable(Of Integer)
            Public Overridable Property CancellationID As String
            Public Overridable Property CancellationDate As Nullable(Of Date)
            Public Overridable Property TotalOtherRevenue As Nullable(Of Decimal)
            Public Overridable Property TotalRoomRevenue As Nullable(Of Decimal)
            Public Overridable Property TotalTax As Nullable(Of Decimal)
            Public Overridable Property TotalRevenue As Nullable(Of Decimal)
            Public Overridable Property LastUpdated As Date
        End Class
    End Namespace

    Namespace CenResSS.ServiceModel

        Public Partial Class CenResResponse
            Public Overridable Property Status As RequestStatus
            Public Overridable Property StatusMessage As String
            Public Overridable Property RecordsReturned As Integer
            Public Overridable Property RecordsAvailable As Integer
            Public Overridable Property PageNumber As Integer
            Public Overridable Property PageSize As Integer
        End Class

        Public Enum RequestStatus
            Success
            Warning
            [Error]
            NotAuthorized
            Failure
        End Enum

        Public Enum ReservationQueryType
            ResId
            ProfileId
            Name
            LastUpdated
            ArrivalDate
            DepartureDate
            StayDate
            DatePMSResUpdated
        End Enum

        Public Partial Class ResSummaryRequest
            Public Overridable Property CendynPropertyId As String
            Public Overridable Property Query As ReservationQueryType
            Public Overridable Property Id As String
            Public Overridable Property FirstName As String
            Public Overridable Property LastName As String
            Public Overridable Property StartDate As Nullable(Of Date)
            Public Overridable Property EndDate As Nullable(Of Date)
            <DataMember(Name:="Limit")>
            Public Overridable Property PageSize As Integer

            <DataMember(Name:="Page")>
            Public Overridable Property PageNumber As Integer
        End Class

        Public Partial Class ResSummaryResponse
            Inherits CenResResponse
            Public Sub New()
                Records = New List(Of ReservationSummary)
            End Sub

            Public Overridable Property Records As List(Of ReservationSummary)
        End Class
    End Namespace
End Namespace

VB.NET ResSummaryRequest DTOs

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.

GET /v2/reservation/summary/{Query} HTTP/1.1 
Host: cert.cendyn.com 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ResSummaryResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CenResSS.ServiceModel">
  <PageNumber>0</PageNumber>
  <PageSize>0</PageSize>
  <RecordsAvailable>0</RecordsAvailable>
  <RecordsReturned>0</RecordsReturned>
  <Status>Success</Status>
  <StatusMessage>String</StatusMessage>
  <Records xmlns:d2p1="http://schemas.datacontract.org/2004/07/Cendyn.CenRes.DataLib.ViewModels">
    <d2p1:ReservationSummary>
      <d2p1:CancellationDate>0001-01-01T00:00:00</d2p1:CancellationDate>
      <d2p1:CancellationID>String</d2p1:CancellationID>
      <d2p1:CendynPropertyId>String</d2p1:CendynPropertyId>
      <d2p1:CentralResNum>String</d2p1:CentralResNum>
      <d2p1:CompanyName>String</d2p1:CompanyName>
      <d2p1:ConfirmationNum>String</d2p1:ConfirmationNum>
      <d2p1:ExternalProfileId>String</d2p1:ExternalProfileId>
      <d2p1:ExternalProfileId2>String</d2p1:ExternalProfileId2>
      <d2p1:ExternalResID1>String</d2p1:ExternalResID1>
      <d2p1:ExternalResID2>String</d2p1:ExternalResID2>
      <d2p1:FirstName>String</d2p1:FirstName>
      <d2p1:LastName>String</d2p1:LastName>
      <d2p1:LastUpdated>0001-01-01T00:00:00</d2p1:LastUpdated>
      <d2p1:MarketCodeCategory>String</d2p1:MarketCodeCategory>
      <d2p1:MarketRegionCode>String</d2p1:MarketRegionCode>
      <d2p1:MarketSegmentCode>String</d2p1:MarketSegmentCode>
      <d2p1:NumAdults>0</d2p1:NumAdults>
      <d2p1:NumChildren>0</d2p1:NumChildren>
      <d2p1:NumRooms>0</d2p1:NumRooms>
      <d2p1:NumYouths>0</d2p1:NumYouths>
      <d2p1:PropertyName>String</d2p1:PropertyName>
      <d2p1:RateCode>String</d2p1:RateCode>
      <d2p1:ResArriveDate>0001-01-01T00:00:00</d2p1:ResArriveDate>
      <d2p1:ResDepartDate>0001-01-01T00:00:00</d2p1:ResDepartDate>
      <d2p1:ResStatusCode>String</d2p1:ResStatusCode>
      <d2p1:ResTypeCode>String</d2p1:ResTypeCode>
      <d2p1:RoomNumber>String</d2p1:RoomNumber>
      <d2p1:RoomTypeCode>String</d2p1:RoomTypeCode>
      <d2p1:TotalOtherRevenue>0</d2p1:TotalOtherRevenue>
      <d2p1:TotalRevenue>0</d2p1:TotalRevenue>
      <d2p1:TotalRoomNights>0</d2p1:TotalRoomNights>
      <d2p1:TotalRoomRevenue>0</d2p1:TotalRoomRevenue>
      <d2p1:TotalTax>0</d2p1:TotalTax>
    </d2p1:ReservationSummary>
  </Records>
</ResSummaryResponse>