| GET | /SegmentsQC |
|---|
"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;
}
/** @typedef {'Missing'|'Warning'|'Valid'|'Denied'} */
export var QcCheck;
(function (QcCheck) {
QcCheck["Missing"] = "Missing"
QcCheck["Warning"] = "Warning"
QcCheck["Valid"] = "Valid"
QcCheck["Denied"] = "Denied"
})(QcCheck || (QcCheck = {}));
export class SegmentQC {
/** @param {{AgentivityRef?:number,RecordLocator?:string,OwningConsultant?:string,Passenger?:string,Account?:string,BoardPoint?:string,OffPoint?:string,DepartureTime?:string,BookingClass?:string,SegmentStatus?:string,CarrierCode?:string,FlightNbr?:string,FlightNumberFromatted?:string,SeatCheck?:QcCheck,SeatFormatted?:string,MealCheck?:QcCheck,MealFormatted?:string,ChauffeurDesc?:string,TransferDesc?:string,CarsFormatted?:string,HoteCheck?:QcCheck,Hotels?:string,ShuttleDesc?:string,TourDesc?:string,FrequentFlyerNumbers?:string,PnrTicketed?:string,TicketNumber?:string,Comments?:string,OpsComments?:string,IsVip?:boolean,CorporateFFs?:string,VendorLocator?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {number} */
AgentivityRef;
/** @type {string} */
RecordLocator;
/** @type {string} */
OwningConsultant;
/** @type {string} */
Passenger;
/** @type {string} */
Account;
/** @type {string} */
BoardPoint;
/** @type {string} */
OffPoint;
/** @type {string} */
DepartureTime;
/** @type {string} */
BookingClass;
/** @type {string} */
SegmentStatus;
/** @type {string} */
CarrierCode;
/** @type {string} */
FlightNbr;
/** @type {string} */
FlightNumberFromatted;
/** @type {QcCheck} */
SeatCheck;
/** @type {string} */
SeatFormatted;
/** @type {QcCheck} */
MealCheck;
/** @type {string} */
MealFormatted;
/** @type {string} */
ChauffeurDesc;
/** @type {string} */
TransferDesc;
/** @type {string} */
CarsFormatted;
/** @type {QcCheck} */
HoteCheck;
/** @type {string} */
Hotels;
/** @type {string} */
ShuttleDesc;
/** @type {string} */
TourDesc;
/** @type {string} */
FrequentFlyerNumbers;
/** @type {string} */
PnrTicketed;
/** @type {string} */
TicketNumber;
/** @type {string} */
Comments;
/** @type {string} */
OpsComments;
/** @type {boolean} */
IsVip;
/** @type {string} */
CorporateFFs;
/** @type {string} */
VendorLocator;
}
/** @typedef TItemResponse {any} */
/** @typedef TItem {any} */
export class Report {
/** @param {{Item?:TItem}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {TItem} */
Item;
}
export class SegmentsQCResponseReport 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 SegmentsQCItemResponse extends ItemResponse {
/** @param {{ResponseMetadata?:ResponseMetadata,ResponseReport?:TReport,ResponseError?:AgentivityError}} [init] */
constructor(init) { super(init); Object.assign(this, init) }
}
export class SegmentsQC extends CompanyLevelRequestBase {
/** @param {{Account?:string[],DepartureDateStart?:string,DepartureDateEnd?:string,VipOnly?:boolean,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 */
DepartureDateStart;
/**
* @type {string}
* @description Date in format YYYYMMDD */
DepartureDateEnd;
/**
* @type {boolean}
* @description Return only segments that are flagged as VIP only */
VipOnly;
}
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 /SegmentsQC 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","OwningConsultant":"String","Passenger":"String","Account":"String","BoardPoint":"String","OffPoint":"String","DepartureTime":"String","BookingClass":"String","SegmentStatus":"String","CarrierCode":"String","FlightNbr":"String","FlightNumberFromatted":"String","SeatCheck":"Missing","SeatFormatted":"String","MealCheck":"Missing","MealFormatted":"String","ChauffeurDesc":"String","TransferDesc":"String","CarsFormatted":"String","HoteCheck":"Missing","Hotels":"String","ShuttleDesc":"String","TourDesc":"String","FrequentFlyerNumbers":"String","PnrTicketed":"String","TicketNumber":"String","Comments":"String","OpsComments":"String","IsVip":false,"CorporateFFs":"String","VendorLocator":"String"}},"ResponseError":{"ErrorCode":"String","Message":"String","StatusCode":"String","VerboseMessage":"String"}}