CenResService

<back to all web services

ReservationStatusNoticeRequest

The following routes are available for this service:
GET/v2/reservation/notice/{Query}
GET/v2/reservation/notice/{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 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 UniqueIDType
{
    public id?: string;
    public type?: string;
    public context?: string;

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

export class ReservationStatusNotice
{
    public cendynPropertyId?: string;
    public externalResId1?: string;
    public externalResId2?: string;
    public resStatus?: string;
    public cancellationID?: string;
    public cancellationDate?: string;
    public dateResUpdated?: string;
    public resUpdatedBy?: string;
    public roomNumber?: string;
    public roomNumberStartDate?: string;
    public roomNumberEndDate?: string;
    public stayHistoryRevenueCollection?: StayHistoryRevenue[];
    public resArriveDate?: string;
    public resDepartDate?: string;
    public currency?: string;
    public roomType?: string;
    public externalProfileID?: string;
    public uniqueIDs?: UniqueIDType[];

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

export class ReservationStatusNoticeResponse extends CenResResponse
{
    public records?: ReservationStatusNotice[];

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

export enum ReservationStatusNoticeQueryType
{
    ResId = 'ResId',
    ProfileId = 'ProfileId',
    RoomId = 'RoomId',
}

export class ReservationStatusNoticeRequest
{
    public cendynPropertyId?: string;
    public query?: ReservationStatusNoticeQueryType;
    public id?: string;
    public stayDate?: string;

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

TypeScript ReservationStatusNoticeRequest 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/reservation/notice/{Query} HTTP/1.1 
Host: cert.cendyn.com 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ReservationStatusNoticeResponse 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>
    <ReservationStatusNotice>
      <CancellationDate>0001-01-01T00:00:00</CancellationDate>
      <CancellationID>String</CancellationID>
      <CendynPropertyId>String</CendynPropertyId>
      <Currency>String</Currency>
      <DateResUpdated>0001-01-01T00:00:00</DateResUpdated>
      <ExternalProfileID>String</ExternalProfileID>
      <ExternalResId1>String</ExternalResId1>
      <ExternalResId2>String</ExternalResId2>
      <ResArriveDate>0001-01-01T00:00:00</ResArriveDate>
      <ResDepartDate>0001-01-01T00:00:00</ResDepartDate>
      <ResStatus>String</ResStatus>
      <ResUpdatedBy>String</ResUpdatedBy>
      <RoomNumber>String</RoomNumber>
      <RoomNumberEndDate>0001-01-01T00:00:00</RoomNumberEndDate>
      <RoomNumberStartDate>0001-01-01T00:00:00</RoomNumberStartDate>
      <RoomType>String</RoomType>
      <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>
      <UniqueIDs>
        <UniqueIDType>
          <Context>String</Context>
          <ID>String</ID>
          <Type>String</Type>
        </UniqueIDType>
      </UniqueIDs>
    </ReservationStatusNotice>
  </Records>
</ReservationStatusNoticeResponse>