CenResService

ResSummaryRequest

The following routes are available for this service:
GET	/v2/reservation/summary/{Query}
GET	/v2/reservation/summary/{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 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

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/reservation/summary/{Query} HTTP/1.1 
Host: cert.cendyn.com 
Accept: application/json

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

{"records":[{"firstName":"String","lastName":"String","externalProfileId":"String","externalProfileId2":"String","externalResID1":"String","externalResID2":"String","cendynPropertyId":"String","propertyName":"String","resTypeCode":"String","resStatusCode":"String","confirmationNum":"String","centralResNum":"String","resArriveDate":"0001-01-01T00:00:00.0000000","resDepartDate":"0001-01-01T00:00:00.0000000","numRooms":0,"roomTypeCode":"String","roomNumber":"String","rateCode":"String","marketSegmentCode":"String","marketCodeCategory":"String","marketRegionCode":"String","companyName":"String","numAdults":0,"numYouths":0,"numChildren":0,"totalRoomNights":0,"cancellationID":"String","cancellationDate":"0001-01-01T00:00:00.0000000","totalOtherRevenue":0,"totalRoomRevenue":0,"totalTax":0,"totalRevenue":0,"lastUpdated":"0001-01-01T00:00:00.0000000"}],"status":"Success","statusMessage":"String","recordsReturned":0,"recordsAvailable":0,"pageNumber":0,"pageSize":0}