| GET | /PassiveSegments |
|---|
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 PassiveSegmentWithOwningInformation:
agentivity_ref: int = 0
owning_agency_location_i_d: Optional[str] = None
record_locator: Optional[str] = None
owning_consultant_i_d: Optional[str] = None
owning_consultant: Optional[str] = None
account: Optional[str] = None
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
total_air_segs: Optional[str] = None
hotel_commission: Optional[str] = None
country_name: Optional[str] = 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 PassiveSegmentsByUserResponseReport(Report[PassiveSegmentsResponse, PassiveSegmentWithOwningInformation]):
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 PassiveSegmentsResponse(ItemResponse[PassiveSegmentWithOwningInformation, PassiveSegmentsByUserResponseReport]):
pass
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class PassiveSegmentsByUser(CompanyLevelRequestBase):
arrival_date_end: Optional[str] = None
"""
Date in format YYYYMMDD
"""
arrival_date_start: Optional[str] = None
"""
Date in format YYYYMMDD
"""
segment_type: Optional[str] = None
"""
Type of segment
"""
account: Optional[str] = None
"""
Account
"""
city_code: Optional[str] = None
"""
3 letter city code
"""
date_search_type: Optional[str] = None
"""
Date search type option, a single character (T to search by segment start dates, C to search by booking creation dates).
"""
Python PassiveSegmentsByUser DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /PassiveSegments HTTP/1.1 Host: api.agentivity.com Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<AgentivityResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="schemas.agentivity.com/types">
<ResponseMetadata>
<Success>false</Success>
<HasCache>false</HasCache>
<HasPaging>false</HasPaging>
<CacheMetadata>
<IsFromCache>false</IsFromCache>
<CachedAt>0001-01-01T00:00:00</CachedAt>
<CacheExpiresAt>0001-01-01T00:00:00</CacheExpiresAt>
</CacheMetadata>
<PagingMetadata>
<Limit>String</Limit>
<Offset>String</Offset>
<ResponseRecords>0</ResponseRecords>
<TotalRecords>0</TotalRecords>
</PagingMetadata>
</ResponseMetadata>
<ResponseReport>
<Item>
<Address>String</Address>
<AgentivityRef>0</AgentivityRef>
<BookingReasonCode>String</BookingReasonCode>
<BookingSource>String</BookingSource>
<CityCode>String</CityCode>
<CommissionInformation>String</CommissionInformation>
<ConfirmationNumber>String</ConfirmationNumber>
<CountryName>String</CountryName>
<HotelCommission>String</HotelCommission>
<NbrNights>String</NbrNights>
<OwningConsultantID>String</OwningConsultantID>
<PropertyName>String</PropertyName>
<PropertyNumber>String</PropertyNumber>
<RateAccessCode>String</RateAccessCode>
<RateCode>String</RateCode>
<RateQuoted>String</RateQuoted>
<SegmentType>String</SegmentType>
<ServiceInformation>String</ServiceInformation>
<StartDate>String</StartDate>
<Text>String</Text>
<TotalAirSegs>String</TotalAirSegs>
<VendorCode>String</VendorCode>
<RecordLocator>String</RecordLocator>
<OwningAgencyLocationID>String</OwningAgencyLocationID>
<OwningConsultant>String</OwningConsultant>
<Account>String</Account>
<Passenger>String</Passenger>
<DepartureDate>String</DepartureDate>
<SegmentStatus>String</SegmentStatus>
</Item>
</ResponseReport>
<ResponseError>
<ErrorCode>String</ErrorCode>
<Message>String</Message>
<StatusCode>String</StatusCode>
<VerboseMessage>String</VerboseMessage>
</ResponseError>
</AgentivityResponse>