| GET | /v2/reservation/summary/{Query} | ||
|---|---|---|---|
| GET | /v2/reservation/summary/{Query}/{CendynPropertyId} |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| CendynPropertyId | path | string | No | |
| Query | path | ReservationQueryType | No | |
| Id | query | string | No | |
| FirstName | query | string | No | |
| LastName | query | string | No | |
| StartDate | query | DateTime? | No | |
| EndDate | query | DateTime? | No | |
| PageSize | query | int | No | |
| PageNumber | query | int | No |
| ResId | |
| ProfileId | |
| Name | |
| LastUpdated | |
| ArrivalDate | |
| DepartureDate | |
| StayDate | |
| DatePMSResUpdated |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Records | form | List<ReservationSummary> | 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 |
|---|---|---|---|---|
| FirstName | form | string | No | |
| LastName | form | string | No | |
| ExternalProfileId | form | string | No | |
| ExternalProfileId2 | form | string | No | |
| ExternalResID1 | form | string | No | |
| ExternalResID2 | form | string | No | |
| CendynPropertyId | form | string | No | |
| PropertyName | form | string | No | |
| ResTypeCode | form | string | No | |
| ResStatusCode | form | string | No | |
| ConfirmationNum | form | string | No | |
| CentralResNum | form | string | No | |
| ResArriveDate | form | DateTime? | No | |
| ResDepartDate | form | DateTime? | No | |
| NumRooms | form | int? | No | |
| RoomTypeCode | form | string | No | |
| RoomNumber | form | string | No | |
| RateCode | form | string | No | |
| MarketSegmentCode | form | string | No | |
| MarketCodeCategory | form | string | No | |
| MarketRegionCode | form | string | No | |
| CompanyName | form | string | No | |
| NumAdults | form | int? | No | |
| NumYouths | form | int? | No | |
| NumChildren | form | int? | No | |
| TotalRoomNights | form | int? | No | |
| CancellationID | form | string | No | |
| CancellationDate | form | DateTime? | No | |
| TotalOtherRevenue | form | decimal? | No | |
| TotalRoomRevenue | form | decimal? | No | |
| TotalTax | form | decimal? | No | |
| TotalRevenue | form | decimal? | No | |
| LastUpdated | 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/reservation/summary/{Query} HTTP/1.1
Host: cert.cendyn.com
Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length
{"records":[{"firstName":"String","lastName":"String","externalProfileId":"String","externalProfileId2":"String","externalResID1":"String","externalResID2":"String","cendynPropertyId":"String","propertyName":"String","resTypeCode":"String","resStatusCode":"String","confirmationNum":"String","centralResNum":"String","resArriveDate":"0001-01-01T00:00:00.0000000","resDepartDate":"0001-01-01T00:00:00.0000000","numRooms":0,"roomTypeCode":"String","roomNumber":"String","rateCode":"String","marketSegmentCode":"String","marketCodeCategory":"String","marketRegionCode":"String","companyName":"String","numAdults":0,"numYouths":0,"numChildren":0,"totalRoomNights":0,"cancellationID":"String","cancellationDate":"0001-01-01T00:00:00.0000000","totalOtherRevenue":0,"totalRoomRevenue":0,"totalTax":0,"totalRevenue":0,"lastUpdated":"0001-01-01T00:00:00.0000000"}],"status":"Success","statusMessage":"String","recordsReturned":0,"recordsAvailable":0,"pageNumber":0,"pageSize":0}