| GET | /PNRSegments |
|---|
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 HostSystem:
vendor: Optional[str] = None
vendor_locator: Optional[str] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class AirlineReferences(List[HostSystem]):
pass
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class PassengerName:
last_name: Optional[str] = None
first_name: Optional[str] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class Coupon:
coupon_sequence_nbr: Optional[str] = None
coupon_board_point: Optional[str] = None
coupon_off_point: Optional[str] = None
carrier: Optional[str] = None
flight_nbr: Optional[str] = None
flight_date: Optional[str] = None
flight_time: Optional[str] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class Coupons(List[Coupon]):
pass
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class PNRSummaryTicket:
tkt_number: Optional[str] = None
passenger: Optional[PassengerName] = None
coupons: Optional[Coupons] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class PNRSummaryTickets(List[PNRSummaryTicket]):
pass
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class PNRSummary:
record_locator: Optional[str] = None
airline_references: Optional[AirlineReferences] = None
tickets: Optional[PNRSummaryTickets] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class Seat:
seat_location: Optional[str] = None
seat_status_code: Optional[str] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class SeatingData(List[Seat]):
pass
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class AirSegment:
air_segment_nbr: int = 0
segment_status: Optional[str] = None
departure_date: Optional[str] = None
departure_time: Optional[str] = None
carrier_code: Optional[str] = None
board_point: Optional[str] = None
off_point: Optional[str] = None
flight_nbr: Optional[str] = None
booking_code: Optional[str] = None
arrival_time: Optional[str] = None
change_of_day: Optional[str] = None
connection_indicator: Optional[str] = None
operating_carrier_code: Optional[str] = None
operating_carrier_name: Optional[str] = None
journey_time: Optional[str] = None
nbr_seats: int = 0
seating_data: Optional[SeatingData] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CarSegment:
car_segment_nbr: int = 0
segment_status: Optional[str] = None
pick_up_date: Optional[str] = None
pick_up_time: Optional[str] = None
airport_code: Optional[str] = None
car_location_category: Optional[str] = None
drop_off_date: Optional[str] = None
drop_off_time: Optional[str] = None
confirmation_nbr: Optional[str] = None
car_vendor_code: Optional[str] = None
car_rate_type: Optional[str] = None
car_rate_code: Optional[str] = None
car_type: Optional[str] = None
car_yield_management_nbr: Optional[str] = None
rate_amount: Optional[str] = None
rate_guarantee_indicator: Optional[str] = None
miles_kilometer_indicator: Optional[str] = None
distance_allowance: Optional[str] = None
distance_rate_amount: Optional[str] = None
currency_code: Optional[str] = None
nbr_of_cars: int = 0
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class HotelSegmentDepreciated:
hotel_segment_nbr: Optional[str] = None
status_code: Optional[str] = None
arrival_date: Optional[str] = None
departure_date: Optional[str] = None
property_name: Optional[str] = None
confirmation_nbr: Optional[str] = None
currency: Optional[str] = None
rate: Optional[str] = None
room_booking_code: Optional[str] = None
nbr_nights: int = 0
multi_level_rate_code: Optional[str] = None
nbr_rooms: int = 0
booked_in_name: Optional[str] = None
service_information: Optional[str] = None
property_city_code: Optional[str] = None
segment_status: Optional[str] = None
hotel_vendor_code: Optional[str] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class PassiveSegment:
segment_status: Optional[str] = None
start_date: Optional[str] = None
departure_date: Optional[str] = None
nbr_nights: Optional[str] = None
vendor_code: Optional[str] = None
city_code: Optional[str] = None
segment_type: Optional[str] = None
text: Optional[str] = None
passenger: Optional[str] = None
address: Optional[str] = None
booking_reason_code: Optional[str] = None
booking_source: Optional[str] = None
commission_information: Optional[str] = None
confirmation_number: Optional[str] = None
rate_code: Optional[str] = None
rate_quoted: Optional[str] = None
rate_access_code: Optional[str] = None
property_name: Optional[str] = None
property_number: Optional[str] = None
service_information: Optional[str] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class Segments:
air_segments: Optional[List[AirSegment]] = None
car_segments: Optional[List[CarSegment]] = None
hotel_segments: Optional[List[HotelSegmentDepreciated]] = None
passive_segments: Optional[List[PassiveSegment]] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class PNRSegments:
summary: Optional[PNRSummary] = None
segments: Optional[Segments] = 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 ApiRequestPerHour:
request_date: datetime.datetime = datetime.datetime(1, 1, 1)
hour0: int = 0
hour1: int = 0
hour2: int = 0
hour3: int = 0
hour4: int = 0
hour5: int = 0
hour6: int = 0
hour7: int = 0
hour8: int = 0
hour9: int = 0
hour10: int = 0
hour11: int = 0
hour12: int = 0
hour13: int = 0
hour14: int = 0
hour15: int = 0
hour16: int = 0
hour17: int = 0
hour18: int = 0
hour19: int = 0
hour20: int = 0
hour21: int = 0
hour22: int = 0
hour23: int = 0
@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')
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CollectionResponse(Generic[TItem]):
response_metadata: Optional[ResponseMetadata] = None
response_report: Optional[List[ApiRequestPerHour]] = None
response_error: Optional[AgentivityError] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetPNRSegmentsResponse(CollectionResponse[PNRSegments]):
pass
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetPNRSegments(PagingMetadata):
record_locator: Optional[str] = None
"""
Record locator
"""
pnr_creation_date: Optional[str] = None
"""
Date in format YYYYMMDD
"""
segment_type: Optional[List[str]] = None
"""
Type of segment
"""
passive_segment_type: Optional[List[str]] = None
"""
Type of passive segment
"""
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.
GET /PNRSegments HTTP/1.1 Host: api.agentivity.com Accept: text/jsonl
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":[{"Summary":{"RecordLocator":"String","AirlineReferences":[{"Vendor":"String","VendorLocator":"String"}],"Tickets":[{"TktNumber":"String","Passenger":{"LastName":"String","FirstName":"String"},"Coupons":[{"CouponSequenceNbr":"String","CouponBoardPoint":"String","CouponOffPoint":"String","Carrier":"String","FlightNbr":"String","FlightDate":"String","FlightTime":"String"}]}]},"Segments":{"AirSegments":[{"AirSegmentNbr":0,"SegmentStatus":"String","DepartureDate":"String","DepartureTime":"String","CarrierCode":"String","BoardPoint":"String","OffPoint":"String","FlightNbr":"String","BookingCode":"String","ArrivalTime":"String","ChangeOfDay":"String","ConnectionIndicator":"String","OperatingCarrierCode":"String","OperatingCarrierName":"String","JourneyTime":"String","NbrSeats":0,"SeatingData":[{"SeatLocation":"String","SeatStatusCode":"String"}]}],"CarSegments":[{"CarSegmentNbr":0,"SegmentStatus":"String","PickUpDate":"String","PickUpTime":"String","AirportCode":"String","CarLocationCategory":"String","DropOffDate":"String","DropOffTime":"String","ConfirmationNbr":"String","CarVendorCode":"String","CarRateType":"String","CarRateCode":"String","CarType":"String","CarYieldManagementNbr":"String","RateAmount":"String","RateGuaranteeIndicator":"String","MilesKilometerIndicator":"String","DistanceAllowance":"String","DistanceRateAmount":"String","CurrencyCode":"String","NbrOfCars":0}],"HotelSegments":[{"HotelSegmentNbr":"String","StatusCode":"String","ArrivalDate":"String","DepartureDate":"String","PropertyName":"String","ConfirmationNbr":"String","Currency":"String","Rate":"String","RoomBookingCode":"String","NbrNights":0,"MultiLevelRateCode":"String","NbrRooms":0,"BookedInName":"String","ServiceInformation":"String","PropertyCityCode":"String","SegmentStatus":"String","HotelVendorCode":"String"}],"PassiveSegments":[{"SegmentStatus":"String","StartDate":"String","DepartureDate":"String","NbrNights":"String","VendorCode":"String","CityCode":"String","SegmentType":"String","Text":"String","Passenger":"String","Address":"String","BookingReasonCode":"String","BookingSource":"String","CommissionInformation":"String","ConfirmationNumber":"String","RateCode":"String","RateQuoted":"String","RateAccessCode":"String","PropertyName":"String","PropertyNumber":"String","ServiceInformation":"String"}]}}],"ResponseError":{"ErrorCode":"String","Message":"String","StatusCode":"String","VerboseMessage":"String"}}