Agentivity API

<back to all web services

CarSegmentsByDate

The following routes are available for this service:
GET/CarSegmentsByDate
namespace AgentivityAPI.ServiceModel

open System
open System.IO
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<DataContract(Name="CarSegmentByDate", Namespace="schemas.agentivity.com/types")>]
    [<AllowNullLiteral>]
    type CarSegmentByDate() = 
        [<DataMember(Order=10)>]
        member val AgentivityRef:String = null with get,set

        [<DataMember(Order=20)>]
        member val RecordLocator:String = null with get,set

        [<DataMember(Order=30)>]
        member val OwningAgencyLocationID:String = null with get,set

        [<DataMember(Order=40)>]
        member val OwningConsultant:String = null with get,set

        [<DataMember(Order=50)>]
        member val Account:String = null with get,set

        [<DataMember(Order=55)>]
        member val Passengers:String = null with get,set

        [<DataMember(Order=60)>]
        member val PickUpDate:Nullable<DateTime> = new Nullable<DateTime>() with get,set

        [<DataMember(Order=70)>]
        member val DropOffDate:Nullable<DateTime> = new Nullable<DateTime>() with get,set

        [<DataMember(Order=80)>]
        member val CarVendorCode:String = null with get,set

        [<DataMember(Order=90)>]
        member val VendorName:String = null with get,set

        [<DataMember(Order=100)>]
        member val SegmentStatus:String = null with get,set

        [<DataMember(Order=110)>]
        member val AirportCode:String = null with get,set

        [<DataMember(Order=120)>]
        member val ConfirmationNbr:String = null with get,set

        [<DataMember(Order=130)>]
        member val CurrencyCode:String = null with get,set

        [<DataMember(Order=140)>]
        member val RateAmount:String = null with get,set

        [<DataMember(Order=150)>]
        member val NbrOfCars:String = null with get,set

        [<DataMember(Order=160)>]
        member val CarType:String = null with get,set

        [<DataMember(Order=180)>]
        member val ServiceInformation:String = null with get,set

        [<DataMember(Order=190)>]
        member val BRInformation:String = null with get,set

        [<DataMember(Order=200)>]
        member val CarSegmentType:String = null with get,set

        [<DataMember(Order=210)>]
        member val CreatingAgencyIata:String = null with get,set

        [<DataMember(Order=220)>]
        member val CityCode:String = null with get,set

        [<DataMember(Order=230)>]
        member val Text:String = null with get,set

        [<DataMember(Order=240)>]
        member val Vouchers:String = null with get,set

        [<DataMember(Order=250)>]
        member val CarRateCode:String = null with get,set

    [<DataContract(Namespace="schemas.agentivity.com/types")>]
    [<AllowNullLiteral>]
    type Report<TItemResponse, TItem>() = 
        [<DataMember(Order=1, EmitDefaultValue=false)>]
        member val Item:TItem = null with get,set

    [<DataContract(Name="CarSegmentByDate", Namespace="schemas.agentivity.com/types")>]
    [<AllowNullLiteral>]
    type CarSegmentsByDateResponseReport() = 
        inherit Report<CarSegmentsByDateItemResponse, CarSegmentByDate>()

    [<DataContract(Name="CacheMetadata", Namespace="schemas.agentivity.com/types")>]
    [<AllowNullLiteral>]
    type CacheMetadata() = 
        [<DataMember(Order=1)>]
        member val CachedAt:DateTime = new DateTime() with get,set

        [<DataMember(Order=2)>]
        member val CacheExpiresAt:DateTime = new DateTime() with get,set

        [<DataMember(Order=0)>]
        member val IsFromCache:Boolean = new Boolean() with get,set

    [<DataContract(Name="Metadata", Namespace="schemas.agentivity.com/types")>]
    [<AllowNullLiteral>]
    type PagingMetadata() = 
        ///<summary>
        ///Starting Record
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="string", Description="Starting Record", Name="Offset", ParameterType="query")>]
        member val Offset:String = null with get,set

        ///<summary>
        ///Number of records to return (PageSize)
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="string", Description="Number of records to return (PageSize)", Name="Limit", ParameterType="query")>]
        member val Limit:String = null with get,set

        ///<summary>
        ///Total Number of Records in a Full Reponse (if no paging)
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="string", Description="Total Number of Records in a Full Reponse (if no paging)", Name="TotalRecords", ParameterType="query")>]
        member val TotalRecords:Int32 = new Int32() with get,set

        ///<summary>
        ///Total Number of Records in this Reponse (on this page)
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="string", Description="Total Number of Records in this Reponse (on this page)", Name="ResponseRecords", ParameterType="query")>]
        member val ResponseRecords:Int32 = new Int32() with get,set

    [<DataContract(Name="ResponseMetadata", Namespace="schemas.agentivity.com/types")>]
    [<AllowNullLiteral>]
    type ResponseMetadata() = 
        [<DataMember(Order=0)>]
        member val Success:Boolean = new Boolean() with get,set

        [<DataMember(Order=1)>]
        member val HasCache:Boolean = new Boolean() with get,set

        [<DataMember(Order=2)>]
        member val HasPaging:Boolean = new Boolean() with get,set

        [<DataMember(Order=3, EmitDefaultValue=false)>]
        member val CacheMetadata:CacheMetadata = null with get,set

        [<DataMember(Order=4, EmitDefaultValue=false)>]
        member val PagingMetadata:PagingMetadata = null with get,set

    [<DataContract(Name="ResponseMetadata", Namespace="schemas.agentivity.com/types")>]
    [<AllowNullLiteral>]
    type AgentivityError() = 
        [<DataMember>]
        member val ErrorCode:String = null with get,set

        [<DataMember>]
        member val Message:String = null with get,set

        [<DataMember>]
        member val StatusCode:String = null with get,set

        [<DataMember>]
        member val VerboseMessage:String = null with get,set

    [<DataContract(Name="AgentivityResponse", Namespace="schemas.agentivity.com/types")>]
    [<AllowNullLiteral>]
    type ItemResponse<TItem, TReport>() = 
        [<DataMember(Order=1)>]
        member val ResponseMetadata:ResponseMetadata = null with get,set

        [<DataMember(Order=2, EmitDefaultValue=false)>]
        member val ResponseReport:TReport = null with get,set

        [<DataMember(Order=3, EmitDefaultValue=false)>]
        member val ResponseError:AgentivityError = null with get,set

    [<DataContract(Name="AgentivityResponse", Namespace="schemas.agentivity.com/types")>]
    [<AllowNullLiteral>]
    type CarSegmentsByDateItemResponse() = 
        inherit ItemResponse<CarSegmentByDate, CarSegmentsByDateResponseReport>()

    [<DataContract(Namespace="schemas.agentivity.com/types")>]
    [<AllowNullLiteral>]
    type CompanyLevelRequestBase() = 
        inherit PagingMetadata()
        ///<summary>
        ///Comma Delimited List of Owning Company Codes
        ///</summary>
        [<DataMember>]
        member val OwningCompanyCode:String[] = null with get,set

        ///<summary>
        ///UserName in form of an email address
        ///</summary>
        [<DataMember>]
        member val UserName:String = null with get,set

    type CarSegmentType =
        | Active = 0
        | Passive = 1
        | All = 2

    [<DataContract(Namespace="schemas.agentivity.com/types")>]
    [<AllowNullLiteral>]
    type CarSegmentsByDate() = 
        inherit CompanyLevelRequestBase()
        ///<summary>
        ///Type of segment
        ///</summary>
        [<DataMember>]
        member val SegmentType:CarSegmentType = new CarSegmentType() with get,set

        ///<summary>
        ///Date in format YYYYMMDD
        ///</summary>
        [<DataMember>]
        member val DateStart:String = null with get,set

        ///<summary>
        ///Date in format YYYYMMDD
        ///</summary>
        [<DataMember>]
        member val DateEnd:String = null with get,set

        ///<summary>
        ///Date search type option, a single character (T to search by segment start dates, C to search by booking creation dates).
        ///</summary>
        [<DataMember>]
        member val DateSearchType:String = null with get,set

F# 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>