CenResService

<back to all web services

StayHistoryRequest

The following routes are available for this service:
GET/v2/stayhistory/{Query}/{CendynPropertyId}
GET/v2/stayhistory/{Query}
StayHistoryRequest Parameters:
NameParameterData TypeRequiredDescription
CendynPropertyIdpathstringNo
QuerypathStayHistoryQueryTypeNo
IdquerystringNo
StayHistoryQueryType Enum:
ProfileId
ResId
StayHistoryResponse Parameters:
NameParameterData TypeRequiredDescription
RecordsformList<StayHistory>No
CenResResponse Parameters:
NameParameterData TypeRequiredDescription
StatusformRequestStatusNo
StatusMessageformstringNo
RecordsReturnedformintNo
RecordsAvailableformintNo
PageNumberformintNo
PageSizeformintNo
RequestStatus Enum:
Success
Warning
Error
NotAuthorized
Failure
StayHistory Parameters:
NameParameterData TypeRequiredDescription
CendynPropertyIDformstringNo
ResortIDformstringNo
ExternalProfileID1formstringNo
ExternalResId1formstringNo
CRSBookNoformstringNo
ResortBookNoformstringNo
ResortLegNoformint?No
ConfirmationIDformstringNo
ReservationStatusformstringNo
HasDailyRoomsformbool?No
RateRoomTypeformstringNo
ActualArrivalDateformDateTime?No
ActualDepartureDateformDateTime?No
BookDateformDateTime?No
BookedArrivalDateformDateTime?No
BookedDepartureDateformDateTime?No
CompYNformstringNo
Adultsformint?No
Childrenformint?No
RoomCategoryformstringNo
RoomNumberformstringNo
RateAmountformdecimal?No
RateCodeformstringNo
RateAmountCurrencyCodeformstringNo
CurrencyCodeformstringNo
SourceCodeformstringNo
MarketCodeformstringNo
TravelAgentIDformstringNo
CompanyIDformstringNo
ChannelformstringNo
PaymentMethodformstringNo
RateCurrencyCodeformstringNo
TotalRevenueformdecimal?No
RoomRevenueformdecimal?No
FbRevenueformdecimal?No
MembershipTypeformstringNo
MembershipIDformstringNo
TransactionIDformstringNo
TransactionStatusformstringNo
UniqueIDsformList<UniqueIDType>No
StayHistoryRevenueCollectionformList<StayHistoryRevenue>No
StayHistoryDailyRateCollectionformList<StayHistoryDailyRate>No
UniqueIDType Parameters:
NameParameterData TypeRequiredDescription
IDformstringNo
TypeformstringNo
ContextformstringNo
StayHistoryRevenue Parameters:
NameParameterData TypeRequiredDescription
RecordStatusformstringNo
RevenueGroupformstringNo
RevenueTypeformstringNo
AmountformdecimalNo
CurrencyCodeformstringNo
FolioWindowformstringNo
TransactionDateformDateTime?No
InactiveDateformDateTime?No
StayHistoryDailyRate Parameters:
NameParameterData TypeRequiredDescription
RecordStatusformstringNo
TransactionDateformDateTime?No
RateCodeformstringNo
MarketCodeformstringNo
AmountformdecimalNo
CurrencyCodeformstringNo
RoomNumberformstringNo
ResourceIDformstringNo
PseudoRoomformstringNo
RoomCategoryformstringNo
RateRoomTypeformstringNo
InactiveDateformDateTime?No

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}