| GET | /EventBookings |
|---|
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 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 EventBooking(IBookingItinerary):
record_locator: Optional[str] = None
pnr_creation_date: datetime.datetime = datetime.datetime(1, 1, 1)
pax_list: Optional[str] = None
pax_count: int = 0
inbound_airline: Optional[str] = None
inbound_flight_number: Optional[str] = None
inbound_arrival_city: Optional[str] = None
inbound_arrival_date: Optional[datetime.datetime] = None
inbound_arrival_time: Optional[str] = None
outbound_airline: Optional[str] = None
outbound_flight_number: Optional[str] = None
outbound_departure_city: Optional[str] = None
outbound_departure_date: Optional[datetime.datetime] = None
outbound_departure_time: Optional[str] = None
notes: Optional[str] = None
emails: Optional[str] = None
mobile: Optional[str] = None
total_ticketed_value: Optional[str] = None
agentivity_ref: int = 0
itinerary_formatted: Optional[str] = None
itinerary: Optional[ItinerarySegmentsCollection] = 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 EventBookingsResponseReport(Report[EventBookingsItemResponse, EventBooking]):
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 EventBookingsItemResponse(ItemResponse[EventBooking, EventBookingsResponseReport]):
pass
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class EventBookingsRequest(PagingMetadata):
user_name: Optional[str] = None
"""
UserName in form of an email address
"""
event_code: Optional[str] = None
"""
Event code
"""
split_multiple_passengers: bool = False
"""
Split multiple passengers
"""
include_notes: bool = False
"""
Include notes in the response
"""
include_arrival_departures: bool = False
"""
Include arrival departures
"""
formatting_style: int = 0
"""
Indicate the required formatting: 0=None(Default), 1=Html, 2=Chart
"""
itinerary_segments_to_show: Optional[str] = None
"""
Itinerary segments to show
"""
Python EventBookingsRequest 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.
GET /EventBookings 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":{"Item":{"RecordLocator":"String","PNRCreationDate":"\/Date(-62135596800000-0000)\/","PaxList":"String","PaxCount":0,"AgentivityRef":0,"ItineraryFormatted":"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"}],"InboundAirline":"String","InboundFlightNumber":"String","InboundArrivalCity":"String","InboundArrivalDate":"\/Date(-62135596800000-0000)\/","InboundArrivalTime":"String","OutboundAirline":"String","OutboundFlightNumber":"String","OutboundDepartureCity":"String","OutboundDepartureDate":"\/Date(-62135596800000-0000)\/","OutboundDepartureTime":"String","Notes":"String","Emails":"String","Mobile":"String","TotalTicketedValue":"String"}},"ResponseError":{"ErrorCode":"String","Message":"String","StatusCode":"String","VerboseMessage":"String"}}