Agentivity API

<back to all web services

GetBookingsWithActiveSegments

The following routes are available for this service:
All Verbs/BookingsWithActiveSegments
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="VendorLocator", Namespace="schemas.agentivity.com/types")>]
    [<AllowNullLiteral>]
    type BookingExtVendorLocator() = 
        [<DataMember(Order=10)>]
        member val CarrierCode:String = null with get,set

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

        [<DataMember(Order=210)>]
        member val VendorLocators:BookingExtVendorLocator[] = 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="BookingWithActiveSegments", Namespace="schemas.agentivity.com/types")>]
    [<AllowNullLiteral>]
    type GetBookingsWithActiveSegmentsResponseReport() = 
        inherit Report<GetBookingsWithActiveSegmentsItemResponse, BookingWithActiveSegments>()

    [<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 GetBookingsWithActiveSegmentsItemResponse() = 
        inherit ItemResponse<BookingWithActiveSegments, GetBookingsWithActiveSegmentsResponseReport>()

    [<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

    [<DataContract(Namespace="schemas.agentivity.com/types")>]
    [<AllowNullLiteral>]
    type GetBookingsWithActiveSegments() = 
        inherit CompanyLevelRequestBase()
        ///<summary>
        ///Date in format YYYYMMDD
        ///</summary>
        [<DataMember>]
        member val TravelDateStart:String = null with get,set

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

        ///<summary>
        ///All future date
        ///</summary>
        [<DataMember>]
        member val AllFutureDate:Boolean = new Boolean() with get,set

        ///<summary>
        ///Comma Delimited List of Accounts
        ///</summary>
        [<DataMember>]
        member val Account:String[] = null with get,set

F# GetBookingsWithActiveSegments DTOs

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

HTTP + CSV

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

POST /BookingsWithActiveSegments HTTP/1.1 
Host: api.agentivity.com 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"TravelDateStart":"String","TravelDateEnd":"String","AllFutureDate":false,"Account":["String"],"OwningCompanyCode":["String"],"UserName":"String","Offset":"String","Limit":"String","TotalRecords":0,"ResponseRecords":0}

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":0,"RecordLocator":"String","PNRCreationDate":"\/Date(-62135596800000-0000)\/","OwningAgencyLocationID":"String","Account":"String","OwningConsultantID":"String","OwningConsultant":"String","TravelDate":"\/Date(-62135596800000-0000)\/","Passenger":"String","PNRTicketed":"String","EmailAddress":"String","PhoneNbr":"String","HasAir":false,"HasHtl":false,"HasCar":false,"DestinationCities":"String","Connections":"String","CarrierCodes":"String","FlightNumbers":"String","IataCodes":"String","TicketNumbers":["String"],"VendorLocators":[{"CarrierCode":"String","VendorLocator":"String"}]}},"ResponseError":{"ErrorCode":"String","Message":"String","StatusCode":"String","VerboseMessage":"String"}}