GET | /DistributorBookingsByAirlineClass |
---|
"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 BookingByAirlineWithClassSupport {
/** @param {{AgentivityRef?:number,RecordLocator?:string,PNRCreationDate?:string,Account?:string,OwningConsultant?:string,TicketedStatusCode?:string,TicketedStatus?:string,BookingCodesBooked?:string,FlightNumbers?:string,Routing?:string,TrackingCode?:string,TktTourCode?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {number} */
AgentivityRef;
/** @type {string} */
RecordLocator;
/** @type {?string} */
PNRCreationDate;
/** @type {string} */
Account;
/** @type {string} */
OwningConsultant;
/** @type {string} */
TicketedStatusCode;
/** @type {string} */
TicketedStatus;
/** @type {string} */
BookingCodesBooked;
/** @type {string} */
FlightNumbers;
/** @type {string} */
Routing;
/** @type {string} */
TrackingCode;
/** @type {string} */
TktTourCode;
}
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 BookingsByAirlineWithClassSupportItemResponse extends ItemResponse {
/** @param {{ResponseMetadata?:ResponseMetadata,ResponseReport?:TReport,ResponseError?:AgentivityError}} [init] */
constructor(init) { super(init); Object.assign(this, init) }
}
/** @typedef TItemResponse {any} */
/** @typedef TItem {any} */
export class Report {
/** @param {{Item?:TItem}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {TItem} */
Item;
}
export class BookingsByAirlineWithClassSupportResponseReport extends Report {
/** @param {{Item?:TItem}} [init] */
constructor(init) { super(init); Object.assign(this, init) }
}
export class DistributorBookingsByAirlineClassItemResponse extends ItemResponse {
/** @param {{ResponseMetadata?:ResponseMetadata,ResponseReport?:TReport,ResponseError?:AgentivityError}} [init] */
constructor(init) { super(init); Object.assign(this, init) }
}
/** @typedef {number} */
export var FormattingStyle;
(function (FormattingStyle) {
FormattingStyle[FormattingStyle["None"] = 0] = "None"
FormattingStyle[FormattingStyle["Html"] = 1] = "Html"
FormattingStyle[FormattingStyle["Charting"] = 2] = "Charting"
})(FormattingStyle || (FormattingStyle = {}));
export class GetDistributorBookingsTravellingByAirlineClass extends PagingMetadata {
/** @param {{DistributorID?:number,IssueDateStart?:string,IssueDateEnd?:string,PlatingCarrier?:string,BookingClassName?:string,BoardPointCountryCode?:string,IncludeItinerary?:boolean,ItineraryFormatting?:FormattingStyle,Offset?:string,Limit?:string,TotalRecords?:number,ResponseRecords?:number}} [init] */
constructor(init) { super(init); Object.assign(this, init) }
/**
* @type {number}
* @description ID of Distributor */
DistributorID;
/**
* @type {string}
* @description Date in format YYYYMMDD */
IssueDateStart;
/**
* @type {string}
* @description Date in format YYYYMMDD */
IssueDateEnd;
/**
* @type {string}
* @description Two letter code for carrier */
PlatingCarrier;
/**
* @type {string}
* @description Booking Class Name */
BookingClassName;
/**
* @type {string}
* @description BoardPoint CountryCode */
BoardPointCountryCode;
/**
* @type {boolean}
* @description Include Itinerary in the response */
IncludeItinerary;
/**
* @type {FormattingStyle}
* @description Indicates the required formatting: 0=None(Default); 1= Html; 2 = Chart */
ItineraryFormatting;
}
JavaScript GetDistributorBookingsTravellingByAirlineClass DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /DistributorBookingsByAirlineClass 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>0</AgentivityRef> <RecordLocator>String</RecordLocator> <PNRCreationDate>0001-01-01T00:00:00</PNRCreationDate> <Account>String</Account> <OwningConsultant>String</OwningConsultant> <TicketedStatusCode>String</TicketedStatusCode> <TicketedStatus>String</TicketedStatus> <BookingCodesBooked>String</BookingCodesBooked> <FlightNumbers>String</FlightNumbers> <Routing>String</Routing> <TrackingCode>String</TrackingCode> <TktTourCode>String</TktTourCode> </Item> </ResponseReport> <ResponseError> <ErrorCode>String</ErrorCode> <Message>String</Message> <StatusCode>String</StatusCode> <VerboseMessage>String</VerboseMessage> </ResponseError> </AgentivityResponse>