| GET | /TicketCouponsIssued |
|---|
"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 TicketCouponIssued {
/** @param {{RecordLocator?:string,PNRCreationDate?:string,TktNumber?:string,Passenger?:string,VendorIssueDate?:string,FOP?:string,FOPCurrncy?:string,FOPFare?:string,CouponSequenceNbr?:string,FlightDate?:string,Routing?:string,FlightServiceClass?:string,FareBasis?:string,Carrier?:string,Account?:string,OwningAgencyLocationID?:string,FlightCouponStatus?:string,DateLastChecked?:string,OwningConsultantID?:string,TicketingAgent?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
RecordLocator;
/** @type {?string} */
PNRCreationDate;
/** @type {string} */
TktNumber;
/** @type {string} */
Passenger;
/** @type {?string} */
VendorIssueDate;
/** @type {string} */
FOP;
/** @type {string} */
FOPCurrncy;
/** @type {string} */
FOPFare;
/** @type {string} */
CouponSequenceNbr;
/** @type {?string} */
FlightDate;
/** @type {string} */
Routing;
/** @type {string} */
FlightServiceClass;
/** @type {string} */
FareBasis;
/** @type {string} */
Carrier;
/** @type {string} */
Account;
/** @type {string} */
OwningAgencyLocationID;
/** @type {string} */
FlightCouponStatus;
/** @type {string} */
DateLastChecked;
/** @type {string} */
OwningConsultantID;
/** @type {string} */
TicketingAgent;
}
/** @typedef TItemResponse {any} */
/** @typedef TItem {any} */
export class Report {
/** @param {{Item?:TItem}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {TItem} */
Item;
}
export class TicketCouponsIssuedResponseReport 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 TicketCouponsIssuedItemResponse extends ItemResponse {
/** @param {{ResponseMetadata?:ResponseMetadata,ResponseReport?:TReport,ResponseError?:AgentivityError}} [init] */
constructor(init) { super(init); Object.assign(this, init) }
}
export class TicketCouponsIssued extends PagingMetadata {
/** @param {{Account?:string[],UserName?:string,IssueDateStart?:string,IssueDateEnd?:string,TravelAgentID?:string,FlightCouponStatus?:string,FormatStyle?: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 UserName in form of an email address */
UserName;
/**
* @type {string}
* @description Date in format YYYYMMDD */
IssueDateStart;
/**
* @type {string}
* @description Date in format YYYYMMDD */
IssueDateEnd;
/**
* @type {string}
* @description ID of a travel agent */
TravelAgentID;
/**
* @type {string}
* @description One letter code for flight coupon status */
FlightCouponStatus;
/**
* @type {string}
* @description Format style */
FormatStyle;
}
JavaScript TicketCouponsIssued DTOs
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 /TicketCouponsIssued 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":{"RecordLocator":"String","PNRCreationDate":"\/Date(-62135596800000-0000)\/","TktNumber":"String","Passenger":"String","VendorIssueDate":"\/Date(-62135596800000-0000)\/","FOP":"String","FOPCurrncy":"String","FOPFare":"String","CouponSequenceNbr":"String","FlightDate":"\/Date(-62135596800000-0000)\/","Routing":"String","FlightServiceClass":"String","FareBasis":"String","Carrier":"String","Account":"String","OwningAgencyLocationID":"String","FlightCouponStatus":"String","DateLastChecked":"\/Date(-62135596800000-0000)\/","OwningConsultantID":"String","TicketingAgent":"String"}},"ResponseError":{"ErrorCode":"String","Message":"String","StatusCode":"String","VerboseMessage":"String"}}