CenResService

<back to all web services

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 .xml suffix or ?format=xml

HTTP + XML

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/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<StayHistoryResponse 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>
    <StayHistory>
      <ActualArrivalDate>0001-01-01T00:00:00</ActualArrivalDate>
      <ActualDepartureDate>0001-01-01T00:00:00</ActualDepartureDate>
      <Adults>0</Adults>
      <BookDate>0001-01-01T00:00:00</BookDate>
      <BookedArrivalDate>0001-01-01T00:00:00</BookedArrivalDate>
      <BookedDepartureDate>0001-01-01T00:00:00</BookedDepartureDate>
      <CRSBookNo>String</CRSBookNo>
      <CendynPropertyID>String</CendynPropertyID>
      <Channel>String</Channel>
      <Children>0</Children>
      <CompYN>String</CompYN>
      <CompanyID>String</CompanyID>
      <ConfirmationID>String</ConfirmationID>
      <CurrencyCode>String</CurrencyCode>
      <ExternalProfileID1>String</ExternalProfileID1>
      <ExternalResId1>String</ExternalResId1>
      <FbRevenue>0</FbRevenue>
      <HasDailyRooms>false</HasDailyRooms>
      <MarketCode>String</MarketCode>
      <MembershipID>String</MembershipID>
      <MembershipType>String</MembershipType>
      <PaymentMethod>String</PaymentMethod>
      <RateAmount>0</RateAmount>
      <RateAmountCurrencyCode>String</RateAmountCurrencyCode>
      <RateCode>String</RateCode>
      <RateCurrencyCode>String</RateCurrencyCode>
      <RateRoomType>String</RateRoomType>
      <ReservationStatus>String</ReservationStatus>
      <ResortBookNo>String</ResortBookNo>
      <ResortID>String</ResortID>
      <ResortLegNo>0</ResortLegNo>
      <RoomCategory>String</RoomCategory>
      <RoomNumber>String</RoomNumber>
      <RoomRevenue>0</RoomRevenue>
      <SourceCode>String</SourceCode>
      <StayHistoryDailyRateCollection>
        <StayHistoryDailyRate>
          <Amount>0</Amount>
          <CurrencyCode>String</CurrencyCode>
          <InactiveDate>0001-01-01T00:00:00</InactiveDate>
          <MarketCode>String</MarketCode>
          <PseudoRoom>String</PseudoRoom>
          <RateCode>String</RateCode>
          <RateRoomType>String</RateRoomType>
          <RecordStatus>String</RecordStatus>
          <ResourceID>String</ResourceID>
          <RoomCategory>String</RoomCategory>
          <RoomNumber>String</RoomNumber>
          <TransactionDate>0001-01-01T00:00:00</TransactionDate>
        </StayHistoryDailyRate>
      </StayHistoryDailyRateCollection>
      <StayHistoryRevenueCollection>
        <StayHistoryRevenue>
          <Amount>0</Amount>
          <CurrencyCode>String</CurrencyCode>
          <FolioWindow>String</FolioWindow>
          <InactiveDate>0001-01-01T00:00:00</InactiveDate>
          <RecordStatus>String</RecordStatus>
          <RevenueGroup>String</RevenueGroup>
          <RevenueType>String</RevenueType>
          <TransactionDate>0001-01-01T00:00:00</TransactionDate>
        </StayHistoryRevenue>
      </StayHistoryRevenueCollection>
      <TotalRevenue>0</TotalRevenue>
      <TransactionID>String</TransactionID>
      <TransactionStatus>String</TransactionStatus>
      <TravelAgentID>String</TravelAgentID>
      <UniqueIDs>
        <UniqueIDType>
          <Context>String</Context>
          <ID>String</ID>
          <Type>String</Type>
        </UniqueIDType>
      </UniqueIDs>
    </StayHistory>
  </Records>
</StayHistoryResponse>