| GET | /PassengerLocationsByFlightNumber |
|---|
"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 CompanyLevelRequestBase extends PagingMetadata {
/** @param {{OwningCompanyCode?:string[],UserName?: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 Owning Company Codes */
OwningCompanyCode;
/**
* @type {string}
* @description UserName in form of an email address */
UserName;
}
export class CustomFieldData {
/** @param {{FieldName?:string,FieldValue?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
FieldName;
/** @type {string} */
FieldValue;
}
export class CustomFieldsCollection extends Array {
constructor(init) { super(init); Object.assign(this, init) }
}
export class BookingExtVendorLocator {
/** @param {{CarrierCode?:string,VendorLocator?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
CarrierCode;
/** @type {string} */
VendorLocator;
}
export class PassengerLocationFlightNumber {
/** @param {{AgentivityRef?:number,RecordLocator?:string,PaxList?:string,OwningConsultantID?:string,Account?:string,DepartureDate?:string,BoardPoint?:string,OffPoint?:string,DepartureTime?:string,ArrivalTime?:string,ChangeOfDay?:string,EmailAddress?:string,PhoneNbr?:string,OwningAgencyLocationID?:string,IataCodes?:string,CustomFields?:CustomFieldsCollection,PNRCreationDate?:string,TicketNumbers?:string[],VendorLocators?:BookingExtVendorLocator[]}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {number} */
AgentivityRef;
/** @type {string} */
RecordLocator;
/** @type {string} */
PaxList;
/** @type {string} */
OwningConsultantID;
/** @type {string} */
Account;
/** @type {?string} */
DepartureDate;
/** @type {string} */
BoardPoint;
/** @type {string} */
OffPoint;
/** @type {string} */
DepartureTime;
/** @type {string} */
ArrivalTime;
/** @type {string} */
ChangeOfDay;
/** @type {string} */
EmailAddress;
/** @type {string} */
PhoneNbr;
/** @type {string} */
OwningAgencyLocationID;
/** @type {string} */
IataCodes;
/** @type {CustomFieldsCollection} */
CustomFields;
/** @type {?string} */
PNRCreationDate;
/** @type {string[]} */
TicketNumbers;
/** @type {BookingExtVendorLocator[]} */
VendorLocators;
}
/** @typedef TItemResponse {any} */
/** @typedef TItem {any} */
export class Report {
/** @param {{Item?:TItem}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {TItem} */
Item;
}
export class PassengerLocationsByFlightNumberResponseReport 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 PassengerLocationsByFlightNumberItemResponse extends ItemResponse {
/** @param {{ResponseMetadata?:ResponseMetadata,ResponseReport?:TReport,ResponseError?:AgentivityError}} [init] */
constructor(init) { super(init); Object.assign(this, init) }
}
export class GetPassengerLocationsByFlightNumber extends CompanyLevelRequestBase {
/** @param {{Account?:string[],DepartureDateStart?:string,DepartureDateEnd?:string,CarrierCode?:string,FlightNumber?:string,AllFutureDate?:boolean,CustomField?:string[],OwningCompanyCode?:string[],UserName?: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 Date in format YYYYMMDD */
DepartureDateStart;
/**
* @type {string}
* @description Date in format YYYYMMDD */
DepartureDateEnd;
/**
* @type {string}
* @description Two letter code for carrier */
CarrierCode;
/**
* @type {string}
* @description Flight number without spaces */
FlightNumber;
/**
* @type {boolean}
* @description All future date */
AllFutureDate;
/**
* @type {string[]}
* @description Comma Delimited List of Custom Fields */
CustomField;
}
JavaScript GetPassengerLocationsByFlightNumber DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /PassengerLocationsByFlightNumber 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":0,"RecordLocator":"String","PaxList":"String","OwningConsultantID":"String","Account":"String","DepartureDate":"\/Date(-62135596800000-0000)\/","BoardPoint":"String","OffPoint":"String","DepartureTime":"String","ArrivalTime":"String","ChangeOfDay":"String","EmailAddress":"String","PhoneNbr":"String","OwningAgencyLocationID":"String","IataCodes":"String","CustomFields":[{"FieldName":"String","FieldValue":"String"}],"PNRCreationDate":"\/Date(-62135596800000-0000)\/","TicketNumbers":["String"],"VendorLocators":[{"CarrierCode":"String","VendorLocator":"String"}]}},"ResponseError":{"ErrorCode":"String","Message":"String","StatusCode":"String","VerboseMessage":"String"}}