Agentivity API

GetItineraryChangeEvents

The following routes are available for this service:
GET	/ItineraryChangeEvents

import java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*


@DataContract(Namespace="schemas.agentivity.com/types")
open class GetItineraryChangeEvents : PagingMetadata()
{
    /**
    * Comma Delimited List of Accounts
    */
    @DataMember
    open var Account:ArrayList<String>? = null

    /**
    * UserName in form of an email address
    */
    @DataMember
    open var UserName:String? = null

    /**
    * Date in format YYYYMMDD
    */
    @DataMember
    open var ChangeDateStart:String? = null

    /**
    * Date in format YYYYMMDD
    */
    @DataMember
    open var ChangeDateEnd:String? = null

    /**
    * Return only PNRs that are ticketed/all
    */
    @DataMember
    open var PNRTicketed:String? = null

    /**
    * Add document information line 
    */
    @DataMember
    open var AddDILine:Boolean? = null

    /**
    * 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
    */
    @DataMember
    open var EventTypeDetail:ArrayList<String>? = null
}

@DataContract(Name="Metadata", Namespace="schemas.agentivity.com/types")
open class PagingMetadata
{
    /**
    * Starting Record
    */
    @DataMember
    @ApiMember(DataType="string", Description="Starting Record", Name="Offset", ParameterType="query")
    open var Offset:String? = null

    /**
    * Number of records to return (PageSize)
    */
    @DataMember
    @ApiMember(DataType="string", Description="Number of records to return (PageSize)", Name="Limit", ParameterType="query")
    open var Limit:String? = null

    /**
    * 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")
    open var TotalRecords:Int? = null

    /**
    * 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")
    open var ResponseRecords:Int? = null
}

@DataContract(Name="AgentivityResponse", Namespace="schemas.agentivity.com/types")
open class ItineraryChangeEventsItemResponse : ItemResponse<ItineraryChangeEvent, ItineraryChangeEventsResponseReport>()
{
}

@DataContract(Name="AgentivityResponse", Namespace="schemas.agentivity.com/types")
open class ItemResponse<TItem, TReport>
{
    @DataMember(Order=1)
    open var ResponseMetadata:ResponseMetadata? = null

    @DataMember(Order=2, EmitDefaultValue=false)
    open var ResponseReport:TReport? = null

    @DataMember(Order=3, EmitDefaultValue=false)
    open var ResponseError:AgentivityError? = null
}

@DataContract(Name="ResponseMetadata", Namespace="schemas.agentivity.com/types")
open class ResponseMetadata
{
    @DataMember(Order=0)
    open var Success:Boolean? = null

    @DataMember(Order=1)
    open var HasCache:Boolean? = null

    @DataMember(Order=2)
    open var HasPaging:Boolean? = null

    @DataMember(Order=3, EmitDefaultValue=false)
    open var CacheMetadata:CacheMetadata? = null

    @DataMember(Order=4, EmitDefaultValue=false)
    open var PagingMetadata:PagingMetadata? = null
}

@DataContract(Name="CacheMetadata", Namespace="schemas.agentivity.com/types")
open class CacheMetadata
{
    @DataMember(Order=1)
    open var CachedAt:Date? = null

    @DataMember(Order=2)
    open var CacheExpiresAt:Date? = null

    @DataMember(Order=0)
    open var IsFromCache:Boolean? = null
}

@DataContract(Name="ResponseMetadata", Namespace="schemas.agentivity.com/types")
open class AgentivityError
{
    @DataMember
    open var ErrorCode:String? = null

    @DataMember
    open var Message:String? = null

    @DataMember
    open var StatusCode:String? = null

    @DataMember
    open var VerboseMessage:String? = null
}

@DataContract(Name="ItineraryChangeEvent", Namespace="schemas.agentivity.com/types")
open class ItineraryChangeEvent
{
    @DataMember(Order=10)
    open var AgentivityRef:String? = null

    @DataMember(Order=20)
    open var RecordLocator:String? = null

    @DataMember(Order=30)
    open var LastActionConsultant:String? = null

    @DataMember(Order=40)
    open var Passengers:String? = null

    @DataMember(Order=50)
    open var EventDateTime:Date? = null

    @DataMember(Order=55)
    open var EventDateTimeFormatted:String? = null

    @DataMember(Order=60)
    open var EventTypeDetail:String? = null

    @DataMember(Order=65)
    open var EventTypeGroup:String? = null

    @DataMember(Order=70)
    open var OldData:String? = null

    @DataMember(Order=80)
    open var NewData:String? = null

    @DataMember(Order=90)
    open var PNRTicketed:String? = null

    @DataMember(Order=100)
    open var FirstDILine:String? = null

    @DataMember(Order=110)
    open var Account:String? = null

    @DataMember(Order=120)
    open var PurchaseOrder:String? = null

    @DataMember(Order=130)
    open var DivisionCode:String? = null

    @DataMember(Order=140)
    open var BusinessUnit:String? = null

    @DataMember(Order=150)
    open var AccountCode:String? = null
}

@DataContract(Name="ItineraryChangeEvent", Namespace="schemas.agentivity.com/types")
open class ItineraryChangeEventsResponseReport : Report<ItineraryChangeEventsItemResponse, ItineraryChangeEvent>()
{
}

@DataContract(Namespace="schemas.agentivity.com/types")
open class Report<TItemResponse, TItem>
{
    @DataMember(Order=1, EmitDefaultValue=false)
    open var Item:TItem? = null
}

Kotlin 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"}}