| GET | /PassengerAirSegmentsByTravelDate |
|---|
"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 PNRAccountPassengerSegment {
/** @param {{PNR?:string,Account?:string,Passenger?:string,SegmentType?:string,DepartureDate?:string,SegmentStatus?:string,BoardPoint?:string,OffPoint?:string,Airline?:string,FlightNbr?:string,ServiceCode?:string,DepartureTime?:string,ArrivalTime?:string,ChangeOfDay?:string,BookingTicketed?:string,DestinationCountries?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
PNR;
/** @type {string} */
Account;
/** @type {string} */
Passenger;
/** @type {string} */
SegmentType;
/** @type {string} */
DepartureDate;
/** @type {string} */
SegmentStatus;
/** @type {string} */
BoardPoint;
/** @type {string} */
OffPoint;
/** @type {string} */
Airline;
/** @type {string} */
FlightNbr;
/** @type {string} */
ServiceCode;
/** @type {string} */
DepartureTime;
/** @type {string} */
ArrivalTime;
/** @type {string} */
ChangeOfDay;
/** @type {string} */
BookingTicketed;
/** @type {string} */
DestinationCountries;
}
/** @typedef TItemResponse {any} */
/** @typedef TItem {any} */
export class Report {
/** @param {{Item?:TItem}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {TItem} */
Item;
}
export class PassengerAirSegmentsByTravelDateResponseReport 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 PassengerAirSegmentsByTravelDateItemResponse extends ItemResponse {
/** @param {{ResponseMetadata?:ResponseMetadata,ResponseReport?:TReport,ResponseError?:AgentivityError}} [init] */
constructor(init) { super(init); Object.assign(this, init) }
}
export class GetPassengerAirSegmentsByTravelDate extends CompanyLevelRequestBase {
/** @param {{Account?:string[],TravelDateStart?:string,TravelDateEnd?: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 */
TravelDateStart;
/**
* @type {string}
* @description Date in format YYYYMMDD */
TravelDateEnd;
}
JavaScript GetPassengerAirSegmentsByTravelDate DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /PassengerAirSegmentsByTravelDate 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":{"PNR":"String","Account":"String","Passenger":"String","SegmentType":"String","DepartureDate":"String","SegmentStatus":"String","BoardPoint":"String","OffPoint":"String","Airline":"String","FlightNbr":"String","ServiceCode":"String","DepartureTime":"String","ArrivalTime":"String","ChangeOfDay":"String","BookingTicketed":"String","DestinationCountries":"String"}},"ResponseError":{"ErrorCode":"String","Message":"String","StatusCode":"String","VerboseMessage":"String"}}