Agentivity API

<back to all web services

GetHolidayExtrasCarParkOffers

The following routes are available for this service:
GET/HolidayExtrasCarParkOffers
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 HolidayExtrasCarParkOffer:
    offer_id: int = 0
    record_locator: Optional[str] = None
    pnr_creation_date: datetime.datetime = datetime.datetime(1, 1, 1)
    arrival_date_time: datetime.datetime = datetime.datetime(1, 1, 1)
    departure_date_time: datetime.datetime = datetime.datetime(1, 1, 1)
    car_park_name: Optional[str] = None
    account: Optional[str] = None
    owning_agent_consultant_i_d: Optional[str] = None
    owning_agent_location_i_d: Optional[str] = None
    car_park_code: Optional[str] = None
    airport_code: Optional[str] = None
    more_info_u_r_l: Optional[str] = None
    booking_u_r_l: Optional[str] = None
    total_price: Optional[Decimal] = None
    creation_date: datetime.datetime = datetime.datetime(1, 1, 1)


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 HolidayExtrasCarParkOffersResponseReport(Report[HolidayExtrasCarParkOffersItemResponse, HolidayExtrasCarParkOffer]):
    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 HolidayExtrasCarParkOffersItemResponse(ItemResponse[HolidayExtrasCarParkOffer, HolidayExtrasCarParkOffersResponseReport]):
    pass


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetHolidayExtrasCarParkOffers(CompanyLevelRequestBase, IMemberTravelDateStart, IMemberTravelDateEnd):
    travel_date_end: Optional[str] = None
    """
    Date in format YYYYMMDD
    """

    travel_date_start: Optional[str] = None
    """
    Date in format YYYYMMDD
    """

Python GetHolidayExtrasCarParkOffers DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other

HTTP + OTHER

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /HolidayExtrasCarParkOffers HTTP/1.1 
Host: api.agentivity.com 
Accept: text/jsonl
HTTP/1.1 200 OK
Content-Type: text/jsonl
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":{"OfferId":0,"RecordLocator":"String","PNRCreationDate":"\/Date(-62135596800000-0000)\/","ArrivalDateTime":"\/Date(-62135596800000-0000)\/","DepartureDateTime":"\/Date(-62135596800000-0000)\/","CarParkName":"String","Account":"String","OwningAgentConsultantID":"String","OwningAgentLocationID":"String","CarParkCode":"String","AirportCode":"String","MoreInfoURL":"String","BookingURL":"String","TotalPrice":0,"CreationDate":"\/Date(-62135596800000-0000)\/"}},"ResponseError":{"ErrorCode":"String","Message":"String","StatusCode":"String","VerboseMessage":"String"}}