| All Verbs | /PassengerLocationsByAirport |
|---|
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 ItinerarySegment:
segment_type: Optional[str] = None
segment_nbr: int = 0
board_point: Optional[str] = None
off_point: Optional[str] = None
operator_code: Optional[str] = None
operator_service: Optional[str] = None
segment_status: Optional[str] = None
departure_time_formatted: Optional[str] = None
arrival_time_formatted: Optional[str] = None
change_of_day_formatted: Optional[str] = None
service_code: Optional[str] = None
start_date: Optional[str] = None
end_date: Optional[str] = None
ticket_number: Optional[str] = None
vendor_locators: Optional[str] = None
"""
Comma separated list of vendor locators
"""
equipment_code: Optional[str] = None
equipment: Optional[str] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ItinerarySegmentsCollection(List[ItinerarySegment]):
pass
@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 BookingPassengerModel:
first_name: Optional[str] = None
last_name: Optional[str] = None
passenger_data_id: int = 0
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class PassengerLocation(IBookingItinerary, IBookingCustomFields, IBookingIdentifier, ITicketNumbers, IVendorLocators, IPassengerInfo):
record_locator: Optional[str] = None
travel_date: Optional[datetime.datetime] = None
departure_date: Optional[datetime.datetime] = None
board_point: Optional[str] = None
off_point: Optional[str] = None
pnr_ticketed: Optional[str] = None
account: Optional[str] = None
consultant: Optional[str] = None
pax_list: Optional[str] = None
phone_nbr: Optional[str] = None
email_address: Optional[str] = None
destination_cities: Optional[str] = None
connections: Optional[str] = None
carrier_codes: Optional[str] = None
hotels_names: Optional[str] = None
flight_numbers: Optional[str] = None
owning_agency_location_i_d: Optional[str] = None
iata_codes: Optional[str] = None
agentivity_ref: int = 0
itinerary: Optional[ItinerarySegmentsCollection] = None
itinerary_formatted: Optional[str] = None
custom_fields: Optional[CustomFieldsCollection] = None
departure_date_time: Optional[datetime.datetime] = None
current_arrival_date_time: Optional[datetime.datetime] = None
segment_type: Optional[str] = None
air_segment_nbr: Optional[str] = None
pnr_creation_date: Optional[datetime.datetime] = None
ticket_numbers: Optional[List[str]] = None
vendor_locators: Optional[List[BookingExtVendorLocator]] = None
passenger_info: Optional[List[BookingPassengerModel]] = 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 PassengerLocationsByAirportResponseReport(Report[PassengerLocationsByAirportItemResponse, PassengerLocation]):
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 PassengerLocationsByAirportItemResponse(ItemResponse[PassengerLocation, PassengerLocationsByAirportResponseReport]):
pass
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetPassengerLocationsByAirport(CompanyLevelRequestBase, IRepeatByPassenger):
airport_code: Optional[str] = None
"""
Airport code
"""
date_end: Optional[str] = None
"""
Date in format YYYYMMDD
"""
date_start: Optional[str] = None
"""
Date in format YYYYMMDD
"""
in_transit_only: Optional[bool] = None
"""
Include passengers that are in transit only in response
"""
account: Optional[List[str]] = None
"""
Comma Delimited List of Accounts
"""
custom_field: Optional[List[str]] = None
"""
Comma Delimited List of Custom Fields
"""
repeat_by_passenger: bool = False
"""
Option to place passenger names on separate lines in the downloadable result (spreadsheet)
"""
Python GetPassengerLocationsByAirport DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /PassengerLocationsByAirport HTTP/1.1
Host: api.agentivity.com
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length
{"AirportCode":"String","DateEnd":"String","DateStart":"String","InTransitOnly":false,"Account":["String"],"CustomField":["String"],"RepeatByPassenger":false,"OwningCompanyCode":["String"],"UserName":"String","Offset":"String","Limit":"String","TotalRecords":0,"ResponseRecords":0}
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length
{"ResponseMetadata":{"Success":false,"HasCache":false,"HasPaging":false,"CacheMetadata":{"IsFromCache":false,"CachedAt":"\/Date(-62135596800000-0000)\/","CacheExpiresAt":"\/Date(-62135596800000-0000)\/"},"PagingMetadata":{"Offset":"String","Limit":"String","TotalRecords":0,"ResponseRecords":0}},"ResponseReport":{"Item":{"RecordLocator":"String","TravelDate":"\/Date(-62135596800000-0000)\/","DepartureDate":"\/Date(-62135596800000-0000)\/","BoardPoint":"String","OffPoint":"String","PnrTicketed":"String","Account":"String","Consultant":"String","PaxList":"String","PhoneNbr":"String","EmailAddress":"String","DestinationCities":"String","Connections":"String","CarrierCodes":"String","AgentivityRef":0,"HotelsNames":"String","FlightNumbers":"String","OwningAgencyLocationID":"String","IataCodes":"String","Itinerary":[{"SegmentType":"String","SegmentNbr":0,"BoardPoint":"String","OffPoint":"String","OperatorCode":"String","OperatorService":"String","SegmentStatus":"String","DepartureTimeFormatted":"String","ArrivalTimeFormatted":"String","ChangeOfDayFormatted":"String","ServiceCode":"String","StartDate":"String","EndDate":"String","TicketNumber":"String","VendorLocators":"String","EquipmentCode":"String","Equipment":"String"}],"ItineraryFormatted":"String","CustomFields":[{"FieldName":"String","FieldValue":"String"}],"DepartureDateTime":"\/Date(-62135596800000-0000)\/","CurrentArrivalDateTime":"\/Date(-62135596800000-0000)\/","SegmentType":"String","AirSegmentNbr":"String","PNRCreationDate":"\/Date(-62135596800000-0000)\/","TicketNumbers":["String"],"VendorLocators":[{"CarrierCode":"String","VendorLocator":"String"}],"PassengerInfo":[{"FirstName":"String","LastName":"String","PassengerDataId":0,"Tickets":[{"Number":"String","Type":"String"}]}]}},"ResponseError":{"ErrorCode":"String","Message":"String","StatusCode":"String","VerboseMessage":"String"}}