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 .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"records":[{"cendynPropertyID":"String","resortID":"String","externalProfileID1":"String","externalResId1":"String","crsBookNo":"String","resortBookNo":"String","resortLegNo":0,"confirmationID":"String","reservationStatus":"String","hasDailyRooms":false,"rateRoomType":"String","actualArrivalDate":"0001-01-01T00:00:00.0000000","actualDepartureDate":"0001-01-01T00:00:00.0000000","bookDate":"0001-01-01T00:00:00.0000000","bookedArrivalDate":"0001-01-01T00:00:00.0000000","bookedDepartureDate":"0001-01-01T00:00:00.0000000","compYN":"String","adults":0,"children":0,"roomCategory":"String","roomNumber":"String","rateAmount":0,"rateCode":"String","rateAmountCurrencyCode":"String","currencyCode":"String","sourceCode":"String","marketCode":"String","travelAgentID":"String","companyID":"String","channel":"String","paymentMethod":"String","rateCurrencyCode":"String","totalRevenue":0,"roomRevenue":0,"fbRevenue":0,"membershipType":"String","membershipID":"String","transactionID":"String","transactionStatus":"String","uniqueIDs":[{"id":"String","type":"String","context":"String"}],"stayHistoryRevenueCollection":[{"recordStatus":"String","revenueGroup":"String","revenueType":"String","amount":0,"currencyCode":"String","folioWindow":"String","transactionDate":"0001-01-01T00:00:00.0000000","inactiveDate":"0001-01-01T00:00:00.0000000"}],"stayHistoryDailyRateCollection":[{"recordStatus":"String","transactionDate":"0001-01-01T00:00:00.0000000","rateCode":"String","marketCode":"String","amount":0,"currencyCode":"String","roomNumber":"String","resourceID":"String","pseudoRoom":"String","roomCategory":"String","rateRoomType":"String","inactiveDate":"0001-01-01T00:00:00.0000000"}]}],"status":"Success","statusMessage":"String","recordsReturned":0,"recordsAvailable":0,"pageNumber":0,"pageSize":0}