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}
import java.math.*
import java.util.*
import net.servicestack.client.*
import com.google.gson.annotations.*
import com.google.gson.reflect.*


open class ResSummaryRequest
{
    var cendynPropertyId:String? = null
    var query:ReservationQueryType? = null
    var id:String? = null
    var firstName:String? = null
    var lastName:String? = null
    var startDate:Date? = null
    var endDate:Date? = null
    @DataMember(Name="Limit")
    @SerializedName("Limit")
    var pageSize:Int? = null

    @DataMember(Name="Page")
    @SerializedName("Page")
    var pageNumber:Int? = null
}

enum class ReservationQueryType
{
    ResId,
    ProfileId,
    Name,
    LastUpdated,
    ArrivalDate,
    DepartureDate,
    StayDate,
    DatePMSResUpdated,
}

open class ResSummaryResponse : CenResResponse()
{
    var records:ArrayList<ReservationSummary> = ArrayList<ReservationSummary>()
}

open class CenResResponse
{
    var status:RequestStatus? = null
    var statusMessage:String? = null
    var recordsReturned:Int? = null
    var recordsAvailable:Int? = null
    var pageNumber:Int? = null
    var pageSize:Int? = null
}

enum class RequestStatus
{
    Success,
    Warning,
    Error,
    NotAuthorized,
    Failure,
}

open class ReservationSummary
{
    var firstName:String? = null
    var lastName:String? = null
    var externalProfileId:String? = null
    var externalProfileId2:String? = null
    var externalResID1:String? = null
    var externalResID2:String? = null
    var cendynPropertyId:String? = null
    var propertyName:String? = null
    var resTypeCode:String? = null
    var resStatusCode:String? = null
    var confirmationNum:String? = null
    var centralResNum:String? = null
    var resArriveDate:Date? = null
    var resDepartDate:Date? = null
    var numRooms:Int? = null
    var roomTypeCode:String? = null
    var roomNumber:String? = null
    var rateCode:String? = null
    var marketSegmentCode:String? = null
    var marketCodeCategory:String? = null
    var marketRegionCode:String? = null
    var companyName:String? = null
    var numAdults:Int? = null
    var numYouths:Int? = null
    var numChildren:Int? = null
    var totalRoomNights:Int? = null
    var cancellationID:String? = null
    var cancellationDate:Date? = null
    var totalOtherRevenue:BigDecimal? = null
    var totalRoomRevenue:BigDecimal? = null
    var totalTax:BigDecimal? = null
    var totalRevenue:BigDecimal? = null
    var lastUpdated:Date? = null
}

Kotlin 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>