CenResService

StayHistoryRequest

The following routes are available for this service:
GET	/v2/stayhistory/{Query}/{CendynPropertyId}
GET	/v2/stayhistory/{Query}


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 UniqueIDType
{
    public id?: string;
    public type?: string;
    public context?: string;

    public constructor(init?: Partial<UniqueIDType>) { (Object as any).assign(this, init); }
}

export class StayHistoryRevenue
{
    public recordStatus?: string;
    // @DataMember(IsRequired=true)
    public revenueGroup?: string;

    // @DataMember(IsRequired=true)
    public revenueType?: string;

    // @DataMember(IsRequired=true)
    public amount?: number;

    public currencyCode?: string;
    public folioWindow?: string;
    public transactionDate?: string;
    public inactiveDate?: string;

    public constructor(init?: Partial<StayHistoryRevenue>) { (Object as any).assign(this, init); }
}

export class StayHistoryDailyRate
{
    public recordStatus?: string;
    public transactionDate?: string;
    public rateCode?: string;
    public marketCode?: string;
    public amount?: number;
    public currencyCode?: string;
    public roomNumber?: string;
    public resourceID?: string;
    public pseudoRoom?: string;
    public roomCategory?: string;
    public rateRoomType?: string;
    public inactiveDate?: string;

    public constructor(init?: Partial<StayHistoryDailyRate>) { (Object as any).assign(this, init); }
}

export class StayHistory
{
    public cendynPropertyID?: string;
    public resortID?: string;
    public externalProfileID1?: string;
    public externalResId1?: string;
    public crsBookNo?: string;
    public resortBookNo?: string;
    public resortLegNo?: number;
    public confirmationID?: string;
    public reservationStatus?: string;
    public hasDailyRooms?: boolean;
    public rateRoomType?: string;
    public actualArrivalDate?: string;
    public actualDepartureDate?: string;
    public bookDate?: string;
    public bookedArrivalDate?: string;
    public bookedDepartureDate?: string;
    public compYN?: string;
    public adults?: number;
    public children?: number;
    public roomCategory?: string;
    public roomNumber?: string;
    public rateAmount?: number;
    public rateCode?: string;
    public rateAmountCurrencyCode?: string;
    public currencyCode?: string;
    public sourceCode?: string;
    public marketCode?: string;
    public travelAgentID?: string;
    public companyID?: string;
    public channel?: string;
    public paymentMethod?: string;
    public rateCurrencyCode?: string;
    public totalRevenue?: number;
    public roomRevenue?: number;
    public fbRevenue?: number;
    public membershipType?: string;
    public membershipID?: string;
    public transactionID?: string;
    public transactionStatus?: string;
    public uniqueIDs?: UniqueIDType[];
    public stayHistoryRevenueCollection?: StayHistoryRevenue[];
    public stayHistoryDailyRateCollection?: StayHistoryDailyRate[];

    public constructor(init?: Partial<StayHistory>) { (Object as any).assign(this, init); }
}

export class StayHistoryResponse extends CenResResponse
{
    public records?: StayHistory[];

    public constructor(init?: Partial<StayHistoryResponse>) { super(init); (Object as any).assign(this, init); }
}

export enum StayHistoryQueryType
{
    ProfileId = 'ProfileId',
    ResId = 'ResId',
}

export class StayHistoryRequest
{
    public cendynPropertyId?: string;
    public query?: StayHistoryQueryType;
    public id?: string;

    public constructor(init?: Partial<StayHistoryRequest>) { (Object as any).assign(this, init); }
}

TypeScript StayHistoryRequest 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/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}