Agentivity API

<back to all web services

GetItineraryChangeEvents

"use strict";
export class PagingMetadata {
    /** @param {{Offset?:string,Limit?:string,TotalRecords?:number,ResponseRecords?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {string}
     * @description Starting Record */
    Offset;
    /**
     * @type {string}
     * @description Number of records to return (PageSize) */
    Limit;
    /**
     * @type {number}
     * @description Total Number of Records in a Full Reponse (if no paging) */
    TotalRecords;
    /**
     * @type {number}
     * @description Total Number of Records in this Reponse (on this page) */
    ResponseRecords;
}
export class ItineraryChangeEvent {
    /** @param {{AgentivityRef?:string,RecordLocator?:string,LastActionConsultant?:string,Passengers?:string,EventDateTime?:string,EventDateTimeFormatted?:string,EventTypeDetail?:string,EventTypeGroup?:string,OldData?:string,NewData?:string,PNRTicketed?:string,FirstDILine?:string,Account?:string,PurchaseOrder?:string,DivisionCode?:string,BusinessUnit?:string,AccountCode?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    AgentivityRef;
    /** @type {string} */
    RecordLocator;
    /** @type {string} */
    LastActionConsultant;
    /** @type {string} */
    Passengers;
    /** @type {?string} */
    EventDateTime;
    /** @type {string} */
    EventDateTimeFormatted;
    /** @type {string} */
    EventTypeDetail;
    /** @type {string} */
    EventTypeGroup;
    /** @type {string} */
    OldData;
    /** @type {string} */
    NewData;
    /** @type {string} */
    PNRTicketed;
    /** @type {string} */
    FirstDILine;
    /** @type {string} */
    Account;
    /** @type {string} */
    PurchaseOrder;
    /** @type {string} */
    DivisionCode;
    /** @type {string} */
    BusinessUnit;
    /** @type {string} */
    AccountCode;
}
/** @typedef TItemResponse {any} */
/** @typedef  TItem {any} */
export class Report {
    /** @param {{Item?:TItem}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {TItem} */
    Item;
}
export class ItineraryChangeEventsResponseReport extends Report {
    /** @param {{Item?:TItem}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
}
export class CacheMetadata {
    /** @param {{CachedAt?:string,CacheExpiresAt?:string,IsFromCache?:boolean}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    CachedAt;
    /** @type {string} */
    CacheExpiresAt;
    /** @type {boolean} */
    IsFromCache;
}
export class ResponseMetadata {
    /** @param {{Success?:boolean,HasCache?:boolean,HasPaging?:boolean,CacheMetadata?:CacheMetadata,PagingMetadata?:PagingMetadata}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {boolean} */
    Success;
    /** @type {boolean} */
    HasCache;
    /** @type {boolean} */
    HasPaging;
    /** @type {CacheMetadata} */
    CacheMetadata;
    /** @type {PagingMetadata} */
    PagingMetadata;
}
export class AgentivityError {
    /** @param {{ErrorCode?:string,Message?:string,StatusCode?:string,VerboseMessage?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    ErrorCode;
    /** @type {string} */
    Message;
    /** @type {string} */
    StatusCode;
    /** @type {string} */
    VerboseMessage;
}
/** @typedef TItem {any} */
/** @typedef  TReport {any} */
export class ItemResponse {
    /** @param {{ResponseMetadata?:ResponseMetadata,ResponseReport?:TReport,ResponseError?:AgentivityError}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {ResponseMetadata} */
    ResponseMetadata;
    /** @type {TReport} */
    ResponseReport;
    /** @type {AgentivityError} */
    ResponseError;
}
export class ItineraryChangeEventsItemResponse extends ItemResponse {
    /** @param {{ResponseMetadata?:ResponseMetadata,ResponseReport?:TReport,ResponseError?:AgentivityError}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
}
export class GetItineraryChangeEvents extends PagingMetadata {
    /** @param {{Account?:string[],UserName?:string,ChangeDateStart?:string,ChangeDateEnd?:string,PNRTicketed?:string,AddDILine?:boolean,EventTypeDetail?:string[],Offset?:string,Limit?:string,TotalRecords?:number,ResponseRecords?:number}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /**
     * @type {string[]}
     * @description Comma Delimited List of Accounts */
    Account;
    /**
     * @type {string}
     * @description UserName in form of an email address */
    UserName;
    /**
     * @type {string}
     * @description Date in format YYYYMMDD */
    ChangeDateStart;
    /**
     * @type {string}
     * @description Date in format YYYYMMDD */
    ChangeDateEnd;
    /**
     * @type {string}
     * @description Return only PNRs that are ticketed/all */
    PNRTicketed;
    /**
     * @type {boolean}
     * @description Add document information line  */
    AddDILine;
    /**
     * @type {string[]}
     * @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 */
    EventTypeDetail;
}

JavaScript GetItineraryChangeEvents DTOs

GET /ItineraryChangeEvents HTTP/1.1 
Host: api.agentivity.com 
Accept: application/xml

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<AgentivityResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="schemas.agentivity.com/types">
  <ResponseMetadata>
    <Success>false</Success>
    <HasCache>false</HasCache>
    <HasPaging>false</HasPaging>
    <CacheMetadata>
      <IsFromCache>false</IsFromCache>
      <CachedAt>0001-01-01T00:00:00</CachedAt>
      <CacheExpiresAt>0001-01-01T00:00:00</CacheExpiresAt>
    </CacheMetadata>
    <PagingMetadata>
      <Limit>String</Limit>
      <Offset>String</Offset>
      <ResponseRecords>0</ResponseRecords>
      <TotalRecords>0</TotalRecords>
    </PagingMetadata>
  </ResponseMetadata>
  <ResponseReport>
    <Item>
      <AgentivityRef>String</AgentivityRef>
      <RecordLocator>String</RecordLocator>
      <LastActionConsultant>String</LastActionConsultant>
      <Passengers>String</Passengers>
      <EventDateTime>0001-01-01T00:00:00</EventDateTime>
      <EventDateTimeFormatted>String</EventDateTimeFormatted>
      <EventTypeDetail>String</EventTypeDetail>
      <EventTypeGroup>String</EventTypeGroup>
      <OldData>String</OldData>
      <NewData>String</NewData>
      <PNRTicketed>String</PNRTicketed>
      <FirstDILine>String</FirstDILine>
      <Account>String</Account>
      <PurchaseOrder>String</PurchaseOrder>
      <DivisionCode>String</DivisionCode>
      <BusinessUnit>String</BusinessUnit>
      <AccountCode>String</AccountCode>
    </Item>
  </ResponseReport>
  <ResponseError>
    <ErrorCode>String</ErrorCode>
    <Message>String</Message>
    <StatusCode>String</StatusCode>
    <VerboseMessage>String</VerboseMessage>
  </ResponseError>
</AgentivityResponse>