| GET | /TicketCouponsIssued |
|---|
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 TicketCouponIssued:
record_locator: Optional[str] = None
pnr_creation_date: Optional[datetime.datetime] = None
tkt_number: Optional[str] = None
passenger: Optional[str] = None
vendor_issue_date: Optional[datetime.datetime] = None
fop: Optional[str] = None
fop_currncy: Optional[str] = None
fop_fare: Optional[str] = None
coupon_sequence_nbr: Optional[str] = None
flight_date: Optional[datetime.datetime] = None
routing: Optional[str] = None
flight_service_class: Optional[str] = None
fare_basis: Optional[str] = None
carrier: Optional[str] = None
account: Optional[str] = None
owning_agency_location_i_d: Optional[str] = None
flight_coupon_status: Optional[str] = None
date_last_checked: datetime.datetime = datetime.datetime(1, 1, 1)
owning_consultant_i_d: Optional[str] = None
ticketing_agent: 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 TicketCouponsIssuedResponseReport(Report[TicketCouponsIssuedItemResponse, TicketCouponIssued]):
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 TicketCouponsIssuedItemResponse(ItemResponse[TicketCouponIssued, TicketCouponsIssuedResponseReport]):
pass
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class TicketCouponsIssued(PagingMetadata):
account: Optional[List[str]] = None
"""
Comma Delimited List of Accounts
"""
user_name: Optional[str] = None
"""
UserName in form of an email address
"""
issue_date_start: Optional[str] = None
"""
Date in format YYYYMMDD
"""
issue_date_end: Optional[str] = None
"""
Date in format YYYYMMDD
"""
travel_agent_i_d: Optional[str] = None
"""
ID of a travel agent
"""
flight_coupon_status: Optional[str] = None
"""
One letter code for flight coupon status
"""
format_style: Optional[str] = None
"""
Format style
"""
Python TicketCouponsIssued 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 /TicketCouponsIssued 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":{"Item":{"RecordLocator":"String","PNRCreationDate":"\/Date(-62135596800000-0000)\/","TktNumber":"String","Passenger":"String","VendorIssueDate":"\/Date(-62135596800000-0000)\/","FOP":"String","FOPCurrncy":"String","FOPFare":"String","CouponSequenceNbr":"String","FlightDate":"\/Date(-62135596800000-0000)\/","Routing":"String","FlightServiceClass":"String","FareBasis":"String","Carrier":"String","Account":"String","OwningAgencyLocationID":"String","FlightCouponStatus":"String","DateLastChecked":"\/Date(-62135596800000-0000)\/","OwningConsultantID":"String","TicketingAgent":"String"}},"ResponseError":{"ErrorCode":"String","Message":"String","StatusCode":"String","VerboseMessage":"String"}}