| GET | /ConsultantPnrActivity |
|---|
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 ConsultantPnrActivity:
consultant: Optional[str] = None
transaction_agent: Optional[str] = None
location: Optional[str] = None
team: Optional[str] = None
total_bookings: int = 0
domestic: int = 0
international: int = 0
land: int = 0
cancelled: int = 0
complex: int = 0
changed_own_domestic: int = 0
changed_own_international: int = 0
changed_other_domestic: int = 0
changed_other_international: int = 0
with_air: int = 0
with_hotel: int = 0
with_passive_hotel: int = 0
with_car: int = 0
total_changed_bookings: int = 0
total_services_to_bookings: int = 0
total_ticketed_bookings: int = 0
total_tickets_issued: int = 0
owning_agency_location_i_d: 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 ConsultantPnrActivityResponse(CollectionResponse[ConsultantPnrActivity]):
pass
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetConsultantPnrActivity(CompanyLevelRequestBase):
activity_date_start: Optional[str] = None
"""
Date in format YYYYMMDD
"""
activity_date_end: Optional[str] = None
"""
Date in format YYYYMMDD
"""
owning_agency_location_i_d: Optional[List[str]] = None
"""
Comma Delimited List of PCCs
"""
team: Optional[str] = None
"""
Team name
"""
qualifier: Optional[str] = None
"""
Qualifier
"""
only_summary: bool = False
"""
List only summary if selected true
"""
vip_only: bool = False
"""
Return only segments that are flagged as VIP only
"""
Python GetConsultantPnrActivity 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.
GET /ConsultantPnrActivity HTTP/1.1 Host: api.agentivity.com Accept: application/json
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":[{"Consultant":"String","TransactionAgent":"String","Location":"String","Team":"String","TotalBookings":0,"Domestic":0,"International":0,"Land":0,"Cancelled":0,"Complex":0,"ChangedOwnDomestic":0,"ChangedOwnInternational":0,"ChangedOtherDomestic":0,"ChangedOtherInternational":0,"WithAir":0,"WithHotel":0,"WithPassiveHotel":0,"WithCar":0,"TotalChangedBookings":0,"TotalServicesToBookings":0,"TotalTicketedBookings":0,"TotalTicketsIssued":0,"OwningAgencyLocationID":"String"}],"ResponseError":{"ErrorCode":"String","Message":"String","StatusCode":"String","VerboseMessage":"String"}}