CenResService

<back to all web services

ResSummaryRequest

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 ReservationSummary:
    first_name: Optional[str] = None
    last_name: Optional[str] = None
    external_profile_id: Optional[str] = None
    external_profile_id2: Optional[str] = None
    external_res_i_d1: Optional[str] = None
    external_res_i_d2: Optional[str] = None
    cendyn_property_id: Optional[str] = None
    property_name: Optional[str] = None
    res_type_code: Optional[str] = None
    res_status_code: Optional[str] = None
    confirmation_num: Optional[str] = None
    central_res_num: Optional[str] = None
    res_arrive_date: Optional[datetime.datetime] = None
    res_depart_date: Optional[datetime.datetime] = None
    num_rooms: Optional[int] = None
    room_type_code: Optional[str] = None
    room_number: Optional[str] = None
    rate_code: Optional[str] = None
    market_segment_code: Optional[str] = None
    market_code_category: Optional[str] = None
    market_region_code: Optional[str] = None
    company_name: Optional[str] = None
    num_adults: Optional[int] = None
    num_youths: Optional[int] = None
    num_children: Optional[int] = None
    total_room_nights: Optional[int] = None
    cancellation_i_d: Optional[str] = None
    cancellation_date: Optional[datetime.datetime] = None
    total_other_revenue: Optional[Decimal] = None
    total_room_revenue: Optional[Decimal] = None
    total_tax: Optional[Decimal] = None
    total_revenue: Optional[Decimal] = None
    last_updated: Optional[datetime.datetime] = None


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


class ReservationQueryType(str, Enum):
    RES_ID = 'ResId'
    PROFILE_ID = 'ProfileId'
    NAME = 'Name'
    LAST_UPDATED = 'LastUpdated'
    ARRIVAL_DATE = 'ArrivalDate'
    DEPARTURE_DATE = 'DepartureDate'
    STAY_DATE = 'StayDate'
    DATE_P_M_S_RES_UPDATED = 'DatePMSResUpdated'


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ResSummaryRequest:
    cendyn_property_id: Optional[str] = None
    query: Optional[ReservationQueryType] = None
    id: Optional[str] = None
    first_name: Optional[str] = None
    last_name: Optional[str] = None
    start_date: Optional[datetime.datetime] = None
    end_date: Optional[datetime.datetime] = None
    page_size: Optional[int] = None
    page_number: Optional[int] = None

Python ResSummaryRequest DTOs

GET /v2/reservation/summary/{Query} HTTP/1.1 
Host: cert.cendyn.com 
Accept: application/xml

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ResSummaryResponse 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 xmlns:d2p1="http://schemas.datacontract.org/2004/07/Cendyn.CenRes.DataLib.ViewModels">
    <d2p1:ReservationSummary>
      <d2p1:CancellationDate>0001-01-01T00:00:00</d2p1:CancellationDate>
      <d2p1:CancellationID>String</d2p1:CancellationID>
      <d2p1:CendynPropertyId>String</d2p1:CendynPropertyId>
      <d2p1:CentralResNum>String</d2p1:CentralResNum>
      <d2p1:CompanyName>String</d2p1:CompanyName>
      <d2p1:ConfirmationNum>String</d2p1:ConfirmationNum>
      <d2p1:ExternalProfileId>String</d2p1:ExternalProfileId>
      <d2p1:ExternalProfileId2>String</d2p1:ExternalProfileId2>
      <d2p1:ExternalResID1>String</d2p1:ExternalResID1>
      <d2p1:ExternalResID2>String</d2p1:ExternalResID2>
      <d2p1:FirstName>String</d2p1:FirstName>
      <d2p1:LastName>String</d2p1:LastName>
      <d2p1:LastUpdated>0001-01-01T00:00:00</d2p1:LastUpdated>
      <d2p1:MarketCodeCategory>String</d2p1:MarketCodeCategory>
      <d2p1:MarketRegionCode>String</d2p1:MarketRegionCode>
      <d2p1:MarketSegmentCode>String</d2p1:MarketSegmentCode>
      <d2p1:NumAdults>0</d2p1:NumAdults>
      <d2p1:NumChildren>0</d2p1:NumChildren>
      <d2p1:NumRooms>0</d2p1:NumRooms>
      <d2p1:NumYouths>0</d2p1:NumYouths>
      <d2p1:PropertyName>String</d2p1:PropertyName>
      <d2p1:RateCode>String</d2p1:RateCode>
      <d2p1:ResArriveDate>0001-01-01T00:00:00</d2p1:ResArriveDate>
      <d2p1:ResDepartDate>0001-01-01T00:00:00</d2p1:ResDepartDate>
      <d2p1:ResStatusCode>String</d2p1:ResStatusCode>
      <d2p1:ResTypeCode>String</d2p1:ResTypeCode>
      <d2p1:RoomNumber>String</d2p1:RoomNumber>
      <d2p1:RoomTypeCode>String</d2p1:RoomTypeCode>
      <d2p1:TotalOtherRevenue>0</d2p1:TotalOtherRevenue>
      <d2p1:TotalRevenue>0</d2p1:TotalRevenue>
      <d2p1:TotalRoomNights>0</d2p1:TotalRoomNights>
      <d2p1:TotalRoomRevenue>0</d2p1:TotalRoomRevenue>
      <d2p1:TotalTax>0</d2p1:TotalTax>
    </d2p1:ReservationSummary>
  </Records>
</ResSummaryResponse>