Agentivity API

<back to all web services

GetItineraryChangeEvents

The following routes are available for this service:
GET/ItineraryChangeEvents
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="ItineraryChangeEvent", Namespace="schemas.agentivity.com/types")>]
    [<AllowNullLiteral>]
    type ItineraryChangeEvent() = 
        [<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 LastActionConsultant:String = null with get,set

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

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

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

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

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

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

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

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

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

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

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

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

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

        [<DataMember(Order=150)>]
        member val AccountCode: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="ItineraryChangeEvent", Namespace="schemas.agentivity.com/types")>]
    [<AllowNullLiteral>]
    type ItineraryChangeEventsResponseReport() = 
        inherit Report<ItineraryChangeEventsItemResponse, ItineraryChangeEvent>()

    [<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 ItineraryChangeEventsItemResponse() = 
        inherit ItemResponse<ItineraryChangeEvent, ItineraryChangeEventsResponseReport>()

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

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

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

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

        ///<summary>
        ///Return only PNRs that are ticketed/all
        ///</summary>
        [<DataMember>]
        member val PNRTicketed:String = null with get,set

        ///<summary>
        ///Add document information line 
        ///</summary>
        [<DataMember>]
        member val AddDILine:Boolean = new Boolean() with get,set

        ///<summary>
        ///Comma Delimited List of Event Type Details. Valid values are: AirBkgCodeChanged, AirRouteChanged, AirStatusChanged, AirSupplierChanged, AirTimingsChanged, CarDatesTimingsChanged, CarLocationChanged, CarStatusChanged, CarSupplierChanged, CarTypeCodeChanged, FewerAirSegs, FewerCar_PSegs, FewerCarSegs, FewerHtl_PSegs, FewerHtlSegs, FewerTrn_PSegs, FlightNbrChanged, Htl_PChainChanged, Htl_PDatesChanged, Htl_PLocationChanged, Htl_PTextChanged, HtlChainChanged, HtlDatesChanged, HtlLocationChanged, HtlPropertyChanged, HtlRateCodeChanged, HtlRoomCodeChanged, HtlStatusChanged, MoreAirSegs, MoreCar_PSegs, MoreCarSegs, MoreHtl_PSegs, MoreHtlSegs, MoreTrn_PSegs, TrainDatesChanged
        ///</summary>
        [<DataMember>]
        member val EventTypeDetail:String[] = null with get,set

F# GetItineraryChangeEvents DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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

GET /ItineraryChangeEvents HTTP/1.1 
Host: api.agentivity.com 
Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
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":"String","RecordLocator":"String","LastActionConsultant":"String","Passengers":"String","EventDateTime":"\/Date(-62135596800000-0000)\/","EventDateTimeFormatted":"String","EventTypeDetail":"String","EventTypeGroup":"String","OldData":"String","NewData":"String","PNRTicketed":"String","FirstDILine":"String","Account":"String","PurchaseOrder":"String","DivisionCode":"String","BusinessUnit":"String","AccountCode":"String"}},"ResponseError":{"ErrorCode":"String","Message":"String","StatusCode":"String","VerboseMessage":"String"}}