| GET | /TravelHistorySummary/Traveller |
|---|
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 TravelHistorySummaryV3:
average_itinerary_changes: float = 0.0
bookings_made: int = 0
countries_visited: Optional[str] = None
trip_classes: Optional[str] = None
bookings_cancelled: int = 0
air_suppliers_used: Optional[str] = None
ticketed: int = 0
hotel_chains_used: Optional[str] = None
advance_purchase_average_days: int = 0
car_suppliers_used: Optional[str] = None
top_air_supplier_support: Optional[str] = None
top_departure_airports: Optional[str] = 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 TravellerHistoryResponse(CollectionResponse[TravelHistorySummaryV3]):
pass
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetTravelHistorySummaryByTraveller(CompanyLevelRequestBase, IRequestConsultantID):
pnr_ticketed: Optional[str] = None
"""
Return only PNRs that are ticketed/all
"""
traveller_reference: Optional[str] = None
"""
Traveller CRM ID or reference
"""
traveller_g_u_i_d: Optional[str] = None
"""
Agentivity Traveller GUID
"""
traveller_email: Optional[str] = None
"""
An email of a traveller
"""
traveller_phone_nbr: Optional[str] = None
"""
Traveller phone number
"""
travel_date_start: Optional[str] = None
"""
Date in format YYYYMMDD
"""
travel_date_end: Optional[str] = None
"""
Date in format YYYYMMDD
"""
crm: Optional[str] = None
"""
CRM System Name used by Agency
"""
request_consultant_i_d: Optional[str] = None
"""
Request Consultant ID (sign on)
"""
Python GetTravelHistorySummaryByTraveller DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /TravelHistorySummary/Traveller HTTP/1.1 Host: api.agentivity.com Accept: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
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":[{"AverageItineraryChanges":0,"BookingsMade":0,"CountriesVisited":"String","TripClasses":"String","BookingsCancelled":0,"AirSuppliersUsed":"String","Ticketed":0,"HotelChainsUsed":"String","AdvancePurchaseAverageDays":0,"CarSuppliersUsed":"String","TopAirSupplierSupport":"String","TopDepartureAirports":"String"}],"ResponseError":{"ErrorCode":"String","Message":"String","StatusCode":"String","VerboseMessage":"String"}}