CenResService

<back to all web services

StayHistoryRequest

The following routes are available for this service:
GET/v2/stayhistory/{Query}/{CendynPropertyId}
GET/v2/stayhistory/{Query}
import java.math.*
import java.util.*
import net.servicestack.client.*
import com.google.gson.annotations.*
import com.google.gson.reflect.*


open class StayHistoryRequest
{
    var cendynPropertyId:String? = null
    var query:StayHistoryQueryType? = null
    var id:String? = null
}

enum class StayHistoryQueryType
{
    ProfileId,
    ResId,
}

open class StayHistoryResponse : CenResResponse()
{
    var records:ArrayList<StayHistory> = ArrayList<StayHistory>()
}

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 StayHistory
{
    var cendynPropertyID:String? = null
    var resortID:String? = null
    var externalProfileID1:String? = null
    var externalResId1:String? = null
    var crsBookNo:String? = null
    var resortBookNo:String? = null
    var resortLegNo:Int? = null
    var confirmationID:String? = null
    var reservationStatus:String? = null
    var hasDailyRooms:Boolean? = null
    var rateRoomType:String? = null
    var actualArrivalDate:Date? = null
    var actualDepartureDate:Date? = null
    var bookDate:Date? = null
    var bookedArrivalDate:Date? = null
    var bookedDepartureDate:Date? = null
    var compYN:String? = null
    var adults:Int? = null
    var children:Int? = null
    var roomCategory:String? = null
    var roomNumber:String? = null
    var rateAmount:BigDecimal? = null
    var rateCode:String? = null
    var rateAmountCurrencyCode:String? = null
    var currencyCode:String? = null
    var sourceCode:String? = null
    var marketCode:String? = null
    var travelAgentID:String? = null
    var companyID:String? = null
    var channel:String? = null
    var paymentMethod:String? = null
    var rateCurrencyCode:String? = null
    var totalRevenue:BigDecimal? = null
    var roomRevenue:BigDecimal? = null
    var fbRevenue:BigDecimal? = null
    var membershipType:String? = null
    var membershipID:String? = null
    var transactionID:String? = null
    var transactionStatus:String? = null
    var uniqueIDs:ArrayList<UniqueIDType> = ArrayList<UniqueIDType>()
    var stayHistoryRevenueCollection:ArrayList<StayHistoryRevenue> = ArrayList<StayHistoryRevenue>()
    var stayHistoryDailyRateCollection:ArrayList<StayHistoryDailyRate> = ArrayList<StayHistoryDailyRate>()
}

open class UniqueIDType
{
    var id:String? = null
    @SerializedName("type") var Type:String? = null
    var context:String? = null
}

open class StayHistoryRevenue
{
    var recordStatus:String? = null
    @DataMember(IsRequired=true)
    var revenueGroup:String? = null

    @DataMember(IsRequired=true)
    var revenueType:String? = null

    @DataMember(IsRequired=true)
    var amount:BigDecimal? = null

    var currencyCode:String? = null
    var folioWindow:String? = null
    var transactionDate:Date? = null
    var inactiveDate:Date? = null
}

open class StayHistoryDailyRate
{
    var recordStatus:String? = null
    var transactionDate:Date? = null
    var rateCode:String? = null
    var marketCode:String? = null
    var amount:BigDecimal? = null
    var currencyCode:String? = null
    var roomNumber:String? = null
    var resourceID:String? = null
    var pseudoRoom:String? = null
    var roomCategory:String? = null
    var rateRoomType:String? = null
    var inactiveDate:Date? = null
}

Kotlin StayHistoryRequest 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/stayhistory/{Query}/{CendynPropertyId} HTTP/1.1 
Host: cert.cendyn.com 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<StayHistoryResponse 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>
    <StayHistory>
      <ActualArrivalDate>0001-01-01T00:00:00</ActualArrivalDate>
      <ActualDepartureDate>0001-01-01T00:00:00</ActualDepartureDate>
      <Adults>0</Adults>
      <BookDate>0001-01-01T00:00:00</BookDate>
      <BookedArrivalDate>0001-01-01T00:00:00</BookedArrivalDate>
      <BookedDepartureDate>0001-01-01T00:00:00</BookedDepartureDate>
      <CRSBookNo>String</CRSBookNo>
      <CendynPropertyID>String</CendynPropertyID>
      <Channel>String</Channel>
      <Children>0</Children>
      <CompYN>String</CompYN>
      <CompanyID>String</CompanyID>
      <ConfirmationID>String</ConfirmationID>
      <CurrencyCode>String</CurrencyCode>
      <ExternalProfileID1>String</ExternalProfileID1>
      <ExternalResId1>String</ExternalResId1>
      <FbRevenue>0</FbRevenue>
      <HasDailyRooms>false</HasDailyRooms>
      <MarketCode>String</MarketCode>
      <MembershipID>String</MembershipID>
      <MembershipType>String</MembershipType>
      <PaymentMethod>String</PaymentMethod>
      <RateAmount>0</RateAmount>
      <RateAmountCurrencyCode>String</RateAmountCurrencyCode>
      <RateCode>String</RateCode>
      <RateCurrencyCode>String</RateCurrencyCode>
      <RateRoomType>String</RateRoomType>
      <ReservationStatus>String</ReservationStatus>
      <ResortBookNo>String</ResortBookNo>
      <ResortID>String</ResortID>
      <ResortLegNo>0</ResortLegNo>
      <RoomCategory>String</RoomCategory>
      <RoomNumber>String</RoomNumber>
      <RoomRevenue>0</RoomRevenue>
      <SourceCode>String</SourceCode>
      <StayHistoryDailyRateCollection>
        <StayHistoryDailyRate>
          <Amount>0</Amount>
          <CurrencyCode>String</CurrencyCode>
          <InactiveDate>0001-01-01T00:00:00</InactiveDate>
          <MarketCode>String</MarketCode>
          <PseudoRoom>String</PseudoRoom>
          <RateCode>String</RateCode>
          <RateRoomType>String</RateRoomType>
          <RecordStatus>String</RecordStatus>
          <ResourceID>String</ResourceID>
          <RoomCategory>String</RoomCategory>
          <RoomNumber>String</RoomNumber>
          <TransactionDate>0001-01-01T00:00:00</TransactionDate>
        </StayHistoryDailyRate>
      </StayHistoryDailyRateCollection>
      <StayHistoryRevenueCollection>
        <StayHistoryRevenue>
          <Amount>0</Amount>
          <CurrencyCode>String</CurrencyCode>
          <FolioWindow>String</FolioWindow>
          <InactiveDate>0001-01-01T00:00:00</InactiveDate>
          <RecordStatus>String</RecordStatus>
          <RevenueGroup>String</RevenueGroup>
          <RevenueType>String</RevenueType>
          <TransactionDate>0001-01-01T00:00:00</TransactionDate>
        </StayHistoryRevenue>
      </StayHistoryRevenueCollection>
      <TotalRevenue>0</TotalRevenue>
      <TransactionID>String</TransactionID>
      <TransactionStatus>String</TransactionStatus>
      <TravelAgentID>String</TravelAgentID>
      <UniqueIDs>
        <UniqueIDType>
          <Context>String</Context>
          <ID>String</ID>
          <Type>String</Type>
        </UniqueIDType>
      </UniqueIDs>
    </StayHistory>
  </Records>
</StayHistoryResponse>