Agentivity API

<back to all web services

GetHolidayExtrasCarParkOffers

The following routes are available for this service:
GET/HolidayExtrasCarParkOffers
import Foundation
import ServiceStack

// @DataContract(Namespace="schemas.agentivity.com/types")
public class GetHolidayExtrasCarParkOffers : CompanyLevelRequestBase, IMemberTravelDateStart, IMemberTravelDateEnd
{
    /**
    * Date in format YYYYMMDD
    */
    // @DataMember
    public var travelDateEnd:String

    /**
    * Date in format YYYYMMDD
    */
    // @DataMember
    public var travelDateStart:String

    required public init(){ super.init() }

    private enum CodingKeys : String, CodingKey {
        case travelDateEnd
        case travelDateStart
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        travelDateEnd = try container.decodeIfPresent(String.self, forKey: .travelDateEnd)
        travelDateStart = try container.decodeIfPresent(String.self, forKey: .travelDateStart)
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
        var container = encoder.container(keyedBy: CodingKeys.self)
        if travelDateEnd != nil { try container.encode(travelDateEnd, forKey: .travelDateEnd) }
        if travelDateStart != nil { try container.encode(travelDateStart, forKey: .travelDateStart) }
    }
}

// @DataContract(Namespace="schemas.agentivity.com/types")
public class CompanyLevelRequestBase : PagingMetadata, IMemberUsername, IMemberOwningCompanyCode
{
    /**
    * Comma Delimited List of Owning Company Codes
    */
    // @DataMember
    public var owningCompanyCode:[String]

    /**
    * UserName in form of an email address
    */
    // @DataMember
    public var userName:String

    required public init(){ super.init() }

    private enum CodingKeys : String, CodingKey {
        case owningCompanyCode
        case userName
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        owningCompanyCode = try container.decodeIfPresent([String].self, forKey: .owningCompanyCode) ?? []
        userName = try container.decodeIfPresent(String.self, forKey: .userName)
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
        var container = encoder.container(keyedBy: CodingKeys.self)
        if owningCompanyCode != nil { try container.encode(owningCompanyCode, forKey: .owningCompanyCode) }
        if userName != nil { try container.encode(userName, forKey: .userName) }
    }
}

// @DataContract(Name="Metadata", Namespace="schemas.agentivity.com/types")
public class PagingMetadata : Codable
{
    /**
    * Starting Record
    */
    // @DataMember
    // @ApiMember(DataType="string", Description="Starting Record", Name="Offset", ParameterType="query")
    public var offset:String

    /**
    * Number of records to return (PageSize)
    */
    // @DataMember
    // @ApiMember(DataType="string", Description="Number of records to return (PageSize)", Name="Limit", ParameterType="query")
    public var limit:String

    /**
    * Total Number of Records in a Full Reponse (if no paging)
    */
    // @DataMember
    // @ApiMember(DataType="string", Description="Total Number of Records in a Full Reponse (if no paging)", Name="TotalRecords", ParameterType="query")
    public var totalRecords:Int

    /**
    * Total Number of Records in this Reponse (on this page)
    */
    // @DataMember
    // @ApiMember(DataType="string", Description="Total Number of Records in this Reponse (on this page)", Name="ResponseRecords", ParameterType="query")
    public var responseRecords:Int

    required public init(){}
}

// @DataContract(Name="AgentivityResponse", Namespace="schemas.agentivity.com/types")
public class HolidayExtrasCarParkOffersItemResponse : ItemResponse<HolidayExtrasCarParkOffer, HolidayExtrasCarParkOffersResponseReport>
{
    required public init(){ super.init() }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
    }
}

// @DataContract(Name="AgentivityResponse", Namespace="schemas.agentivity.com/types")
public class ItemResponse<TItem : Codable, TReport : Codable> : Codable
{
    // @DataMember(Order=1)
    public var responseMetadata:ResponseMetadata

    // @DataMember(Order=2, EmitDefaultValue=false)
    public var responseReport:TReport

    // @DataMember(Order=3, EmitDefaultValue=false)
    public var responseError:AgentivityError

    required public init(){}
}

// @DataContract(Name="ResponseMetadata", Namespace="schemas.agentivity.com/types")
public class ResponseMetadata : Codable
{
    // @DataMember(Order=0)
    public var success:Bool

    // @DataMember(Order=1)
    public var hasCache:Bool

    // @DataMember(Order=2)
    public var hasPaging:Bool

    // @DataMember(Order=3, EmitDefaultValue=false)
    public var cacheMetadata:CacheMetadata

    // @DataMember(Order=4, EmitDefaultValue=false)
    public var pagingMetadata:PagingMetadata

    required public init(){}
}

// @DataContract(Name="CacheMetadata", Namespace="schemas.agentivity.com/types")
public class CacheMetadata : Codable
{
    // @DataMember(Order=1)
    public var cachedAt:Date

    // @DataMember(Order=2)
    public var cacheExpiresAt:Date

    // @DataMember(Order=0)
    public var isFromCache:Bool

    required public init(){}
}

// @DataContract(Name="ResponseMetadata", Namespace="schemas.agentivity.com/types")
public class AgentivityError : Codable
{
    // @DataMember
    public var errorCode:String

    // @DataMember
    public var message:String

    // @DataMember
    public var statusCode:String

    // @DataMember
    public var verboseMessage:String

    required public init(){}
}

// @DataContract(Namespace="schemas.agentivity.com/types")
public class HolidayExtrasCarParkOffer : Codable
{
    // @DataMember
    public var offerId:Int

    // @DataMember
    public var recordLocator:String

    // @DataMember
    public var pnrCreationDate:Date

    // @DataMember
    public var arrivalDateTime:Date

    // @DataMember
    public var departureDateTime:Date

    // @DataMember
    public var carParkName:String

    // @DataMember
    public var account:String

    // @DataMember
    public var owningAgentConsultantID:String

    // @DataMember
    public var owningAgentLocationID:String

    // @DataMember
    public var carParkCode:String

    // @DataMember
    public var airportCode:String

    // @DataMember
    public var moreInfoURL:String

    // @DataMember
    public var bookingURL:String

    // @DataMember
    public var totalPrice:Double?

    // @DataMember
    public var creationDate:Date

    required public init(){}
}

// @DataContract(Name="HolidayExtrasCarParkOffer", Namespace="schemas.agentivity.com/types")
public class HolidayExtrasCarParkOffersResponseReport : Report<HolidayExtrasCarParkOffersItemResponse, HolidayExtrasCarParkOffer>
{
    required public init(){ super.init() }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
    }
}

// @DataContract(Namespace="schemas.agentivity.com/types")
public class Report<TItemResponse : Codable, TItem : Codable> : Codable
{
    // @DataMember(Order=1, EmitDefaultValue=false)
    public var item:TItem

    required public init(){}
}

Swift GetHolidayExtrasCarParkOffers DTOs

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

HTTP + XML

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: 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>
      <Account>String</Account>
      <AirportCode>String</AirportCode>
      <ArrivalDateTime>0001-01-01T00:00:00</ArrivalDateTime>
      <BookingURL>String</BookingURL>
      <CarParkCode>String</CarParkCode>
      <CarParkName>String</CarParkName>
      <CreationDate>0001-01-01T00:00:00</CreationDate>
      <DepartureDateTime>0001-01-01T00:00:00</DepartureDateTime>
      <MoreInfoURL>String</MoreInfoURL>
      <OfferId>0</OfferId>
      <OwningAgentConsultantID>String</OwningAgentConsultantID>
      <OwningAgentLocationID>String</OwningAgentLocationID>
      <PNRCreationDate>0001-01-01T00:00:00</PNRCreationDate>
      <RecordLocator>String</RecordLocator>
      <TotalPrice>0</TotalPrice>
    </Item>
  </ResponseReport>
  <ResponseError>
    <ErrorCode>String</ErrorCode>
    <Message>String</Message>
    <StatusCode>String</StatusCode>
    <VerboseMessage>String</VerboseMessage>
  </ResponseError>
</AgentivityResponse>