| GET | /CorporateTrackerBookings |
|---|
"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 ItinerarySegment {
/** @param {{SegmentType?:string,SegmentNbr?:number,BoardPoint?:string,OffPoint?:string,OperatorCode?:string,OperatorService?:string,SegmentStatus?:string,DepartureTimeFormatted?:string,ArrivalTimeFormatted?:string,ChangeOfDayFormatted?:string,ServiceCode?:string,StartDate?:string,EndDate?:string,TicketNumber?:string,VendorLocators?:string,EquipmentCode?:string,Equipment?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
SegmentType;
/** @type {number} */
SegmentNbr;
/** @type {string} */
BoardPoint;
/** @type {string} */
OffPoint;
/** @type {string} */
OperatorCode;
/** @type {string} */
OperatorService;
/** @type {string} */
SegmentStatus;
/** @type {string} */
DepartureTimeFormatted;
/** @type {string} */
ArrivalTimeFormatted;
/** @type {string} */
ChangeOfDayFormatted;
/** @type {string} */
ServiceCode;
/** @type {string} */
StartDate;
/** @type {string} */
EndDate;
/** @type {string} */
TicketNumber;
/**
* @type {string}
* @description Comma separated list of vendor locators */
VendorLocators;
/** @type {string} */
EquipmentCode;
/** @type {string} */
Equipment;
}
export class ItinerarySegmentsCollection extends Array {
constructor(init) { super(init); Object.assign(this, init) }
}
export class CorporateTrackerBooking {
/** @param {{RecordLocator?:string,Passenger?:string,Account?:string,OwningConsultant?:string,PhoneNbr?:string,AgentivityRef?:number,Itinerary?:ItinerarySegmentsCollection,ItineraryFormatted?:string,DestinationCountries?:string,CarbonEmissionValue?:number,CarbonEmissionUnitId?:number,CarbonTonnage?:number}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
RecordLocator;
/** @type {string} */
Passenger;
/** @type {string} */
Account;
/** @type {string} */
OwningConsultant;
/** @type {string} */
PhoneNbr;
/** @type {number} */
AgentivityRef;
/** @type {ItinerarySegmentsCollection} */
Itinerary;
/** @type {string} */
ItineraryFormatted;
/** @type {string} */
DestinationCountries;
/** @type {?number} */
CarbonEmissionValue;
/** @type {?number} */
CarbonEmissionUnitId;
/** @type {?number} */
CarbonTonnage;
}
/** @typedef TItemResponse {any} */
/** @typedef TItem {any} */
export class Report {
/** @param {{Item?:TItem}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {TItem} */
Item;
}
export class CorporateTrackerBookingsResponseReport 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 CorporateTrackerBookingsItemResponse 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 CorporateTrackerBookings extends CompanyLevelRequestBase {
/** @param {{Account?:string[],TravelDateStart?:string,TravelDateEnd?:string,PaxSurname?:string,ItineraryFormatting?:FormattingStyle,ItinerarySegmentsToShow?: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;
/**
* @type {string}
* @description Pax surname */
PaxSurname;
/**
* @type {FormattingStyle}
* @description Indicates the required formatting: 0=None(Default); 1= Html; 2 = Chart */
ItineraryFormatting;
/**
* @type {string}
* @description Itinerary segments to show */
ItinerarySegmentsToShow;
}
JavaScript CorporateTrackerBookings 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 /CorporateTrackerBookings 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","Passenger":"String","Account":"String","OwningConsultant":"String","PhoneNbr":"String","Itinerary":[{"SegmentType":"String","SegmentNbr":0,"BoardPoint":"String","OffPoint":"String","OperatorCode":"String","OperatorService":"String","SegmentStatus":"String","DepartureTimeFormatted":"String","ArrivalTimeFormatted":"String","ChangeOfDayFormatted":"String","ServiceCode":"String","StartDate":"String","EndDate":"String","TicketNumber":"String","VendorLocators":"String","EquipmentCode":"String","Equipment":"String"}],"ItineraryFormatted":"String","DestinationCountries":"String","CarbonEmissionValue":0,"CarbonEmissionUnitId":0,"CarbonTonnage":0}},"ResponseError":{"ErrorCode":"String","Message":"String","StatusCode":"String","VerboseMessage":"String"}}