| All Verbs | /ConsultantFocus |
|---|
"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 ProblematicSegment {
/** @param {{RecordLocator?:string,PNRCreationDate?:string,OwningConsultantID?:string,OwningConsultant?:string,PrimaryPax?:string,Account?:string,SegmentStatus?:string,Segment?:string,OwningAgencyLocationID?:string,GdsCode?:string,DepartureDate?:string,AgentivityRef?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
RecordLocator;
/** @type {?string} */
PNRCreationDate;
/** @type {string} */
OwningConsultantID;
/** @type {string} */
OwningConsultant;
/** @type {string} */
PrimaryPax;
/** @type {string} */
Account;
/** @type {string} */
SegmentStatus;
/** @type {string} */
Segment;
/** @type {string} */
OwningAgencyLocationID;
/** @type {string} */
GdsCode;
/** @type {?string} */
DepartureDate;
/** @type {string} */
AgentivityRef;
}
export class AirlineDemandsForTicketing {
/** @param {{RecordLocator?:string,PNRCreationDate?:string,PrimaryPax?:string,OwningConsultantID?:string,OwningConsultant?:string,Account?:string,AirlineCode?:string,DueDate?:string,DueTime?:string,OwningAgencyLocationID?:string,GdsCode?:string,AgentivityRef?:number}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
RecordLocator;
/** @type {?string} */
PNRCreationDate;
/** @type {string} */
PrimaryPax;
/** @type {string} */
OwningConsultantID;
/** @type {string} */
OwningConsultant;
/** @type {string} */
Account;
/** @type {string} */
AirlineCode;
/** @type {?string} */
DueDate;
/** @type {string} */
DueTime;
/** @type {string} */
OwningAgencyLocationID;
/** @type {string} */
GdsCode;
/** @type {?number} */
AgentivityRef;
}
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 ActiveUnsoldAirBookings {
/** @param {{RecordLocator?:string,PNRCreationDate?:string,OwningAgencyLocationID?:string,GdsCode?:string,PrimaryPax?:string,OwningConsultant?:string,OwningConsultantID?:string,Account?:string,PrimaryCarrierCode?:string,FiledFare?:string,TravelDate?:string,DestinationCities?:string,BookingClasses?:string,AgentivityRef?:number,Itinerary?:ItinerarySegmentsCollection,ItineraryFormatted?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
RecordLocator;
/** @type {?string} */
PNRCreationDate;
/** @type {string} */
OwningAgencyLocationID;
/** @type {string} */
GdsCode;
/** @type {string} */
PrimaryPax;
/** @type {string} */
OwningConsultant;
/** @type {string} */
OwningConsultantID;
/** @type {string} */
Account;
/** @type {string} */
PrimaryCarrierCode;
/** @type {string} */
FiledFare;
/** @type {?string} */
TravelDate;
/** @type {string} */
DestinationCities;
/** @type {string} */
BookingClasses;
/** @type {number} */
AgentivityRef;
/** @type {ItinerarySegmentsCollection} */
Itinerary;
/** @type {string} */
ItineraryFormatted;
}
export class BookingWarningProperty {
/** @param {{Name?:string,Value?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
Name;
/** @type {string} */
Value;
}
export class BookingWarning {
/** @param {{WarningType?:string,Vendor?:string,VendorType?:string,WarningDateTime?:string,LogDateTime?:string,OriginalRemark?:string,PropertiesList?:BookingWarningProperty[]}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
WarningType;
/** @type {string} */
Vendor;
/** @type {string} */
VendorType;
/** @type {?string} */
WarningDateTime;
/** @type {?string} */
LogDateTime;
/** @type {string} */
OriginalRemark;
/** @type {BookingWarningProperty[]} */
PropertiesList;
}
export class BookingWithWarnings {
/** @param {{RecordLocator?:string,PNRCreationDate?:string,AgentivityRef?:number,OwningConsultant?:string,Account?:string,OwningConsultantID?:string,OwningAgencyLocationID?:string,GdsCode?:string,TravelDate?:string,PrimaryPax?:string,WarningsList?:BookingWarning[]}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
RecordLocator;
/** @type {string} */
PNRCreationDate;
/** @type {number} */
AgentivityRef;
/** @type {string} */
OwningConsultant;
/** @type {string} */
Account;
/** @type {string} */
OwningConsultantID;
/** @type {string} */
OwningAgencyLocationID;
/** @type {string} */
GdsCode;
/** @type {?string} */
TravelDate;
/** @type {string} */
PrimaryPax;
/** @type {BookingWarning[]} */
WarningsList;
}
export class ConsultantFocusResult {
/** @param {{ProblematicSegments?:ProblematicSegment[],AirlineDemandsForTicketing?:AirlineDemandsForTicketing[],ActiveUnsoldAirBookings?:ActiveUnsoldAirBookings[],BookingsWithWarnings?:BookingWithWarnings[]}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {ProblematicSegment[]} */
ProblematicSegments;
/** @type {AirlineDemandsForTicketing[]} */
AirlineDemandsForTicketing;
/** @type {ActiveUnsoldAirBookings[]} */
ActiveUnsoldAirBookings;
/** @type {BookingWithWarnings[]} */
BookingsWithWarnings;
}
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 GetConsultantFocusResponse extends CollectionResponse {
/** @param {{ResponseMetadata?:ResponseMetadata,ResponseReport?:ApiRequestPerHour[],ResponseError?:AgentivityError}} [init] */
constructor(init) { super(init); Object.assign(this, init) }
}
/** @typedef {number} */
export var ConsultantFocusOptions;
(function (ConsultantFocusOptions) {
ConsultantFocusOptions[ConsultantFocusOptions["Default"] = 0] = "Default"
ConsultantFocusOptions[ConsultantFocusOptions["ProblematicSegments"] = 1] = "ProblematicSegments"
ConsultantFocusOptions[ConsultantFocusOptions["AirlineDemandsForTicketing"] = 2] = "AirlineDemandsForTicketing"
ConsultantFocusOptions[ConsultantFocusOptions["Standard"] = 3] = "Standard"
ConsultantFocusOptions[ConsultantFocusOptions["ActiveUnsoldAirBookings"] = 4] = "ActiveUnsoldAirBookings"
ConsultantFocusOptions[ConsultantFocusOptions["BookingsWithWarnings"] = 8] = "BookingsWithWarnings"
ConsultantFocusOptions[ConsultantFocusOptions["All"] = 15] = "All"
})(ConsultantFocusOptions || (ConsultantFocusOptions = {}));
export class GetConsultantFocus extends CompanyLevelRequestBase {
/** @param {{DateStart?:string,DateEnd?:string,OwningConsultantID?:string[],TransactionAgencyLocationID?:string[],Options?:ConsultantFocusOptions,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 Date in format YYYYMMDD */
DateStart;
/**
* @type {string}
* @description Date in format YYYYMMDD */
DateEnd;
/**
* @type {string[]}
* @description Comma delimited list of owning consultants ids */
OwningConsultantID = [];
/**
* @type {string[]}
* @description Comma delimited list of transaction agency location ids */
TransactionAgencyLocationID;
/**
* @type {ConsultantFocusOptions}
* @description Options to retrieve consultant focus data. Use All to include the Active Unsold Air Bookings. */
Options;
/**
* @type {string}
* @description Request Consultant ID (sign on) */
RequestConsultantID;
}
JavaScript GetConsultantFocus DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json
To embed the response in a jsonp callback, append ?callback=myCallback
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /ConsultantFocus HTTP/1.1
Host: api.agentivity.com
Accept: application/json
Content-Type: application/json
Content-Length: length
{"DateStart":"String","DateEnd":"String","OwningConsultantID":["String"],"TransactionAgencyLocationID":["String"],"Options":0,"RequestConsultantID":"String","OwningCompanyCode":["String"],"UserName":"String","Offset":"String","Limit":"String","TotalRecords":0,"ResponseRecords":0}
HTTP/1.1 200 OK
Content-Type: application/json
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":[{"ProblematicSegments":[{"RecordLocator":"String","PNRCreationDate":"\/Date(-62135596800000-0000)\/","OwningConsultantID":"String","OwningConsultant":"String","PrimaryPax":"String","Account":"String","SegmentStatus":"String","Segment":"String","OwningAgencyLocationID":"String","GdsCode":"String","DepartureDate":"\/Date(-62135596800000-0000)\/","AgentivityRef":"String"}],"AirlineDemandsForTicketing":[{"RecordLocator":"String","PNRCreationDate":"\/Date(-62135596800000-0000)\/","PrimaryPax":"String","OwningConsultantID":"String","OwningConsultant":"String","Account":"String","AirlineCode":"String","DueDate":"\/Date(-62135596800000-0000)\/","DueTime":"String","OwningAgencyLocationID":"String","GdsCode":"String","AgentivityRef":0}],"ActiveUnsoldAirBookings":[{"RecordLocator":"String","PNRCreationDate":"\/Date(-62135596800000-0000)\/","OwningAgencyLocationID":"String","GdsCode":"String","PrimaryPax":"String","OwningConsultant":"String","OwningConsultantID":"String","Account":"String","AgentivityRef":0,"PrimaryCarrierCode":"String","FiledFare":"String","TravelDate":"\/Date(-62135596800000-0000)\/","DestinationCities":"String","BookingClasses":"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"}],"BookingsWithWarnings":[{"RecordLocator":"String","PNRCreationDate":"\/Date(-62135596800000-0000)\/","AgentivityRef":0,"OwningConsultant":"String","Account":"String","OwningConsultantID":"String","OwningAgencyLocationID":"String","GdsCode":"String","TravelDate":"\/Date(-62135596800000-0000)\/","PrimaryPax":"String","WarningsList":[{"WarningType":"String","Vendor":"String","VendorType":"String","WarningDateTime":"\/Date(-62135596800000-0000)\/","LogDateTime":"\/Date(-62135596800000-0000)\/","OriginalRemark":"String","PropertiesList":[{"Name":"String","Value":"String"}]}]}]}],"ResponseError":{"ErrorCode":"String","Message":"String","StatusCode":"String","VerboseMessage":"String"}}