Agentivity API

<back to all web services

GetCompanyTicketRevenuePerAirline

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 AirlineTicketRevenue:
    plating_carrier: Optional[str] = None
    airline_short_name: Optional[str] = None
    total_fares: Optional[Decimal] = None
    total_tax: Optional[Decimal] = None
    total_base_revenue: Optional[Decimal] = None
    formatted_carrier_plating_name: Optional[str] = None
    printed_currency: Optional[str] = None
    formatted_total_fares: Optional[str] = None
    formatted_total_tax: Optional[str] = None
    formatted_total_base_revenue: Optional[str] = None


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 AirlineTicketRevenuesResponseReport(Report[AirlineTicketRevenuesItemResponse, AirlineTicketRevenue]):
    pass


@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 AirlineTicketRevenuesItemResponse(ItemResponse[AirlineTicketRevenue, AirlineTicketRevenuesResponseReport]):
    pass


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetCompanyTicketRevenuePerAirline(PagingMetadata):
    travel_agent_i_d: Optional[str] = None
    """
    ID of a travel agent
    """

    plating_carrier: Optional[str] = None
    """
    Code for Plating Carrier
    """

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

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

    flight_coupon_status: Optional[str] = None
    """
    One letter code for flight coupon status
    """

    user_name: Optional[str] = None
    """
    UserName in form of an email address
    """

    airline_code: Optional[str] = None
    """
    Two letter airline code
    """

Python GetCompanyTicketRevenuePerAirline DTOs

GET /AirlineTicketRevenues HTTP/1.1 
Host: api.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>
      <PlatingCarrier>String</PlatingCarrier>
      <AirlineShortName>String</AirlineShortName>
      <TotalFares>0</TotalFares>
      <TotalTax>0</TotalTax>
      <TotalBaseRevenue>0</TotalBaseRevenue>
      <FormattedCarrierPlatingName>String</FormattedCarrierPlatingName>
      <PrintedCurrency>String</PrintedCurrency>
      <FormattedTotalFares>String</FormattedTotalFares>
      <FormattedTotalTax>String</FormattedTotalTax>
      <FormattedTotalBaseRevenue>String</FormattedTotalBaseRevenue>
    </Item>
  </ResponseReport>
  <ResponseError>
    <ErrorCode>String</ErrorCode>
    <Message>String</Message>
    <StatusCode>String</StatusCode>
    <VerboseMessage>String</VerboseMessage>
  </ResponseError>
</AgentivityResponse>