| GET | /v2/reservation/summary/{Query} | ||
|---|---|---|---|
| GET | /v2/reservation/summary/{Query}/{CendynPropertyId} |
export enum RequestStatus
{
Success = 'Success',
Warning = 'Warning',
Error = 'Error',
NotAuthorized = 'NotAuthorized',
Failure = 'Failure',
}
export class CenResResponse
{
public status?: RequestStatus;
public statusMessage?: string;
public recordsReturned?: number;
public recordsAvailable?: number;
public pageNumber?: number;
public pageSize?: number;
public constructor(init?: Partial<CenResResponse>) { (Object as any).assign(this, init); }
}
export class ReservationSummary
{
public firstName?: string;
public lastName?: string;
public externalProfileId?: string;
public externalProfileId2?: string;
public externalResID1?: string;
public externalResID2?: string;
public cendynPropertyId?: string;
public propertyName?: string;
public resTypeCode?: string;
public resStatusCode?: string;
public confirmationNum?: string;
public centralResNum?: string;
public resArriveDate?: string;
public resDepartDate?: string;
public numRooms?: number;
public roomTypeCode?: string;
public roomNumber?: string;
public rateCode?: string;
public marketSegmentCode?: string;
public marketCodeCategory?: string;
public marketRegionCode?: string;
public companyName?: string;
public numAdults?: number;
public numYouths?: number;
public numChildren?: number;
public totalRoomNights?: number;
public cancellationID?: string;
public cancellationDate?: string;
public totalOtherRevenue?: number;
public totalRoomRevenue?: number;
public totalTax?: number;
public totalRevenue?: number;
public lastUpdated?: string;
public constructor(init?: Partial<ReservationSummary>) { (Object as any).assign(this, init); }
}
export class ResSummaryResponse extends CenResResponse
{
public records?: ReservationSummary[];
public constructor(init?: Partial<ResSummaryResponse>) { super(init); (Object as any).assign(this, init); }
}
export enum ReservationQueryType
{
ResId = 'ResId',
ProfileId = 'ProfileId',
Name = 'Name',
LastUpdated = 'LastUpdated',
ArrivalDate = 'ArrivalDate',
DepartureDate = 'DepartureDate',
StayDate = 'StayDate',
DatePMSResUpdated = 'DatePMSResUpdated',
}
export class ResSummaryRequest
{
public cendynPropertyId?: string;
public query?: ReservationQueryType;
public id?: string;
public firstName?: string;
public lastName?: string;
public startDate?: string;
public endDate?: string;
// @DataMember(Name="Limit")
public pageSize?: number;
// @DataMember(Name="Page")
public pageNumber?: number;
public constructor(init?: Partial<ResSummaryRequest>) { (Object as any).assign(this, init); }
}
TypeScript ResSummaryRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
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/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<ResSummaryResponse 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 xmlns:d2p1="http://schemas.datacontract.org/2004/07/Cendyn.CenRes.DataLib.ViewModels">
<d2p1:ReservationSummary>
<d2p1:CancellationDate>0001-01-01T00:00:00</d2p1:CancellationDate>
<d2p1:CancellationID>String</d2p1:CancellationID>
<d2p1:CendynPropertyId>String</d2p1:CendynPropertyId>
<d2p1:CentralResNum>String</d2p1:CentralResNum>
<d2p1:CompanyName>String</d2p1:CompanyName>
<d2p1:ConfirmationNum>String</d2p1:ConfirmationNum>
<d2p1:ExternalProfileId>String</d2p1:ExternalProfileId>
<d2p1:ExternalProfileId2>String</d2p1:ExternalProfileId2>
<d2p1:ExternalResID1>String</d2p1:ExternalResID1>
<d2p1:ExternalResID2>String</d2p1:ExternalResID2>
<d2p1:FirstName>String</d2p1:FirstName>
<d2p1:LastName>String</d2p1:LastName>
<d2p1:LastUpdated>0001-01-01T00:00:00</d2p1:LastUpdated>
<d2p1:MarketCodeCategory>String</d2p1:MarketCodeCategory>
<d2p1:MarketRegionCode>String</d2p1:MarketRegionCode>
<d2p1:MarketSegmentCode>String</d2p1:MarketSegmentCode>
<d2p1:NumAdults>0</d2p1:NumAdults>
<d2p1:NumChildren>0</d2p1:NumChildren>
<d2p1:NumRooms>0</d2p1:NumRooms>
<d2p1:NumYouths>0</d2p1:NumYouths>
<d2p1:PropertyName>String</d2p1:PropertyName>
<d2p1:RateCode>String</d2p1:RateCode>
<d2p1:ResArriveDate>0001-01-01T00:00:00</d2p1:ResArriveDate>
<d2p1:ResDepartDate>0001-01-01T00:00:00</d2p1:ResDepartDate>
<d2p1:ResStatusCode>String</d2p1:ResStatusCode>
<d2p1:ResTypeCode>String</d2p1:ResTypeCode>
<d2p1:RoomNumber>String</d2p1:RoomNumber>
<d2p1:RoomTypeCode>String</d2p1:RoomTypeCode>
<d2p1:TotalOtherRevenue>0</d2p1:TotalOtherRevenue>
<d2p1:TotalRevenue>0</d2p1:TotalRevenue>
<d2p1:TotalRoomNights>0</d2p1:TotalRoomNights>
<d2p1:TotalRoomRevenue>0</d2p1:TotalRoomRevenue>
<d2p1:TotalTax>0</d2p1:TotalTax>
</d2p1:ReservationSummary>
</Records>
</ResSummaryResponse>