| All Verbs | /ConsultantWorkUpcomingPaxDepartures |
|---|
"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 PassengerDeparture {
/** @param {{AgentivityRef?:number,RecordLocator?:string,OwningAgencyLocationID?:string,OwningConsultant?:string,OwningConsultantID?:string,GdsCode?:string,Passenger?:string,Account?:string,TravelDate?:string,TicketedStatusCode?:string,TicketedStatus?:string,SupplierReference?:string,SMS?:string,Vouchers?:string,Transfers?:string,IsVip?:boolean,PhoneNbr?:string,EmailAddress?:string,DestinationCities?:string,DestinationCountries?:string,Connections?:string,Itinerary?:ItinerarySegmentsCollection,ItineraryFormatted?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {number} */
AgentivityRef;
/** @type {string} */
RecordLocator;
/** @type {string} */
OwningAgencyLocationID;
/** @type {string} */
OwningConsultant;
/** @type {string} */
OwningConsultantID;
/** @type {string} */
GdsCode;
/** @type {string} */
Passenger;
/** @type {string} */
Account;
/** @type {?string} */
TravelDate;
/** @type {string} */
TicketedStatusCode;
/** @type {string} */
TicketedStatus;
/** @type {string} */
SupplierReference;
/** @type {string} */
SMS;
/** @type {string} */
Vouchers;
/** @type {string} */
Transfers;
/** @type {boolean} */
IsVip;
/** @type {string} */
PhoneNbr;
/** @type {string} */
EmailAddress;
/** @type {string} */
DestinationCities;
/** @type {string} */
DestinationCountries;
/** @type {string} */
Connections;
/** @type {ItinerarySegmentsCollection} */
Itinerary;
/** @type {string} */
ItineraryFormatted;
}
export class ConsultantUpcomingPaxDeparture extends PassengerDeparture {
/** @param {{AgentivityRef?:number,RecordLocator?:string,OwningAgencyLocationID?:string,OwningConsultant?:string,OwningConsultantID?:string,GdsCode?:string,Passenger?:string,Account?:string,TravelDate?:string,TicketedStatusCode?:string,TicketedStatus?:string,SupplierReference?:string,SMS?:string,Vouchers?:string,Transfers?:string,IsVip?:boolean,PhoneNbr?:string,EmailAddress?:string,DestinationCities?:string,DestinationCountries?:string,Connections?:string,Itinerary?:ItinerarySegmentsCollection,ItineraryFormatted?:string}} [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 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 GetConsultantWorkUpcomingPaxDeparturesResponse 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 GetConsultantWorkUpcomingPaxDepartures extends CompanyLevelRequestBase {
/** @param {{TravelDateStart?:string,TravelDateEnd?:string,Account?:string[],IncludeItinerary?:boolean,ItineraryFormatting?:FormattingStyle,OwningConsultantID?:string[],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 */
TravelDateStart;
/**
* @type {string}
* @description Date in format YYYYMMDD */
TravelDateEnd;
/**
* @type {string[]}
* @description Comma Delimited List of Accounts */
Account;
/**
* @type {boolean}
* @description Include Itinerary in the response */
IncludeItinerary;
/**
* @type {FormattingStyle}
* @description Indicates the required formatting: 0=None(Default); 1= Html; 2 = Chart */
ItineraryFormatting;
/**
* @type {string[]}
* @description Comma delimited list of owning consultants ids */
OwningConsultantID = [];
/**
* @type {string}
* @description Request Consultant ID (sign on) */
RequestConsultantID;
}
JavaScript GetConsultantWorkUpcomingPaxDepartures 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 /ConsultantWorkUpcomingPaxDepartures HTTP/1.1
Host: api.agentivity.com
Accept: application/json
Content-Type: application/json
Content-Length: length
{"TravelDateStart":"String","TravelDateEnd":"String","Account":["String"],"IncludeItinerary":false,"ItineraryFormatting":0,"OwningConsultantID":["String"],"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":[{"AgentivityRef":0,"RecordLocator":"String","OwningAgencyLocationID":"String","OwningConsultant":"String","OwningConsultantID":"String","GdsCode":"String","Passenger":"String","Account":"String","TravelDate":"\/Date(-62135596800000-0000)\/","TicketedStatusCode":"String","TicketedStatus":"String","SupplierReference":"String","SMS":"String","Vouchers":"String","Transfers":"String","IsVip":false,"PhoneNbr":"String","EmailAddress":"String","DestinationCities":"String","DestinationCountries":"String","Connections":"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"}],"ResponseError":{"ErrorCode":"String","Message":"String","StatusCode":"String","VerboseMessage":"String"}}