| GET | /AirSegmentsWithVendorLocators |
|---|
"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 AirSegmentWithVendorLocators {
/** @param {{RecordLocator?:string,PNRCreationDate?:string,AgentivityRef?:number,Account?:string,OwningConsultantID?:string,OwningConsultant?:string,OwningAgencyLocationID?:string,PaxList?:string,AirSegmentNbr?:number,SegmentStatus?:string,BoardPoint?:string,OffPoint?:string,DepartureDate?:string,DepartureTime?:string,ArrivalTime?:string,ChangeOfDay?:string,CarrierCode?:string,FlightNbr?:string,BookingCode?:string,PNRTicketed?:string,VendorLocator?:string,CheckInURL?:string,IsVip?:boolean,PhoneNbr?:string,EmailAddress?:string,TicketNumber?:string,TicketCouponStatus?:string,TicketCouponDateLastChecked?:string,OperatingCarrierName?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
RecordLocator;
/** @type {?string} */
PNRCreationDate;
/** @type {number} */
AgentivityRef;
/** @type {string} */
Account;
/** @type {string} */
OwningConsultantID;
/** @type {string} */
OwningConsultant;
/** @type {string} */
OwningAgencyLocationID;
/** @type {string} */
PaxList;
/** @type {number} */
AirSegmentNbr;
/** @type {string} */
SegmentStatus;
/** @type {string} */
BoardPoint;
/** @type {string} */
OffPoint;
/** @type {string} */
DepartureDate;
/** @type {string} */
DepartureTime;
/** @type {string} */
ArrivalTime;
/** @type {string} */
ChangeOfDay;
/** @type {string} */
CarrierCode;
/** @type {string} */
FlightNbr;
/** @type {string} */
BookingCode;
/** @type {string} */
PNRTicketed;
/** @type {string} */
VendorLocator;
/** @type {string} */
CheckInURL;
/** @type {boolean} */
IsVip;
/** @type {string} */
PhoneNbr;
/** @type {string} */
EmailAddress;
/** @type {string} */
TicketNumber;
/** @type {string} */
TicketCouponStatus;
/** @type {?string} */
TicketCouponDateLastChecked;
/** @type {string} */
OperatingCarrierName;
}
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 AirSegmentsWithVendorLocatorsByUserResponse extends CollectionResponse {
/** @param {{ResponseMetadata?:ResponseMetadata,ResponseReport?:ApiRequestPerHour[],ResponseError?:AgentivityError}} [init] */
constructor(init) { super(init); Object.assign(this, init) }
}
export class AirSegmentsWithVendorLocatorsByUser extends CompanyLevelRequestBase {
/** @param {{Account?:string[],DepartureDateStart?:string,DepartureDateEnd?:string,IsVip?: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 PNRs that are or are not flagged as VIP bookings */
IsVip;
}
JavaScript AirSegmentsWithVendorLocatorsByUser DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /AirSegmentsWithVendorLocators HTTP/1.1 Host: api.agentivity.com Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<AgentivityResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="schemas.agentivity.com/types">
<ResponseMetadata>
<Success>false</Success>
<HasCache>false</HasCache>
<HasPaging>false</HasPaging>
<CacheMetadata>
<IsFromCache>false</IsFromCache>
<CachedAt>0001-01-01T00:00:00</CachedAt>
<CacheExpiresAt>0001-01-01T00:00:00</CacheExpiresAt>
</CacheMetadata>
<PagingMetadata>
<Limit>String</Limit>
<Offset>String</Offset>
<ResponseRecords>0</ResponseRecords>
<TotalRecords>0</TotalRecords>
</PagingMetadata>
</ResponseMetadata>
<ResponseReport>
<AirSegment>
<RecordLocator>String</RecordLocator>
<PNRCreationDate>0001-01-01T00:00:00</PNRCreationDate>
<AgentivityRef>0</AgentivityRef>
<Account>String</Account>
<OwningConsultantID>String</OwningConsultantID>
<OwningConsultant>String</OwningConsultant>
<OwningAgencyLocationID>String</OwningAgencyLocationID>
<PaxList>String</PaxList>
<AirSegmentNbr>0</AirSegmentNbr>
<SegmentStatus>String</SegmentStatus>
<BoardPoint>String</BoardPoint>
<OffPoint>String</OffPoint>
<DepartureDate>String</DepartureDate>
<DepartureTime>String</DepartureTime>
<ArrivalTime>String</ArrivalTime>
<ChangeOfDay>String</ChangeOfDay>
<CarrierCode>String</CarrierCode>
<FlightNbr>String</FlightNbr>
<BookingCode>String</BookingCode>
<PNRTicketed>String</PNRTicketed>
<VendorLocator>String</VendorLocator>
<CheckInURL>String</CheckInURL>
<IsVip>false</IsVip>
<PhoneNbr>String</PhoneNbr>
<EmailAddress>String</EmailAddress>
<TicketNumber>String</TicketNumber>
<TicketCouponStatus>String</TicketCouponStatus>
<TicketCouponDateLastChecked>0001-01-01T00:00:00</TicketCouponDateLastChecked>
<OperatingCarrierName>String</OperatingCarrierName>
</AirSegment>
</ResponseReport>
<ResponseError>
<ErrorCode>String</ErrorCode>
<Message>String</Message>
<StatusCode>String</StatusCode>
<VerboseMessage>String</VerboseMessage>
</ResponseError>
</AgentivityResponse>