Agentivity API

<back to all web services

GetDistributorBookingsTravellingByAirlineClass

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


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class PagingMetadata:
    # @ApiMember(DataType="string", Description="Starting Record", Name="Offset", ParameterType="query")
    offset: Optional[str] = None
    """
    Starting Record
    """


    # @ApiMember(DataType="string", Description="Number of records to return (PageSize)", Name="Limit", ParameterType="query")
    limit: Optional[str] = None
    """
    Number of records to return (PageSize)
    """


    # @ApiMember(DataType="string", Description="Total Number of Records in a Full Reponse (if no paging)", Name="TotalRecords", ParameterType="query")
    total_records: int = 0
    """
    Total Number of Records in a Full Reponse (if no paging)
    """


    # @ApiMember(DataType="string", Description="Total Number of Records in this Reponse (on this page)", Name="ResponseRecords", ParameterType="query")
    response_records: int = 0
    """
    Total Number of Records in this Reponse (on this page)
    """


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class BookingByAirlineWithClassSupport:
    agentivity_ref: int = 0
    record_locator: Optional[str] = None
    pnr_creation_date: Optional[datetime.datetime] = None
    account: Optional[str] = None
    owning_consultant: Optional[str] = None
    ticketed_status_code: Optional[str] = None
    ticketed_status: Optional[str] = None
    booking_codes_booked: Optional[str] = None
    flight_numbers: Optional[str] = None
    routing: Optional[str] = None
    tracking_code: Optional[str] = None
    tkt_tour_code: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CacheMetadata:
    cached_at: datetime.datetime = datetime.datetime(1, 1, 1)
    cache_expires_at: datetime.datetime = datetime.datetime(1, 1, 1)
    is_from_cache: bool = False


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ResponseMetadata:
    success: bool = False
    has_cache: bool = False
    has_paging: bool = False
    cache_metadata: Optional[CacheMetadata] = None
    paging_metadata: Optional[PagingMetadata] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class AgentivityError:
    error_code: Optional[str] = None
    message: Optional[str] = None
    status_code: Optional[str] = None
    verbose_message: Optional[str] = None


TItem = TypeVar('TItem')
TReport = TypeVar('TReport')


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ItemResponse(Generic[TItem, TReport]):
    response_metadata: Optional[ResponseMetadata] = None
    response_report: Optional[TReport] = None
    response_error: Optional[AgentivityError] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class BookingsByAirlineWithClassSupportItemResponse(ItemResponse[BookingByAirlineWithClassSupport, BookingsByAirlineWithClassSupportResponseReport]):
    pass


TItemResponse = TypeVar('TItemResponse')
TItem = TypeVar('TItem')


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class Report(Generic[TItemResponse, TItem]):
    item: Optional[TItem] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class BookingsByAirlineWithClassSupportResponseReport(Report[BookingsByAirlineWithClassSupportItemResponse, BookingByAirlineWithClassSupport]):
    pass


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class DistributorBookingsByAirlineClassItemResponse(ItemResponse[BookingByAirlineWithClassSupport, BookingsByAirlineWithClassSupportResponseReport]):
    pass


# @Flags()
class FormattingStyle(IntEnum):
    NONE = 0
    HTML = 1
    CHARTING = 2


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetDistributorBookingsTravellingByAirlineClass(PagingMetadata):
    distributor_i_d: int = 0
    """
    ID of Distributor
    """

    issue_date_start: Optional[str] = None
    """
    Date in format YYYYMMDD
    """

    issue_date_end: Optional[str] = None
    """
    Date in format YYYYMMDD
    """

    plating_carrier: Optional[str] = None
    """
    Two letter code for carrier
    """

    booking_class_name: Optional[str] = None
    """
    Booking Class Name
    """

    board_point_country_code: Optional[str] = None
    """
    BoardPoint CountryCode
    """

    include_itinerary: bool = False
    """
    Include Itinerary in the response
    """

    itinerary_formatting: Optional[FormattingStyle] = None
    """
    Indicates the required formatting: 0=None(Default); 1= Html; 2 = Chart
    """

Python GetDistributorBookingsTravellingByAirlineClass DTOs

GET /DistributorBookingsByAirlineClass HTTP/1.1 
Host: servicestack.agentivity.com 
Accept: application/xml

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

<AgentivityResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="schemas.agentivity.com/types">
  <ResponseMetadata>
    <Success>false</Success>
    <HasCache>false</HasCache>
    <HasPaging>false</HasPaging>
    <CacheMetadata>
      <IsFromCache>false</IsFromCache>
      <CachedAt>0001-01-01T00:00:00</CachedAt>
      <CacheExpiresAt>0001-01-01T00:00:00</CacheExpiresAt>
    </CacheMetadata>
    <PagingMetadata>
      <Limit>String</Limit>
      <Offset>String</Offset>
      <ResponseRecords>0</ResponseRecords>
      <TotalRecords>0</TotalRecords>
    </PagingMetadata>
  </ResponseMetadata>
  <ResponseReport>
    <Item>
      <AgentivityRef>0</AgentivityRef>
      <RecordLocator>String</RecordLocator>
      <PNRCreationDate>0001-01-01T00:00:00</PNRCreationDate>
      <Account>String</Account>
      <OwningConsultant>String</OwningConsultant>
      <TicketedStatusCode>String</TicketedStatusCode>
      <TicketedStatus>String</TicketedStatus>
      <BookingCodesBooked>String</BookingCodesBooked>
      <FlightNumbers>String</FlightNumbers>
      <Routing>String</Routing>
      <TrackingCode>String</TrackingCode>
      <TktTourCode>String</TktTourCode>
    </Item>
  </ResponseReport>
  <ResponseError>
    <ErrorCode>String</ErrorCode>
    <Message>String</Message>
    <StatusCode>String</StatusCode>
    <VerboseMessage>String</VerboseMessage>
  </ResponseError>
</AgentivityResponse>