| GET | /AgencyReviews |
|---|
"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 AgencyReviewSummary {
/** @param {{TicketedBookings?:number,LCCTktBookings?:number,AssumedTicketedBookings?:number,NonTicketedBookings?:number,TicketedBookingsPerc?:number,NonTicketedBookingsPerc?:number,OnlineBookings?:number,OfflineBookings?:number,CxlBookings?:number,OffLineHtlBookings?:number,BookingsWithHotelSegments?:number,BookingsWithCarSegments?:number,NonAirBookings?:number,TotalBookings?:number,AeroTouches?:number,AeroTouchesAuto?:number,AverageItineraryChanges?:number,AverageAccountBookingToTravelTime?:number,TotalItineraryChangesBeforeTicketing?:number,TotalItineraryChangesAfterTicketing?:number,TotalItineraryChanges?:number,BookingsWithNdcContent?:number,CarbonEmissionValue?:number,CarbonEmissionUnitId?:number,CarbonTonnage?:number}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {number} */
TicketedBookings;
/** @type {number} */
LCCTktBookings;
/** @type {number} */
AssumedTicketedBookings;
/** @type {number} */
NonTicketedBookings;
/** @type {number} */
TicketedBookingsPerc;
/** @type {number} */
NonTicketedBookingsPerc;
/** @type {number} */
OnlineBookings;
/** @type {number} */
OfflineBookings;
/** @type {number} */
CxlBookings;
/** @type {number} */
OffLineHtlBookings;
/** @type {number} */
BookingsWithHotelSegments;
/** @type {number} */
BookingsWithCarSegments;
/** @type {number} */
NonAirBookings;
/** @type {number} */
TotalBookings;
/** @type {?number} */
AeroTouches;
/** @type {number} */
AeroTouchesAuto;
/** @type {number} */
AverageItineraryChanges;
/** @type {number} */
AverageAccountBookingToTravelTime;
/** @type {?number} */
TotalItineraryChangesBeforeTicketing;
/** @type {?number} */
TotalItineraryChangesAfterTicketing;
/** @type {number} */
TotalItineraryChanges;
/** @type {number} */
BookingsWithNdcContent;
/** @type {?number} */
CarbonEmissionValue;
/** @type {?number} */
CarbonEmissionUnitId;
/** @type {?number} */
CarbonTonnage;
}
export class AirlineStats {
/** @param {{CarrierCode?:string,Carrier?:string,TotalSegments?:number}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
CarrierCode;
/** @type {string} */
Carrier;
/** @type {number} */
TotalSegments;
}
export class AirlineSupport {
/** @param {{AirlinesStats?:AirlineStats[],TotalSegments?:number,FormattedAirlineSupport?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {AirlineStats[]} */
AirlinesStats;
/** @type {number} */
TotalSegments;
/** @type {string} */
FormattedAirlineSupport;
}
export class CarStats {
/** @param {{VendorCode?:string,VendorName?:string,TotalSegments?:number}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
VendorCode;
/** @type {string} */
VendorName;
/** @type {number} */
TotalSegments;
}
export class CarSupport {
/** @param {{Stats?:CarStats[],TotalSegments?:number,FormattedCarSupport?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {CarStats[]} */
Stats;
/** @type {number} */
TotalSegments;
/** @type {string} */
FormattedCarSupport;
}
export class HotelStats {
/** @param {{VendorCode?:string,VendorName?:string,TotalSegments?:number,TotalNights?:number}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
VendorCode;
/** @type {string} */
VendorName;
/** @type {number} */
TotalSegments;
/** @type {number} */
TotalNights;
}
export class HotelSupport {
/** @param {{Stats?:HotelStats[],TotalSegments?:number,FormattedHotelSupport?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {HotelStats[]} */
Stats;
/** @type {number} */
TotalSegments;
/** @type {string} */
FormattedHotelSupport;
}
export class AgencyReview {
/** @param {{Summary?:AgencyReviewSummary,AirlineSupport?:AirlineSupport,CarSupport?:CarSupport,HotelSupport?:HotelSupport}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {AgencyReviewSummary} */
Summary;
/** @type {AirlineSupport} */
AirlineSupport;
/** @type {CarSupport} */
CarSupport;
/** @type {HotelSupport} */
HotelSupport;
}
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 AgencyReviewsResponse extends CollectionResponse {
/** @param {{ResponseMetadata?:ResponseMetadata,ResponseReport?:ApiRequestPerHour[],ResponseError?:AgentivityError}} [init] */
constructor(init) { super(init); Object.assign(this, init) }
}
/** @typedef {number} */
export var AgencyReviewOptions;
(function (AgencyReviewOptions) {
AgencyReviewOptions[AgencyReviewOptions["None"] = 0] = "None"
AgencyReviewOptions[AgencyReviewOptions["Summary"] = 1] = "Summary"
AgencyReviewOptions[AgencyReviewOptions["AirlineSupport"] = 2] = "AirlineSupport"
AgencyReviewOptions[AgencyReviewOptions["SummaryAirlineSupport"] = 3] = "SummaryAirlineSupport"
AgencyReviewOptions[AgencyReviewOptions["CarSupport"] = 4] = "CarSupport"
AgencyReviewOptions[AgencyReviewOptions["HotelSupport"] = 8] = "HotelSupport"
AgencyReviewOptions[AgencyReviewOptions["All"] = 15] = "All"
})(AgencyReviewOptions || (AgencyReviewOptions = {}));
/** @typedef {number} */
export var FormattingStyle;
(function (FormattingStyle) {
FormattingStyle[FormattingStyle["None"] = 0] = "None"
FormattingStyle[FormattingStyle["Html"] = 1] = "Html"
FormattingStyle[FormattingStyle["Charting"] = 2] = "Charting"
})(FormattingStyle || (FormattingStyle = {}));
/** @typedef {number} */
export var AgencyReviewMode;
(function (AgencyReviewMode) {
AgencyReviewMode[AgencyReviewMode["Account"] = 0] = "Account"
AgencyReviewMode[AgencyReviewMode["Pcc"] = 1] = "Pcc"
})(AgencyReviewMode || (AgencyReviewMode = {}));
export class AgencyReviews extends CompanyLevelRequestBase {
/** @param {{Account?:string,PNRCreationDateStart?:string,PNRCreationDateEnd?:string,OwningAgencyLocationID?:string[],LoadOptions?:AgencyReviewOptions,AirlineSupportFormatStyle?:FormattingStyle,CarSupportFormatStyle?:FormattingStyle,HotelSupportFormatStyle?:FormattingStyle,ExcludedCarrierCode?:string,Mode?:AgencyReviewMode,TopCarItems?:number,TopHotelItems?:number,IncludeAfterHoursServicingFields?:boolean,RequestConsultantID?: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 Account */
Account;
/**
* @type {string}
* @description Date in format YYYYMMDD */
PNRCreationDateStart;
/**
* @type {string}
* @description Date in format YYYYMMDD */
PNRCreationDateEnd;
/**
* @type {string[]}
* @description Comma Delimited List of PCCs */
OwningAgencyLocationID;
/**
* @type {AgencyReviewOptions}
* @description Load options */
LoadOptions;
/**
* @type {FormattingStyle}
* @description Airline support format style */
AirlineSupportFormatStyle;
/**
* @type {FormattingStyle}
* @description Car support format style */
CarSupportFormatStyle;
/**
* @type {FormattingStyle}
* @description Hotel support format style */
HotelSupportFormatStyle;
/**
* @type {string}
* @description Excluded carrier code */
ExcludedCarrierCode;
/**
* @type {AgencyReviewMode}
* @description Mode */
Mode;
/**
* @type {?number}
* @description Top car items */
TopCarItems;
/**
* @type {?number}
* @description Top hotel items */
TopHotelItems;
/**
* @type {boolean}
* @description Includes AfterHours Servicing in results */
IncludeAfterHoursServicingFields;
/**
* @type {string}
* @description Request Consultant ID (sign on) */
RequestConsultantID;
}
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 /AgencyReviews 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>
<AgencyReview>
<Summary>
<TicketedBookings>0</TicketedBookings>
<LCCTktBookings>0</LCCTktBookings>
<AssumedTicketedBookings>0</AssumedTicketedBookings>
<NonTicketedBookings>0</NonTicketedBookings>
<TicketedBookingsPerc>0</TicketedBookingsPerc>
<NonTicketedBookingsPerc>0</NonTicketedBookingsPerc>
<OnlineBookings>0</OnlineBookings>
<OfflineBookings>0</OfflineBookings>
<CxlBookings>0</CxlBookings>
<OffLineHtlBookings>0</OffLineHtlBookings>
<BookingsWithHotelSegments>0</BookingsWithHotelSegments>
<BookingsWithCarSegments>0</BookingsWithCarSegments>
<NonAirBookings>0</NonAirBookings>
<TotalBookings>0</TotalBookings>
<AeroTouches>0</AeroTouches>
<AeroTouchesAuto>0</AeroTouchesAuto>
<AverageItineraryChanges>0</AverageItineraryChanges>
<AverageAccountBookingToTravelTime>0</AverageAccountBookingToTravelTime>
<TotalItineraryChangesBeforeTicketing>0</TotalItineraryChangesBeforeTicketing>
<TotalItineraryChangesAfterTicketing>0</TotalItineraryChangesAfterTicketing>
<TotalItineraryChanges>0</TotalItineraryChanges>
<CarbonTonnage>0</CarbonTonnage>
<CarbonEmissionValue>0</CarbonEmissionValue>
<CarbonEmissionUnitId>0</CarbonEmissionUnitId>
<BookingsWithNdcContent>0</BookingsWithNdcContent>
</Summary>
<AirlineSupport>
<AirlinesStats>
<AirlineStats>
<CarrierCode>String</CarrierCode>
<Carrier>String</Carrier>
<TotalSegments>0</TotalSegments>
</AirlineStats>
</AirlinesStats>
<TotalSegments>0</TotalSegments>
<FormattedAirlineSupport>String</FormattedAirlineSupport>
</AirlineSupport>
<CarSupport>
<Stats>
<CarStats>
<VendorCode>String</VendorCode>
<VendorName>String</VendorName>
<TotalSegments>0</TotalSegments>
</CarStats>
</Stats>
<TotalSegments>0</TotalSegments>
<FormattedCarSupport>String</FormattedCarSupport>
</CarSupport>
<HotelSupport>
<Stats>
<HotelStats>
<VendorCode>String</VendorCode>
<VendorName>String</VendorName>
<TotalSegments>0</TotalSegments>
<TotalNights>0</TotalNights>
</HotelStats>
</Stats>
<TotalSegments>0</TotalSegments>
<FormattedHotelSupport>String</FormattedHotelSupport>
</HotelSupport>
</AgencyReview>
</ResponseReport>
<ResponseError>
<ErrorCode>String</ErrorCode>
<Message>String</Message>
<StatusCode>String</StatusCode>
<VerboseMessage>String</VerboseMessage>
</ResponseError>
</AgentivityResponse>