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}
namespace CenResSS.ServiceModel

open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    type RequestStatus =
        | Success = 0
        | Warning = 1
        | Error = 2
        | NotAuthorized = 3
        | Failure = 4

    [<AllowNullLiteral>]
    type CenResResponse() = 
        member val Status:RequestStatus = new RequestStatus() with get,set
        member val StatusMessage:String = null with get,set
        member val RecordsReturned:Int32 = new Int32() with get,set
        member val RecordsAvailable:Int32 = new Int32() with get,set
        member val PageNumber:Int32 = new Int32() with get,set
        member val PageSize:Int32 = new Int32() with get,set

    [<AllowNullLiteral>]
    type ReservationSummary() = 
        member val FirstName:String = null with get,set
        member val LastName:String = null with get,set
        member val ExternalProfileId:String = null with get,set
        member val ExternalProfileId2:String = null with get,set
        member val ExternalResID1:String = null with get,set
        member val ExternalResID2:String = null with get,set
        member val CendynPropertyId:String = null with get,set
        member val PropertyName:String = null with get,set
        member val ResTypeCode:String = null with get,set
        member val ResStatusCode:String = null with get,set
        member val ConfirmationNum:String = null with get,set
        member val CentralResNum:String = null with get,set
        member val ResArriveDate:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val ResDepartDate:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val NumRooms:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val RoomTypeCode:String = null with get,set
        member val RoomNumber:String = null with get,set
        member val RateCode:String = null with get,set
        member val MarketSegmentCode:String = null with get,set
        member val MarketCodeCategory:String = null with get,set
        member val MarketRegionCode:String = null with get,set
        member val CompanyName:String = null with get,set
        member val NumAdults:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val NumYouths:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val NumChildren:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val TotalRoomNights:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val CancellationID:String = null with get,set
        member val CancellationDate:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val TotalOtherRevenue:Nullable<Decimal> = new Nullable<Decimal>() with get,set
        member val TotalRoomRevenue:Nullable<Decimal> = new Nullable<Decimal>() with get,set
        member val TotalTax:Nullable<Decimal> = new Nullable<Decimal>() with get,set
        member val TotalRevenue:Nullable<Decimal> = new Nullable<Decimal>() with get,set
        member val LastUpdated:DateTime = new DateTime() with get,set

    [<AllowNullLiteral>]
    type ResSummaryResponse() = 
        inherit CenResResponse()
        member val Records:ResizeArray<ReservationSummary> = new ResizeArray<ReservationSummary>() with get,set

    type ReservationQueryType =
        | ResId = 0
        | ProfileId = 1
        | Name = 2
        | LastUpdated = 3
        | ArrivalDate = 4
        | DepartureDate = 5
        | StayDate = 6
        | DatePMSResUpdated = 7

    [<AllowNullLiteral>]
    type ResSummaryRequest() = 
        member val CendynPropertyId:String = null with get,set
        member val Query:ReservationQueryType = new ReservationQueryType() with get,set
        member val Id:String = null with get,set
        member val FirstName:String = null with get,set
        member val LastName:String = null with get,set
        member val StartDate:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val EndDate:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        [<DataMember(Name="Limit")>]
        member val PageSize:Int32 = new Int32() with get,set

        [<DataMember(Name="Page")>]
        member val PageNumber:Int32 = new Int32() with get,set

F# 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>