| All Verbs | /ConsultantWorkGDSActions |
|---|
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 ConsultantProblematicSegment(ProblematicSegment):
pass
@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 ConsultantAirlineDemandsForTicketing(AirlineDemandsForTicketing):
pass
@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 ConsultantWorkGDSAction:
problematic_segment_list: Optional[List[ConsultantProblematicSegment]] = None
airline_demands_for_ticketing_list: Optional[List[ConsultantAirlineDemandsForTicketing]] = None
bookings_with_warnings_list: 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 GetConsultantWorkGDSActionsResponse(CollectionResponse[ConsultantWorkGDSAction]):
pass
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetConsultantWorkGDSActions(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
"""
request_consultant_i_d: Optional[str] = None
"""
Request Consultant ID (sign on)
"""
Python GetConsultantWorkGDSActions 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.
POST /ConsultantWorkGDSActions HTTP/1.1
Host: api.agentivity.com
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<GetConsultantWorkGDSActions xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="schemas.agentivity.com/types">
<Limit>String</Limit>
<Offset>String</Offset>
<ResponseRecords>0</ResponseRecords>
<TotalRecords>0</TotalRecords>
<OwningCompanyCode xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>String</d2p1:string>
</OwningCompanyCode>
<UserName>String</UserName>
<DateEnd>String</DateEnd>
<DateStart>String</DateStart>
<OwningConsultantID xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>String</d2p1:string>
</OwningConsultantID>
<RequestConsultantID>String</RequestConsultantID>
<TransactionAgencyLocationID xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>String</d2p1:string>
</TransactionAgencyLocationID>
</GetConsultantWorkGDSActions>
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>
<ConsultantWorkGDSAction>
<ProblematicSegmentList>
<ProblematicSegment>
<RecordLocator>String</RecordLocator>
<PNRCreationDate>0001-01-01T00:00:00</PNRCreationDate>
<OwningConsultantID>String</OwningConsultantID>
<OwningConsultant>String</OwningConsultant>
<PrimaryPax>String</PrimaryPax>
<Account>String</Account>
<SegmentStatus>String</SegmentStatus>
<Segment>String</Segment>
<OwningAgencyLocationID>String</OwningAgencyLocationID>
<GdsCode>String</GdsCode>
<DepartureDate>0001-01-01T00:00:00</DepartureDate>
<AgentivityRef>String</AgentivityRef>
</ProblematicSegment>
</ProblematicSegmentList>
<AirlineDemandsForTicketingList>
<AirlineDemandsForTicketing>
<RecordLocator>String</RecordLocator>
<PNRCreationDate>0001-01-01T00:00:00</PNRCreationDate>
<PrimaryPax>String</PrimaryPax>
<OwningConsultantID>String</OwningConsultantID>
<OwningConsultant>String</OwningConsultant>
<Account>String</Account>
<AirlineCode>String</AirlineCode>
<DueDate>0001-01-01T00:00:00</DueDate>
<DueTime>String</DueTime>
<OwningAgencyLocationID>String</OwningAgencyLocationID>
<GdsCode>String</GdsCode>
<AgentivityRef>0</AgentivityRef>
</AirlineDemandsForTicketing>
</AirlineDemandsForTicketingList>
<BookingsWithWarningsList>
<BookingWithWarnings>
<RecordLocator>String</RecordLocator>
<PNRCreationDate>0001-01-01T00:00:00</PNRCreationDate>
<AgentivityRef>0</AgentivityRef>
<OwningConsultant>String</OwningConsultant>
<Account>String</Account>
<OwningConsultantID>String</OwningConsultantID>
<OwningAgencyLocationID>String</OwningAgencyLocationID>
<GdsCode>String</GdsCode>
<TravelDate>0001-01-01T00:00:00</TravelDate>
<PrimaryPax>String</PrimaryPax>
<WarningsList>
<Warning>
<WarningType>String</WarningType>
<Vendor>String</Vendor>
<VendorType>String</VendorType>
<WarningDateTime>0001-01-01T00:00:00</WarningDateTime>
<LogDateTime>0001-01-01T00:00:00</LogDateTime>
<OriginalRemark>String</OriginalRemark>
<PropertiesList>
<Property>
<Name>String</Name>
<Value>String</Value>
</Property>
</PropertiesList>
</Warning>
</WarningsList>
</BookingWithWarnings>
</BookingsWithWarningsList>
</ConsultantWorkGDSAction>
</ResponseReport>
<ResponseError>
<ErrorCode>String</ErrorCode>
<Message>String</Message>
<StatusCode>String</StatusCode>
<VerboseMessage>String</VerboseMessage>
</ResponseError>
</AgentivityResponse>