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}
import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


class RequestStatus(str, Enum):
    SUCCESS = 'Success'
    WARNING = 'Warning'
    ERROR = 'Error'
    NOT_AUTHORIZED = 'NotAuthorized'
    FAILURE = 'Failure'


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CenResResponse:
    status: Optional[RequestStatus] = None
    status_message: Optional[str] = None
    records_returned: Optional[int] = None
    records_available: Optional[int] = None
    page_number: Optional[int] = None
    page_size: Optional[int] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class StayHistoryRevenue:
    record_status: Optional[str] = None
    revenue_group: Optional[str] = None
    revenue_type: Optional[str] = None
    amount: Optional[Decimal] = None
    currency_code: Optional[str] = None
    folio_window: Optional[str] = None
    transaction_date: Optional[datetime.datetime] = None
    inactive_date: Optional[datetime.datetime] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class UniqueIDType:
    id: Optional[str] = None
    type: Optional[str] = None
    context: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ReservationStatusNotice:
    cendyn_property_id: Optional[str] = None
    external_res_id1: Optional[str] = None
    external_res_id2: Optional[str] = None
    res_status: Optional[str] = None
    cancellation_i_d: Optional[str] = None
    cancellation_date: Optional[datetime.datetime] = None
    date_res_updated: Optional[datetime.datetime] = None
    res_updated_by: Optional[str] = None
    room_number: Optional[str] = None
    room_number_start_date: Optional[datetime.datetime] = None
    room_number_end_date: Optional[datetime.datetime] = None
    stay_history_revenue_collection: Optional[List[StayHistoryRevenue]] = None
    res_arrive_date: Optional[datetime.datetime] = None
    res_depart_date: Optional[datetime.datetime] = None
    currency: Optional[str] = None
    room_type: Optional[str] = None
    external_profile_i_d: Optional[str] = None
    unique_i_ds: Optional[List[UniqueIDType]] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ReservationStatusNoticeResponse(CenResResponse):
    records: Optional[List[ReservationStatusNotice]] = None


class ReservationStatusNoticeQueryType(str, Enum):
    RES_ID = 'ResId'
    PROFILE_ID = 'ProfileId'
    ROOM_ID = 'RoomId'


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ReservationStatusNoticeRequest:
    cendyn_property_id: Optional[str] = None
    query: Optional[ReservationStatusNoticeQueryType] = None
    id: Optional[str] = None
    stay_date: Optional[datetime.datetime] = None

Python 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>