CenResService

ResSummaryRequest

The following routes are available for this service:
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 .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/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}