| GET | /CarSegmentsByDate |
|---|
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 CarSegmentByDate:
agentivity_ref: Optional[str] = None
record_locator: Optional[str] = None
owning_agency_location_i_d: Optional[str] = None
owning_consultant: Optional[str] = None
account: Optional[str] = None
passengers: Optional[str] = None
pick_up_date: Optional[datetime.datetime] = None
drop_off_date: Optional[datetime.datetime] = None
car_vendor_code: Optional[str] = None
vendor_name: Optional[str] = None
segment_status: Optional[str] = None
airport_code: Optional[str] = None
confirmation_nbr: Optional[str] = None
currency_code: Optional[str] = None
rate_amount: Optional[str] = None
nbr_of_cars: Optional[str] = None
car_type: Optional[str] = None
service_information: Optional[str] = None
br_information: Optional[str] = None
car_segment_type: Optional[str] = None
creating_agency_iata: Optional[str] = None
city_code: Optional[str] = None
text: Optional[str] = None
vouchers: Optional[str] = None
car_rate_code: 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 CarSegmentsByDateResponseReport(Report[CarSegmentsByDateItemResponse, CarSegmentByDate]):
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 CarSegmentsByDateItemResponse(ItemResponse[CarSegmentByDate, CarSegmentsByDateResponseReport]):
pass
class CarSegmentType(str, Enum):
ACTIVE = 'Active'
PASSIVE = 'Passive'
ALL = 'All'
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CarSegmentsByDate(CompanyLevelRequestBase):
segment_type: Optional[CarSegmentType] = None
"""
Type of segment
"""
date_start: Optional[str] = None
"""
Date in format YYYYMMDD
"""
date_end: Optional[str] = None
"""
Date in format YYYYMMDD
"""
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).
"""
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 /CarSegmentsByDate 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":{"AgentivityRef":"String","RecordLocator":"String","OwningAgencyLocationID":"String","OwningConsultant":"String","Account":"String","Passengers":"String","PickUpDate":"\/Date(-62135596800000-0000)\/","DropOffDate":"\/Date(-62135596800000-0000)\/","CarVendorCode":"String","VendorName":"String","SegmentStatus":"String","AirportCode":"String","ConfirmationNbr":"String","CurrencyCode":"String","RateAmount":"String","NbrOfCars":"String","CarType":"String","ServiceInformation":"String","BRInformation":"String","CarSegmentType":"String","CreatingAgencyIata":"String","CityCode":"String","Text":"String","Vouchers":"String","CarRateCode":"String"}},"ResponseError":{"ErrorCode":"String","Message":"String","StatusCode":"String","VerboseMessage":"String"}}