Agentivity API

<back to all web services

CarSegmentsByDate

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

// @DataContract(Namespace="schemas.agentivity.com/types")
public class CarSegmentsByDate : CompanyLevelRequestBase
{
    /**
    * Type of segment
    */
    // @DataMember
    public var segmentType:CarSegmentType

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

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

    /**
    * Date search type option, a single character (T to search by segment start dates, C to search by booking creation dates).
    */
    // @DataMember
    public var dateSearchType:String

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

    private enum CodingKeys : String, CodingKey {
        case segmentType
        case dateStart
        case dateEnd
        case dateSearchType
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        segmentType = try container.decodeIfPresent(CarSegmentType.self, forKey: .segmentType)
        dateStart = try container.decodeIfPresent(String.self, forKey: .dateStart)
        dateEnd = try container.decodeIfPresent(String.self, forKey: .dateEnd)
        dateSearchType = try container.decodeIfPresent(String.self, forKey: .dateSearchType)
    }

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

// @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(){}
}

public enum CarSegmentType : String, Codable
{
    case Active
    case Passive
    case All
}

// @DataContract(Name="AgentivityResponse", Namespace="schemas.agentivity.com/types")
public class CarSegmentsByDateItemResponse : ItemResponse<CarSegmentByDate, CarSegmentsByDateResponseReport>
{
    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(Name="CarSegmentByDate", Namespace="schemas.agentivity.com/types")
public class CarSegmentByDate : Codable
{
    // @DataMember(Order=10)
    public var agentivityRef:String

    // @DataMember(Order=20)
    public var recordLocator:String

    // @DataMember(Order=30)
    public var owningAgencyLocationID:String

    // @DataMember(Order=40)
    public var owningConsultant:String

    // @DataMember(Order=50)
    public var account:String

    // @DataMember(Order=55)
    public var passengers:String

    // @DataMember(Order=60)
    public var pickUpDate:Date?

    // @DataMember(Order=70)
    public var dropOffDate:Date?

    // @DataMember(Order=80)
    public var carVendorCode:String

    // @DataMember(Order=90)
    public var vendorName:String

    // @DataMember(Order=100)
    public var segmentStatus:String

    // @DataMember(Order=110)
    public var airportCode:String

    // @DataMember(Order=120)
    public var confirmationNbr:String

    // @DataMember(Order=130)
    public var currencyCode:String

    // @DataMember(Order=140)
    public var rateAmount:String

    // @DataMember(Order=150)
    public var nbrOfCars:String

    // @DataMember(Order=160)
    public var carType:String

    // @DataMember(Order=180)
    public var serviceInformation:String

    // @DataMember(Order=190)
    public var brInformation:String

    // @DataMember(Order=200)
    public var carSegmentType:String

    // @DataMember(Order=210)
    public var creatingAgencyIata:String

    // @DataMember(Order=220)
    public var cityCode:String

    // @DataMember(Order=230)
    public var text:String

    // @DataMember(Order=240)
    public var vouchers:String

    // @DataMember(Order=250)
    public var carRateCode:String

    required public init(){}
}

// @DataContract(Name="CarSegmentByDate", Namespace="schemas.agentivity.com/types")
public class CarSegmentsByDateResponseReport : Report<CarSegmentsByDateItemResponse, CarSegmentByDate>
{
    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 CarSegmentsByDate 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 /CarSegmentsByDate 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>
      <AgentivityRef>String</AgentivityRef>
      <RecordLocator>String</RecordLocator>
      <OwningAgencyLocationID>String</OwningAgencyLocationID>
      <OwningConsultant>String</OwningConsultant>
      <Account>String</Account>
      <Passengers>String</Passengers>
      <PickUpDate>0001-01-01T00:00:00</PickUpDate>
      <DropOffDate>0001-01-01T00:00:00</DropOffDate>
      <CarVendorCode>String</CarVendorCode>
      <VendorName>String</VendorName>
      <SegmentStatus>String</SegmentStatus>
      <AirportCode>String</AirportCode>
      <ConfirmationNbr>String</ConfirmationNbr>
      <CurrencyCode>String</CurrencyCode>
      <RateAmount>String</RateAmount>
      <NbrOfCars>String</NbrOfCars>
      <CarType>String</CarType>
      <ServiceInformation>String</ServiceInformation>
      <BRInformation>String</BRInformation>
      <CarSegmentType>String</CarSegmentType>
      <CreatingAgencyIata>String</CreatingAgencyIata>
      <CityCode>String</CityCode>
      <Text>String</Text>
      <Vouchers>String</Vouchers>
      <CarRateCode>String</CarRateCode>
    </Item>
  </ResponseReport>
  <ResponseError>
    <ErrorCode>String</ErrorCode>
    <Message>String</Message>
    <StatusCode>String</StatusCode>
    <VerboseMessage>String</VerboseMessage>
  </ResponseError>
</AgentivityResponse>