Agentivity API

<back to all web services

GetItineraryChangeEvents

// @DataContract(Name="Metadata", Namespace="schemas.agentivity.com/types")
export class PagingMetadata
{
    /** @description Starting Record */
    // @DataMember
    // @ApiMember(DataType="string", Description="Starting Record", Name="Offset", ParameterType="query")
    public Offset: string;

    /** @description Number of records to return (PageSize) */
    // @DataMember
    // @ApiMember(DataType="string", Description="Number of records to return (PageSize)", Name="Limit", ParameterType="query")
    public Limit: string;

    /** @description 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")
    public TotalRecords: number;

    /** @description 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")
    public ResponseRecords: number;

    public constructor(init?: Partial<PagingMetadata>) { (Object as any).assign(this, init); }
}

// @DataContract(Name="ItineraryChangeEvent", Namespace="schemas.agentivity.com/types")
export class ItineraryChangeEvent
{
    // @DataMember(Order=10)
    public AgentivityRef: string;

    // @DataMember(Order=20)
    public RecordLocator: string;

    // @DataMember(Order=30)
    public LastActionConsultant: string;

    // @DataMember(Order=40)
    public Passengers: string;

    // @DataMember(Order=50)
    public EventDateTime?: string;

    // @DataMember(Order=55)
    public EventDateTimeFormatted: string;

    // @DataMember(Order=60)
    public EventTypeDetail: string;

    // @DataMember(Order=65)
    public EventTypeGroup: string;

    // @DataMember(Order=70)
    public OldData: string;

    // @DataMember(Order=80)
    public NewData: string;

    // @DataMember(Order=90)
    public PNRTicketed: string;

    // @DataMember(Order=100)
    public FirstDILine: string;

    // @DataMember(Order=110)
    public Account: string;

    // @DataMember(Order=120)
    public PurchaseOrder: string;

    // @DataMember(Order=130)
    public DivisionCode: string;

    // @DataMember(Order=140)
    public BusinessUnit: string;

    // @DataMember(Order=150)
    public AccountCode: string;

    public constructor(init?: Partial<ItineraryChangeEvent>) { (Object as any).assign(this, init); }
}

// @DataContract(Namespace="schemas.agentivity.com/types")
export class Report<TItemResponse, TItem>
{
    // @DataMember(Order=1, EmitDefaultValue=false)
    public Item: TItem;

    public constructor(init?: Partial<Report<TItemResponse, TItem>>) { (Object as any).assign(this, init); }
}

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

    public constructor(init?: Partial<ItineraryChangeEventsResponseReport>) { super(init); (Object as any).assign(this, init); }
}

// @DataContract(Name="CacheMetadata", Namespace="schemas.agentivity.com/types")
export class CacheMetadata
{
    // @DataMember(Order=1)
    public CachedAt: string;

    // @DataMember(Order=2)
    public CacheExpiresAt: string;

    // @DataMember(Order=0)
    public IsFromCache: boolean;

    public constructor(init?: Partial<CacheMetadata>) { (Object as any).assign(this, init); }
}

// @DataContract(Name="ResponseMetadata", Namespace="schemas.agentivity.com/types")
export class ResponseMetadata
{
    // @DataMember(Order=0)
    public Success: boolean;

    // @DataMember(Order=1)
    public HasCache: boolean;

    // @DataMember(Order=2)
    public HasPaging: boolean;

    // @DataMember(Order=3, EmitDefaultValue=false)
    public CacheMetadata: CacheMetadata;

    // @DataMember(Order=4, EmitDefaultValue=false)
    public PagingMetadata: PagingMetadata;

    public constructor(init?: Partial<ResponseMetadata>) { (Object as any).assign(this, init); }
}

// @DataContract(Name="ResponseMetadata", Namespace="schemas.agentivity.com/types")
export class AgentivityError
{
    // @DataMember
    public ErrorCode: string;

    // @DataMember
    public Message: string;

    // @DataMember
    public StatusCode: string;

    // @DataMember
    public VerboseMessage: string;

    public constructor(init?: Partial<AgentivityError>) { (Object as any).assign(this, init); }
}

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

    // @DataMember(Order=2, EmitDefaultValue=false)
    public ResponseReport: TReport;

    // @DataMember(Order=3, EmitDefaultValue=false)
    public ResponseError: AgentivityError;

    public constructor(init?: Partial<ItemResponse<TItem, TReport>>) { (Object as any).assign(this, init); }
}

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

    public constructor(init?: Partial<ItineraryChangeEventsItemResponse>) { super(init); (Object as any).assign(this, init); }
}

// @DataContract(Namespace="schemas.agentivity.com/types")
export class GetItineraryChangeEvents extends PagingMetadata
{
    /** @description Comma Delimited List of Accounts */
    // @DataMember
    public Account: string[];

    /** @description UserName in form of an email address */
    // @DataMember
    public UserName: string;

    /** @description Date in format YYYYMMDD */
    // @DataMember
    public ChangeDateStart: string;

    /** @description Date in format YYYYMMDD */
    // @DataMember
    public ChangeDateEnd: string;

    /** @description Return only PNRs that are ticketed/all */
    // @DataMember
    public PNRTicketed: string;

    /** @description Add document information line  */
    // @DataMember
    public AddDILine: boolean;

    /** @description 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
    public EventTypeDetail: string[];

    public constructor(init?: Partial<GetItineraryChangeEvents>) { super(init); (Object as any).assign(this, init); }
}

TypeScript GetItineraryChangeEvents DTOs

GET /ItineraryChangeEvents HTTP/1.1 
Host: api.agentivity.com 
Accept: text/csv

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