Agentivity API

<back to all web services

GetPassengerLocationsByFlightNumber

The following routes are available for this service:
GET/PassengerLocationsByFlightNumber
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
    """


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CustomFieldData:
    field_name: Optional[str] = None
    field_value: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CustomFieldsCollection(List[CustomFieldData]):
    pass


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class BookingExtVendorLocator(IBookingIdentifier):
    carrier_code: Optional[str] = None
    vendor_locator: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class PassengerLocationFlightNumber(IBookingCustomFields, IBookingIdentifier, ITicketNumbers, IVendorLocators):
    agentivity_ref: int = 0
    record_locator: Optional[str] = None
    pax_list: Optional[str] = None
    owning_consultant_i_d: Optional[str] = None
    account: Optional[str] = None
    departure_date: Optional[datetime.datetime] = None
    board_point: Optional[str] = None
    off_point: Optional[str] = None
    departure_time: Optional[str] = None
    arrival_time: Optional[str] = None
    change_of_day: Optional[str] = None
    email_address: Optional[str] = None
    phone_nbr: Optional[str] = None
    owning_agency_location_i_d: Optional[str] = None
    iata_codes: Optional[str] = None
    custom_fields: Optional[CustomFieldsCollection] = None
    pnr_creation_date: Optional[datetime.datetime] = None
    ticket_numbers: Optional[List[str]] = None
    vendor_locators: Optional[List[BookingExtVendorLocator]] = 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 PassengerLocationsByFlightNumberResponseReport(Report[PassengerLocationsByFlightNumberItemResponse, PassengerLocationFlightNumber]):
    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 PassengerLocationsByFlightNumberItemResponse(ItemResponse[PassengerLocationFlightNumber, PassengerLocationsByFlightNumberResponseReport]):
    pass


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetPassengerLocationsByFlightNumber(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
    """

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

    flight_number: Optional[str] = None
    """
    Flight number without spaces
    """

    all_future_date: bool = False
    """
    All future date
    """

    custom_field: Optional[List[str]] = None
    """
    Comma Delimited List of Custom Fields
    """

Python GetPassengerLocationsByFlightNumber 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 /PassengerLocationsByFlightNumber 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>
      <PaxList>String</PaxList>
      <OwningConsultantID>String</OwningConsultantID>
      <Account>String</Account>
      <DepartureDate>0001-01-01T00:00:00</DepartureDate>
      <BoardPoint>String</BoardPoint>
      <OffPoint>String</OffPoint>
      <DepartureTime>String</DepartureTime>
      <ArrivalTime>String</ArrivalTime>
      <ChangeOfDay>String</ChangeOfDay>
      <EmailAddress>String</EmailAddress>
      <PhoneNbr>String</PhoneNbr>
      <OwningAgencyLocationID>String</OwningAgencyLocationID>
      <IataCodes>String</IataCodes>
      <CustomFields>
        <CustomField>
          <FieldName>String</FieldName>
          <FieldValue>String</FieldValue>
        </CustomField>
      </CustomFields>
      <PNRCreationDate>0001-01-01T00:00:00</PNRCreationDate>
      <TicketNumbers xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>String</d4p1:string>
      </TicketNumbers>
      <VendorLocators>
        <VendorLocator>
          <CarrierCode>String</CarrierCode>
          <VendorLocator>String</VendorLocator>
        </VendorLocator>
      </VendorLocators>
    </Item>
  </ResponseReport>
  <ResponseError>
    <ErrorCode>String</ErrorCode>
    <Message>String</Message>
    <StatusCode>String</StatusCode>
    <VerboseMessage>String</VerboseMessage>
  </ResponseError>
</AgentivityResponse>