| All Verbs | /ConsultantFocus |
|---|
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 ProblematicSegment:
record_locator: Optional[str] = None
pnr_creation_date: Optional[datetime.datetime] = None
owning_consultant_i_d: Optional[str] = None
owning_consultant: Optional[str] = None
primary_pax: Optional[str] = None
account: Optional[str] = None
segment_status: Optional[str] = None
segment: Optional[str] = None
owning_agency_location_i_d: Optional[str] = None
gds_code: Optional[str] = None
departure_date: Optional[datetime.datetime] = None
agentivity_ref: Optional[str] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class AirlineDemandsForTicketing:
record_locator: Optional[str] = None
pnr_creation_date: Optional[datetime.datetime] = None
primary_pax: Optional[str] = None
owning_consultant_i_d: Optional[str] = None
owning_consultant: Optional[str] = None
account: Optional[str] = None
airline_code: Optional[str] = None
due_date: Optional[datetime.datetime] = None
due_time: Optional[str] = None
owning_agency_location_i_d: Optional[str] = None
gds_code: Optional[str] = None
agentivity_ref: Optional[int] = None
@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 ActiveUnsoldAirBookings(IBookingItinerary):
record_locator: Optional[str] = None
pnr_creation_date: Optional[datetime.datetime] = None
owning_agency_location_i_d: Optional[str] = None
gds_code: Optional[str] = None
primary_pax: Optional[str] = None
owning_consultant: Optional[str] = None
owning_consultant_i_d: Optional[str] = None
account: Optional[str] = None
primary_carrier_code: Optional[str] = None
filed_fare: Optional[str] = None
travel_date: Optional[datetime.datetime] = None
destination_cities: Optional[str] = None
booking_classes: Optional[str] = None
agentivity_ref: int = 0
itinerary: Optional[ItinerarySegmentsCollection] = None
itinerary_formatted: Optional[str] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class BookingWarningProperty:
name: Optional[str] = None
value: Optional[str] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class BookingWarning:
warning_type: Optional[str] = None
vendor: Optional[str] = None
vendor_type: Optional[str] = None
warning_date_time: Optional[datetime.datetime] = None
log_date_time: Optional[datetime.datetime] = None
original_remark: Optional[str] = None
properties_list: Optional[List[BookingWarningProperty]] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class BookingWithWarnings:
record_locator: Optional[str] = None
pnr_creation_date: datetime.datetime = datetime.datetime(1, 1, 1)
agentivity_ref: int = 0
owning_consultant: Optional[str] = None
account: Optional[str] = None
owning_consultant_i_d: Optional[str] = None
owning_agency_location_i_d: Optional[str] = None
gds_code: Optional[str] = None
travel_date: Optional[datetime.datetime] = None
primary_pax: Optional[str] = None
warnings_list: Optional[List[BookingWarning]] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ConsultantFocusResult:
problematic_segments: Optional[List[ProblematicSegment]] = None
airline_demands_for_ticketing: Optional[List[AirlineDemandsForTicketing]] = None
active_unsold_air_bookings: Optional[List[ActiveUnsoldAirBookings]] = None
bookings_with_warnings: Optional[List[BookingWithWarnings]] = 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 GetConsultantFocusResponse(CollectionResponse[ConsultantFocusResult]):
pass
# @Flags()
class ConsultantFocusOptions(IntEnum):
DEFAULT = 0
PROBLEMATIC_SEGMENTS = 1
AIRLINE_DEMANDS_FOR_TICKETING = 2
STANDARD = 3
ACTIVE_UNSOLD_AIR_BOOKINGS = 4
BOOKINGS_WITH_WARNINGS = 8
ALL = 15
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetConsultantFocus(CompanyLevelRequestBase, IRequestConsultantID):
date_start: Optional[str] = None
"""
Date in format YYYYMMDD
"""
date_end: Optional[str] = None
"""
Date in format YYYYMMDD
"""
owning_consultant_i_d: List[str] = field(default_factory=list)
"""
Comma delimited list of owning consultants ids
"""
transaction_agency_location_i_d: Optional[List[str]] = None
"""
Comma delimited list of transaction agency location ids
"""
options: Optional[ConsultantFocusOptions] = None
"""
Options to retrieve consultant focus data. Use All to include the Active Unsold Air Bookings.
"""
request_consultant_i_d: Optional[str] = None
"""
Request Consultant ID (sign on)
"""
Python GetConsultantFocus DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json
To embed the response in a jsonp callback, append ?callback=myCallback
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /ConsultantFocus HTTP/1.1
Host: api.agentivity.com
Accept: application/json
Content-Type: application/json
Content-Length: length
{"DateStart":"String","DateEnd":"String","OwningConsultantID":["String"],"TransactionAgencyLocationID":["String"],"Options":0,"RequestConsultantID":"String","OwningCompanyCode":["String"],"UserName":"String","Offset":"String","Limit":"String","TotalRecords":0,"ResponseRecords":0}
HTTP/1.1 200 OK
Content-Type: application/json
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":[{"ProblematicSegments":[{"RecordLocator":"String","PNRCreationDate":"\/Date(-62135596800000-0000)\/","OwningConsultantID":"String","OwningConsultant":"String","PrimaryPax":"String","Account":"String","SegmentStatus":"String","Segment":"String","OwningAgencyLocationID":"String","GdsCode":"String","DepartureDate":"\/Date(-62135596800000-0000)\/","AgentivityRef":"String"}],"AirlineDemandsForTicketing":[{"RecordLocator":"String","PNRCreationDate":"\/Date(-62135596800000-0000)\/","PrimaryPax":"String","OwningConsultantID":"String","OwningConsultant":"String","Account":"String","AirlineCode":"String","DueDate":"\/Date(-62135596800000-0000)\/","DueTime":"String","OwningAgencyLocationID":"String","GdsCode":"String","AgentivityRef":0}],"ActiveUnsoldAirBookings":[{"RecordLocator":"String","PNRCreationDate":"\/Date(-62135596800000-0000)\/","OwningAgencyLocationID":"String","GdsCode":"String","PrimaryPax":"String","OwningConsultant":"String","OwningConsultantID":"String","Account":"String","AgentivityRef":0,"PrimaryCarrierCode":"String","FiledFare":"String","TravelDate":"\/Date(-62135596800000-0000)\/","DestinationCities":"String","BookingClasses":"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"}],"BookingsWithWarnings":[{"RecordLocator":"String","PNRCreationDate":"\/Date(-62135596800000-0000)\/","AgentivityRef":0,"OwningConsultant":"String","Account":"String","OwningConsultantID":"String","OwningAgencyLocationID":"String","GdsCode":"String","TravelDate":"\/Date(-62135596800000-0000)\/","PrimaryPax":"String","WarningsList":[{"WarningType":"String","Vendor":"String","VendorType":"String","WarningDateTime":"\/Date(-62135596800000-0000)\/","LogDateTime":"\/Date(-62135596800000-0000)\/","OriginalRemark":"String","PropertiesList":[{"Name":"String","Value":"String"}]}]}]}],"ResponseError":{"ErrorCode":"String","Message":"String","StatusCode":"String","VerboseMessage":"String"}}