Agentivity API

<back to all web services

SegmentsQC

The following routes are available for this service:
GET/SegmentsQC
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 CompanyLevelRequestBase(PagingMetadata, IMemberUsername, IMemberOwningCompanyCode):
    owning_company_code: Optional[List[str]] = None
    """
    Comma Delimited List of Owning Company Codes
    """

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


class QcCheck(str, Enum):
    MISSING = 'Missing'
    WARNING = 'Warning'
    VALID = 'Valid'
    DENIED = 'Denied'


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class SegmentQC:
    agentivity_ref: int = 0
    record_locator: Optional[str] = None
    owning_consultant: Optional[str] = None
    passenger: Optional[str] = None
    account: Optional[str] = None
    board_point: Optional[str] = None
    off_point: Optional[str] = None
    departure_time: Optional[str] = None
    booking_class: Optional[str] = None
    segment_status: Optional[str] = None
    carrier_code: Optional[str] = None
    flight_nbr: Optional[str] = None
    flight_number_fromatted: Optional[str] = None
    seat_check: Optional[QcCheck] = None
    seat_formatted: Optional[str] = None
    meal_check: Optional[QcCheck] = None
    meal_formatted: Optional[str] = None
    chauffeur_desc: Optional[str] = None
    transfer_desc: Optional[str] = None
    cars_formatted: Optional[str] = None
    hote_check: Optional[QcCheck] = None
    hotels: Optional[str] = None
    shuttle_desc: Optional[str] = None
    tour_desc: Optional[str] = None
    frequent_flyer_numbers: Optional[str] = None
    pnr_ticketed: Optional[str] = None
    ticket_number: Optional[str] = None
    comments: Optional[str] = None
    ops_comments: Optional[str] = None
    is_vip: bool = False
    corporate_f_fs: Optional[str] = None
    vendor_locator: 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 SegmentsQCResponseReport(Report[SegmentsQCItemResponse, SegmentQC]):
    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 SegmentsQCItemResponse(ItemResponse[SegmentQC, SegmentsQCResponseReport]):
    pass


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class SegmentsQC(CompanyLevelRequestBase):
    account: Optional[List[str]] = None
    """
    Comma Delimited List of Accounts
    """

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

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

    vip_only: bool = False
    """
    Return only segments that are flagged as VIP only
    """

Python SegmentsQC DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /SegmentsQC 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>
      <AgentivityRef>0</AgentivityRef>
      <RecordLocator>String</RecordLocator>
      <OwningConsultant>String</OwningConsultant>
      <Passenger>String</Passenger>
      <Account>String</Account>
      <BoardPoint>String</BoardPoint>
      <OffPoint>String</OffPoint>
      <DepartureTime>String</DepartureTime>
      <BookingClass>String</BookingClass>
      <SegmentStatus>String</SegmentStatus>
      <CarrierCode>String</CarrierCode>
      <FlightNbr>String</FlightNbr>
      <FlightNumberFromatted>String</FlightNumberFromatted>
      <SeatCheck>Missing</SeatCheck>
      <SeatFormatted>String</SeatFormatted>
      <MealCheck>Missing</MealCheck>
      <MealFormatted>String</MealFormatted>
      <ChauffeurDesc>String</ChauffeurDesc>
      <TransferDesc>String</TransferDesc>
      <CarsFormatted>String</CarsFormatted>
      <HoteCheck>Missing</HoteCheck>
      <Hotels>String</Hotels>
      <ShuttleDesc>String</ShuttleDesc>
      <TourDesc>String</TourDesc>
      <FrequentFlyerNumbers>String</FrequentFlyerNumbers>
      <PnrTicketed>String</PnrTicketed>
      <TicketNumber>String</TicketNumber>
      <Comments>String</Comments>
      <OpsComments>String</OpsComments>
      <IsVip>false</IsVip>
      <CorporateFFs>String</CorporateFFs>
      <VendorLocator>String</VendorLocator>
    </Item>
  </ResponseReport>
  <ResponseError>
    <ErrorCode>String</ErrorCode>
    <Message>String</Message>
    <StatusCode>String</StatusCode>
    <VerboseMessage>String</VerboseMessage>
  </ResponseError>
</AgentivityResponse>