| GET | /BookingsTravellingV2 |
|---|
"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 BookingTravellingV2 {
/** @param {{RecordLocator?:string,OwningAgencyLocationID?:string,PNRCreationDate?:string,Passengers?:string,OwningConsultant?:string,Account?:string,TravelDate?:string,Mobile?:string,Emails?:string,PNRTicketed?:string,DestinationCount?:number,CTCM?:string,CTCE?:string,AgentivityRef?:number,ParkingOfferID?:string,ParkingOfferTotalPrice?:number,ParkingOfferArrivalDateTime?:string,ParkingOfferDepartureDateTime?:string,ParkingOfferAirportCode?:string,ItineraryFormatted?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
RecordLocator;
/** @type {string} */
OwningAgencyLocationID;
/** @type {?string} */
PNRCreationDate;
/** @type {string} */
Passengers;
/** @type {string} */
OwningConsultant;
/** @type {string} */
Account;
/** @type {?string} */
TravelDate;
/** @type {string} */
Mobile;
/** @type {string} */
Emails;
/** @type {string} */
PNRTicketed;
/** @type {number} */
DestinationCount;
/** @type {string} */
CTCM;
/** @type {string} */
CTCE;
/** @type {number} */
AgentivityRef;
/** @type {string} */
ParkingOfferID;
/** @type {number} */
ParkingOfferTotalPrice;
/** @type {string} */
ParkingOfferArrivalDateTime;
/** @type {string} */
ParkingOfferDepartureDateTime;
/** @type {string} */
ParkingOfferAirportCode;
/** @type {string} */
ItineraryFormatted;
}
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 ApiRequestPerHour {
/** @param {{RequestDate?:string,Hour0?:number,Hour1?:number,Hour2?:number,Hour3?:number,Hour4?:number,Hour5?:number,Hour6?:number,Hour7?:number,Hour8?:number,Hour9?:number,Hour10?:number,Hour11?:number,Hour12?:number,Hour13?:number,Hour14?:number,Hour15?:number,Hour16?:number,Hour17?:number,Hour18?:number,Hour19?:number,Hour20?:number,Hour21?:number,Hour22?:number,Hour23?:number}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
RequestDate;
/** @type {number} */
Hour0;
/** @type {number} */
Hour1;
/** @type {number} */
Hour2;
/** @type {number} */
Hour3;
/** @type {number} */
Hour4;
/** @type {number} */
Hour5;
/** @type {number} */
Hour6;
/** @type {number} */
Hour7;
/** @type {number} */
Hour8;
/** @type {number} */
Hour9;
/** @type {number} */
Hour10;
/** @type {number} */
Hour11;
/** @type {number} */
Hour12;
/** @type {number} */
Hour13;
/** @type {number} */
Hour14;
/** @type {number} */
Hour15;
/** @type {number} */
Hour16;
/** @type {number} */
Hour17;
/** @type {number} */
Hour18;
/** @type {number} */
Hour19;
/** @type {number} */
Hour20;
/** @type {number} */
Hour21;
/** @type {number} */
Hour22;
/** @type {number} */
Hour23;
}
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} */
export class CollectionResponse {
/** @param {{ResponseMetadata?:ResponseMetadata,ResponseReport?:ApiRequestPerHour[],ResponseError?:AgentivityError}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {ResponseMetadata} */
ResponseMetadata;
/** @type {ApiRequestPerHour[]} */
ResponseReport;
/** @type {AgentivityError} */
ResponseError;
}
export class BookingsTravellingV2Response extends CollectionResponse {
/** @param {{ResponseMetadata?:ResponseMetadata,ResponseReport?:ApiRequestPerHour[],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 GetBookingsTravellingV2 extends CompanyLevelRequestBase {
/** @param {{Account?:string[],TravelDateStart?:string,TravelDateEnd?:string,HasMobile?:boolean,HasEmail?:boolean,MissingEmailOrPhone?:boolean,HasHotel?:boolean,HasAccount?:boolean,IncludeItinerary?:boolean,IncludeParkingOffer?:boolean,MinSegments?:number,ItineraryFormatting?:FormattingStyle,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 {?boolean}
* @description Return only PNRs with/without a mobile number */
HasMobile;
/**
* @type {?boolean}
* @description Return only PNRs with/without an email address */
HasEmail;
/**
* @type {?boolean}
* @description Return only PNRs with/without an email address OR a mobile number */
MissingEmailOrPhone;
/**
* @type {?boolean}
* @description Return only PNRs with/without a hotel */
HasHotel;
/**
* @type {?boolean}
* @description Return only PNRs with/without an account */
HasAccount;
/**
* @type {boolean}
* @description Include Itinerary in the response */
IncludeItinerary;
/**
* @type {boolean}
* @description Include Parking Offer in the response */
IncludeParkingOffer;
/**
* @type {?number}
* @description Return only PNRs that equal or exceed a certain number of segments */
MinSegments;
/**
* @type {FormattingStyle}
* @description Indicates the required formatting: 0=None(Default); 1= Html; 2 = Chart */
ItineraryFormatting;
}
JavaScript GetBookingsTravellingV2 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 /BookingsTravellingV2 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>
<Booking>
<AgentivityRef>0</AgentivityRef>
<RecordLocator>String</RecordLocator>
<OwningAgencyLocationID>String</OwningAgencyLocationID>
<PNRCreationDate>0001-01-01T00:00:00</PNRCreationDate>
<Passengers>String</Passengers>
<OwningConsultant>String</OwningConsultant>
<Account>String</Account>
<TravelDate>0001-01-01T00:00:00</TravelDate>
<Mobile>String</Mobile>
<Emails>String</Emails>
<CTCM>String</CTCM>
<PNRTicketed>String</PNRTicketed>
<CTCE>String</CTCE>
<DestinationCount>0</DestinationCount>
<ParkingOfferID>String</ParkingOfferID>
<ParkingOfferTotalPrice>0</ParkingOfferTotalPrice>
<ParkingOfferArrivalDateTime>0001-01-01T00:00:00</ParkingOfferArrivalDateTime>
<ParkingOfferDepartureDateTime>0001-01-01T00:00:00</ParkingOfferDepartureDateTime>
<ParkingOfferAirportCode>String</ParkingOfferAirportCode>
<ItineraryFormatted>String</ItineraryFormatted>
</Booking>
</ResponseReport>
<ResponseError>
<ErrorCode>String</ErrorCode>
<Message>String</Message>
<StatusCode>String</StatusCode>
<VerboseMessage>String</VerboseMessage>
</ResponseError>
</AgentivityResponse>