| GET | /TicketCouponsByStatusCode |
|---|
"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 CustomFieldData {
/** @param {{FieldName?:string,FieldValue?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
FieldName;
/** @type {string} */
FieldValue;
}
export class CustomFieldsCollection extends Array {
constructor(init) { super(init); Object.assign(this, init) }
}
export class TicketCouponsByStatusCode {
/** @param {{CompanyName?:string,TktNumber?:string,RN?:string,AirTktSegId?:string,VndIssueDt?:string,RecordLocator?:string,Passenger?:string,TravAgntID?:string,OwningConsultantID?:string,FOPFare?:string,BaseFare?:string,FOP?:string,TotalTax?:string,Tax1Code?:string,Tax1Amt?:string,Tax2Code?:string,Tax2Amt?:string,Tax3Code?:string,Tax3Amt?:string,Tax4Code?:string,Tax4Amt?:string,Tax5Code?:string,Tax5Amt?:string,Account?:string,ExchangedForTicket?:string,CouponSequenceNbr?:string,Carrier?:string,BoardPoint?:string,OffPoint?:string,FlightDate?:string,FlightServiceClass?:string,FareBasis?:string,FlightCouponStatus?:string,DateLastChecked?:string,PCC?:string,AirlineCode?:string,OwningCompanyCode?:string,CreditCurrency?:string,CreditValue?:number,FlightServiceClassName?:string,FlownKM?:number,BAR?:string,PNRCreationDate?:string,AgentivityRef?:number,CustomFields?:CustomFieldsCollection}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
CompanyName;
/** @type {string} */
TktNumber;
/** @type {string} */
RN;
/** @type {string} */
AirTktSegId;
/** @type {?string} */
VndIssueDt;
/** @type {string} */
RecordLocator;
/** @type {string} */
Passenger;
/** @type {string} */
TravAgntID;
/** @type {string} */
OwningConsultantID;
/** @type {string} */
FOPFare;
/** @type {string} */
BaseFare;
/** @type {string} */
FOP;
/** @type {string} */
TotalTax;
/** @type {string} */
Tax1Code;
/** @type {string} */
Tax1Amt;
/** @type {string} */
Tax2Code;
/** @type {string} */
Tax2Amt;
/** @type {string} */
Tax3Code;
/** @type {string} */
Tax3Amt;
/** @type {string} */
Tax4Code;
/** @type {string} */
Tax4Amt;
/** @type {string} */
Tax5Code;
/** @type {string} */
Tax5Amt;
/** @type {string} */
Account;
/** @type {string} */
ExchangedForTicket;
/** @type {string} */
CouponSequenceNbr;
/** @type {string} */
Carrier;
/** @type {string} */
BoardPoint;
/** @type {string} */
OffPoint;
/** @type {?string} */
FlightDate;
/** @type {string} */
FlightServiceClass;
/** @type {string} */
FareBasis;
/** @type {string} */
FlightCouponStatus;
/** @type {?string} */
DateLastChecked;
/** @type {string} */
PCC;
/** @type {string} */
AirlineCode;
/** @type {string} */
OwningCompanyCode;
/** @type {string} */
CreditCurrency;
/** @type {?number} */
CreditValue;
/** @type {string} */
FlightServiceClassName;
/** @type {?number} */
FlownKM;
/** @type {string} */
BAR;
/** @type {?string} */
PNRCreationDate;
/** @type {number} */
AgentivityRef;
/** @type {CustomFieldsCollection} */
CustomFields;
}
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 TicketCouponsByStatusCodeResponse extends CollectionResponse {
/** @param {{ResponseMetadata?:ResponseMetadata,ResponseReport?:ApiRequestPerHour[],ResponseError?:AgentivityError}} [init] */
constructor(init) { super(init); Object.assign(this, init) }
}
export class GetTicketCouponsByStatusCode extends CompanyLevelRequestBase {
/** @param {{DateStart?:string,DateEnd?:string,TravAgntID?:string,Account?:string[],OwningAgencyLocationID?:string[],CouponCodeGroup?:string,DateTracker?:string,Repeat?:boolean,NoActiveSegments?:boolean,IncludePartialMatches?:boolean,ShowMatchingCouponsOnly?:boolean,PaxSurname?:string,CarrierCode?:string,ExcludedPlatingCarrier?:string[],OwningConsultantID?:string,CacheGuid?:string,TravellerGUID?:string,RequestConsultantID?:string,CRMCode?:number,CRMID?: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 Travel agent ID */
TravAgntID;
/**
* @type {string[]}
* @description Comma Delimited List of Accounts */
Account;
/**
* @type {string[]}
* @description Comma Delimited List of PCCs */
OwningAgencyLocationID;
/**
* @type {string}
* @description Coupon code group ("ALL OPEN") or any Coupon Status eg USED, OPEN */
CouponCodeGroup;
/**
* @type {string}
* @description Date range type. A single character: I = Issue date, T = Travel date, E = Expiry date */
DateTracker;
/**
* @type {boolean}
* @description Repeat */
Repeat;
/**
* @type {boolean}
* @description Lists only segments that are not active */
NoActiveSegments;
/**
* @type {boolean}
* @description Include partial matches */
IncludePartialMatches;
/**
* @type {boolean}
* @description Show Matching Coupons Only */
ShowMatchingCouponsOnly;
/**
* @type {string}
* @description Pax surname */
PaxSurname;
/**
* @type {string}
* @description Two letter code for carrier */
CarrierCode;
/**
* @type {string[]}
* @description Comma delimited list of 3-character plating carriers */
ExcludedPlatingCarrier;
/**
* @type {string}
* @description Id of the owning consultant */
OwningConsultantID;
/**
* @type {string}
* @description Cache Guid */
CacheGuid;
/**
* @type {string}
* @description Agentivity Traveller GUID */
TravellerGUID;
/**
* @type {string}
* @description Request Consultant ID (sign on) */
RequestConsultantID;
/** @type {number} */
CRMCode;
/** @type {string} */
CRMID;
}
JavaScript GetTicketCouponsByStatusCode 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.
GET /TicketCouponsByStatusCode HTTP/1.1 Host: api.agentivity.com Accept: application/json
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":[{"CompanyName":"String","TktNumber":"String","RN":"String","AirTktSegId":"String","VndIssueDt":"\/Date(-62135596800000-0000)\/","RecordLocator":"String","Passenger":"String","TravAgntID":"String","OwningConsultantID":"String","FOPFare":"String","BaseFare":"String","FOP":"String","TotalTax":"String","Tax1Code":"String","Tax1Amt":"String","Tax2Code":"String","Tax2Amt":"String","Tax3Code":"String","Tax3Amt":"String","Tax4Code":"String","Tax4Amt":"String","Tax5Code":"String","Tax5Amt":"String","Account":"String","ExchangedForTicket":"String","CouponSequenceNbr":"String","Carrier":"String","BoardPoint":"String","OffPoint":"String","FlightDate":"\/Date(-62135596800000-0000)\/","FlightServiceClass":"String","FareBasis":"String","FlightCouponStatus":"String","DateLastChecked":"\/Date(-62135596800000-0000)\/","PCC":"String","AirlineCode":"String","OwningCompanyCode":"String","CreditCurrency":"String","CreditValue":0,"FlightServiceClassName":"String","FlownKM":0,"BAR":"String","PNRCreationDate":"\/Date(-62135596800000-0000)\/","AgentivityRef":0,"CustomFields":[{"FieldName":"String","FieldValue":"String"}]}],"ResponseError":{"ErrorCode":"String","Message":"String","StatusCode":"String","VerboseMessage":"String"}}