| GET | /v2/stayhistory/{Query}/{CendynPropertyId} | ||
|---|---|---|---|
| GET | /v2/stayhistory/{Query} |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| CendynPropertyId | path | string | No | |
| Query | path | StayHistoryQueryType | No | |
| Id | query | string | No |
| ProfileId | |
| ResId |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Records | form | List<StayHistory> | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Status | form | RequestStatus | No | |
| StatusMessage | form | string | No | |
| RecordsReturned | form | int | No | |
| RecordsAvailable | form | int | No | |
| PageNumber | form | int | No | |
| PageSize | form | int | No |
| Success | |
| Warning | |
| Error | |
| NotAuthorized | |
| Failure |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| CendynPropertyID | form | string | No | |
| ResortID | form | string | No | |
| ExternalProfileID1 | form | string | No | |
| ExternalResId1 | form | string | No | |
| CRSBookNo | form | string | No | |
| ResortBookNo | form | string | No | |
| ResortLegNo | form | int? | No | |
| ConfirmationID | form | string | No | |
| ReservationStatus | form | string | No | |
| HasDailyRooms | form | bool? | No | |
| RateRoomType | form | string | No | |
| ActualArrivalDate | form | DateTime? | No | |
| ActualDepartureDate | form | DateTime? | No | |
| BookDate | form | DateTime? | No | |
| BookedArrivalDate | form | DateTime? | No | |
| BookedDepartureDate | form | DateTime? | No | |
| CompYN | form | string | No | |
| Adults | form | int? | No | |
| Children | form | int? | No | |
| RoomCategory | form | string | No | |
| RoomNumber | form | string | No | |
| RateAmount | form | decimal? | No | |
| RateCode | form | string | No | |
| RateAmountCurrencyCode | form | string | No | |
| CurrencyCode | form | string | No | |
| SourceCode | form | string | No | |
| MarketCode | form | string | No | |
| TravelAgentID | form | string | No | |
| CompanyID | form | string | No | |
| Channel | form | string | No | |
| PaymentMethod | form | string | No | |
| RateCurrencyCode | form | string | No | |
| TotalRevenue | form | decimal? | No | |
| RoomRevenue | form | decimal? | No | |
| FbRevenue | form | decimal? | No | |
| MembershipType | form | string | No | |
| MembershipID | form | string | No | |
| TransactionID | form | string | No | |
| TransactionStatus | form | string | No | |
| UniqueIDs | form | List<UniqueIDType> | No | |
| StayHistoryRevenueCollection | form | List<StayHistoryRevenue> | No | |
| StayHistoryDailyRateCollection | form | List<StayHistoryDailyRate> | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ID | form | string | No | |
| Type | form | string | No | |
| Context | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| RecordStatus | form | string | No | |
| RevenueGroup | form | string | No | |
| RevenueType | form | string | No | |
| Amount | form | decimal | No | |
| CurrencyCode | form | string | No | |
| FolioWindow | form | string | No | |
| TransactionDate | form | DateTime? | No | |
| InactiveDate | form | DateTime? | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| RecordStatus | form | string | No | |
| TransactionDate | form | DateTime? | No | |
| RateCode | form | string | No | |
| MarketCode | form | string | No | |
| Amount | form | decimal | No | |
| CurrencyCode | form | string | No | |
| RoomNumber | form | string | No | |
| ResourceID | form | string | No | |
| PseudoRoom | form | string | No | |
| RoomCategory | form | string | No | |
| RateRoomType | form | string | No | |
| InactiveDate | form | DateTime? | 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
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}