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

{"records":[{"cendynPropertyId":"String","externalResId1":"String","externalResId2":"String","resStatus":"String","cancellationID":"String","cancellationDate":"0001-01-01T00:00:00.0000000","dateResUpdated":"0001-01-01T00:00:00.0000000","resUpdatedBy":"String","roomNumber":"String","roomNumberStartDate":"0001-01-01T00:00:00.0000000","roomNumberEndDate":"0001-01-01T00:00:00.0000000","stayHistoryRevenueCollection":[{"recordStatus":"String","revenueGroup":"String","revenueType":"String","amount":0,"currencyCode":"String","folioWindow":"String","transactionDate":"0001-01-01T00:00:00.0000000","inactiveDate":"0001-01-01T00:00:00.0000000"}],"resArriveDate":"0001-01-01T00:00:00.0000000","resDepartDate":"0001-01-01T00:00:00.0000000","currency":"String","roomType":"String","externalProfileID":"String","uniqueIDs":[{"id":"String","type":"String","context":"String"}]}],"status":"Success","statusMessage":"String","recordsReturned":0,"recordsAvailable":0,"pageNumber":0,"pageSize":0}