Agentivity API

<back to all web services

GetItineraryChangeEvents

The following routes are available for this service:
GET/ItineraryChangeEvents
Imports System
Imports System.IO
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports AgentivityAPI.ServiceModel.Types
Imports AgentivityAPI.ServiceModel

Namespace Global

    Namespace AgentivityAPI.ServiceModel

        <DataContract(Name:="AgentivityResponse", Namespace:="schemas.agentivity.com/types")>
        Public Partial Class ItemResponse(Of TItem, TReport)
            <DataMember(Order:=1)>
            Public Overridable Property ResponseMetadata As ResponseMetadata

            <DataMember(Order:=2, EmitDefaultValue:=false)>
            Public Overridable Property ResponseReport As TReport

            <DataMember(Order:=3, EmitDefaultValue:=false)>
            Public Overridable Property ResponseError As AgentivityError
        End Class

        <DataContract(Namespace:="schemas.agentivity.com/types")>
        Public Partial Class Report(Of TItemResponse, TItem)
            <DataMember(Order:=1, EmitDefaultValue:=false)>
            Public Overridable Property Item As TItem
        End Class
    End Namespace

    Namespace AgentivityAPI.ServiceModel.Types

        <DataContract(Name:="ResponseMetadata", Namespace:="schemas.agentivity.com/types")>
        Public Partial Class AgentivityError
            <DataMember>
            Public Overridable Property ErrorCode As String

            <DataMember>
            Public Overridable Property Message As String

            <DataMember>
            Public Overridable Property StatusCode As String

            <DataMember>
            Public Overridable Property VerboseMessage As String
        End Class

        <DataContract(Name:="CacheMetadata", Namespace:="schemas.agentivity.com/types")>
        Public Partial Class CacheMetadata
            <DataMember(Order:=1)>
            Public Overridable Property CachedAt As Date

            <DataMember(Order:=2)>
            Public Overridable Property CacheExpiresAt As Date

            <DataMember(Order:=0)>
            Public Overridable Property IsFromCache As Boolean
        End Class

        <DataContract(Namespace:="schemas.agentivity.com/types")>
        Public Partial Class GetItineraryChangeEvents
            Inherits PagingMetadata
            '''<Summary>
            '''Comma Delimited List of Accounts
            '''</Summary>
            <DataMember>
            Public Overridable Property Account As String()

            '''<Summary>
            '''UserName in form of an email address
            '''</Summary>
            <DataMember>
            Public Overridable Property UserName As String

            '''<Summary>
            '''Date in format YYYYMMDD
            '''</Summary>
            <DataMember>
            Public Overridable Property ChangeDateStart As String

            '''<Summary>
            '''Date in format YYYYMMDD
            '''</Summary>
            <DataMember>
            Public Overridable Property ChangeDateEnd As String

            '''<Summary>
            '''Return only PNRs that are ticketed/all
            '''</Summary>
            <DataMember>
            Public Overridable Property PNRTicketed As String

            '''<Summary>
            '''Add document information line 
            '''</Summary>
            <DataMember>
            Public Overridable Property AddDILine As Boolean

            '''<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>
            Public Overridable Property EventTypeDetail As String()
        End Class

        <DataContract(Name:="ItineraryChangeEvent", Namespace:="schemas.agentivity.com/types")>
        Public Partial Class ItineraryChangeEvent
            <DataMember(Order:=10)>
            Public Overridable Property AgentivityRef As String

            <DataMember(Order:=20)>
            Public Overridable Property RecordLocator As String

            <DataMember(Order:=30)>
            Public Overridable Property LastActionConsultant As String

            <DataMember(Order:=40)>
            Public Overridable Property Passengers As String

            <DataMember(Order:=50)>
            Public Overridable Property EventDateTime As Date?

            <DataMember(Order:=55)>
            Public Overridable Property EventDateTimeFormatted As String

            <DataMember(Order:=60)>
            Public Overridable Property EventTypeDetail As String

            <DataMember(Order:=65)>
            Public Overridable Property EventTypeGroup As String

            <DataMember(Order:=70)>
            Public Overridable Property OldData As String

            <DataMember(Order:=80)>
            Public Overridable Property NewData As String

            <DataMember(Order:=90)>
            Public Overridable Property PNRTicketed As String

            <DataMember(Order:=100)>
            Public Overridable Property FirstDILine As String

            <DataMember(Order:=110)>
            Public Overridable Property Account As String

            <DataMember(Order:=120)>
            Public Overridable Property PurchaseOrder As String

            <DataMember(Order:=130)>
            Public Overridable Property DivisionCode As String

            <DataMember(Order:=140)>
            Public Overridable Property BusinessUnit As String

            <DataMember(Order:=150)>
            Public Overridable Property AccountCode As String
        End Class

        <DataContract(Name:="AgentivityResponse", Namespace:="schemas.agentivity.com/types")>
        Public Partial Class ItineraryChangeEventsItemResponse
            Inherits ItemResponse(Of ItineraryChangeEvent, ItineraryChangeEventsResponseReport)
        End Class

        <DataContract(Name:="ItineraryChangeEvent", Namespace:="schemas.agentivity.com/types")>
        Public Partial Class ItineraryChangeEventsResponseReport
            Inherits Report(Of ItineraryChangeEventsItemResponse, ItineraryChangeEvent)
        End Class

        <DataContract(Name:="Metadata", Namespace:="schemas.agentivity.com/types")>
        Public Partial Class PagingMetadata
            '''<Summary>
            '''Starting Record
            '''</Summary>
            <DataMember>
            <ApiMember(DataType:="string", Description:="Starting Record", Name:="Offset", ParameterType:="query")>
            Public Overridable Property Offset As String

            '''<Summary>
            '''Number of records to return (PageSize)
            '''</Summary>
            <DataMember>
            <ApiMember(DataType:="string", Description:="Number of records to return (PageSize)", Name:="Limit", ParameterType:="query")>
            Public Overridable Property Limit As String

            '''<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")>
            Public Overridable Property TotalRecords As Integer

            '''<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")>
            Public Overridable Property ResponseRecords As Integer
        End Class

        <DataContract(Name:="ResponseMetadata", Namespace:="schemas.agentivity.com/types")>
        Public Partial Class ResponseMetadata
            <DataMember(Order:=0)>
            Public Overridable Property Success As Boolean

            <DataMember(Order:=1)>
            Public Overridable Property HasCache As Boolean

            <DataMember(Order:=2)>
            Public Overridable Property HasPaging As Boolean

            <DataMember(Order:=3, EmitDefaultValue:=false)>
            Public Overridable Property CacheMetadata As CacheMetadata

            <DataMember(Order:=4, EmitDefaultValue:=false)>
            Public Overridable Property PagingMetadata As PagingMetadata
        End Class
    End Namespace
End Namespace

VB.NET GetItineraryChangeEvents DTOs

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

HTTP + OTHER

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: text/jsonl
HTTP/1.1 200 OK
Content-Type: text/jsonl
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"}}