| GET | /PNRSegments |
|---|
"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 HostSystem {
/** @param {{Vendor?:string,VendorLocator?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
Vendor;
/** @type {string} */
VendorLocator;
}
export class AirlineReferences extends Array {
constructor(init) { super(init); Object.assign(this, init) }
}
export class PassengerName {
/** @param {{LastName?:string,FirstName?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
LastName;
/** @type {string} */
FirstName;
}
export class Coupon {
/** @param {{CouponSequenceNbr?:string,CouponBoardPoint?:string,CouponOffPoint?:string,Carrier?:string,FlightNbr?:string,FlightDate?:string,FlightTime?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
CouponSequenceNbr;
/** @type {string} */
CouponBoardPoint;
/** @type {string} */
CouponOffPoint;
/** @type {string} */
Carrier;
/** @type {string} */
FlightNbr;
/** @type {string} */
FlightDate;
/** @type {string} */
FlightTime;
}
export class Coupons extends Array {
constructor(init) { super(init); Object.assign(this, init) }
}
export class PNRSummaryTicket {
/** @param {{TktNumber?:string,Passenger?:PassengerName,Coupons?:Coupons}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
TktNumber;
/** @type {PassengerName} */
Passenger;
/** @type {Coupons} */
Coupons;
}
export class PNRSummaryTickets extends Array {
constructor(init) { super(init); Object.assign(this, init) }
}
export class PNRSummary {
/** @param {{RecordLocator?:string,AirlineReferences?:AirlineReferences,Tickets?:PNRSummaryTickets}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
RecordLocator;
/** @type {AirlineReferences} */
AirlineReferences;
/** @type {PNRSummaryTickets} */
Tickets;
}
export class Seat {
/** @param {{SeatLocation?:string,SeatStatusCode?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
SeatLocation;
/** @type {string} */
SeatStatusCode;
}
export class SeatingData extends Array {
constructor(init) { super(init); Object.assign(this, init) }
}
export class AirSegment {
/** @param {{AirSegmentNbr?:number,SegmentStatus?:string,DepartureDate?:string,DepartureTime?:string,CarrierCode?:string,BoardPoint?:string,OffPoint?:string,FlightNbr?:string,BookingCode?:string,ArrivalTime?:string,ChangeOfDay?:string,ConnectionIndicator?:string,OperatingCarrierCode?:string,OperatingCarrierName?:string,JourneyTime?:string,NbrSeats?:number,SeatingData?:SeatingData}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {number} */
AirSegmentNbr;
/** @type {string} */
SegmentStatus;
/** @type {string} */
DepartureDate;
/** @type {string} */
DepartureTime;
/** @type {string} */
CarrierCode;
/** @type {string} */
BoardPoint;
/** @type {string} */
OffPoint;
/** @type {string} */
FlightNbr;
/** @type {string} */
BookingCode;
/** @type {string} */
ArrivalTime;
/** @type {string} */
ChangeOfDay;
/** @type {string} */
ConnectionIndicator;
/** @type {string} */
OperatingCarrierCode;
/** @type {string} */
OperatingCarrierName;
/** @type {string} */
JourneyTime;
/** @type {number} */
NbrSeats;
/** @type {SeatingData} */
SeatingData;
}
export class CarSegment {
/** @param {{CarSegmentNbr?:number,SegmentStatus?:string,PickUpDate?:string,PickUpTime?:string,AirportCode?:string,CarLocationCategory?:string,DropOffDate?:string,DropOffTime?:string,ConfirmationNbr?:string,CarVendorCode?:string,CarRateType?:string,CarRateCode?:string,CarType?:string,CarYieldManagementNbr?:string,RateAmount?:string,RateGuaranteeIndicator?:string,MilesKilometerIndicator?:string,DistanceAllowance?:string,DistanceRateAmount?:string,CurrencyCode?:string,NbrOfCars?:number}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {number} */
CarSegmentNbr;
/** @type {string} */
SegmentStatus;
/** @type {string} */
PickUpDate;
/** @type {string} */
PickUpTime;
/** @type {string} */
AirportCode;
/** @type {string} */
CarLocationCategory;
/** @type {string} */
DropOffDate;
/** @type {string} */
DropOffTime;
/** @type {string} */
ConfirmationNbr;
/** @type {string} */
CarVendorCode;
/** @type {string} */
CarRateType;
/** @type {string} */
CarRateCode;
/** @type {string} */
CarType;
/** @type {string} */
CarYieldManagementNbr;
/** @type {string} */
RateAmount;
/** @type {string} */
RateGuaranteeIndicator;
/** @type {string} */
MilesKilometerIndicator;
/** @type {string} */
DistanceAllowance;
/** @type {string} */
DistanceRateAmount;
/** @type {string} */
CurrencyCode;
/** @type {number} */
NbrOfCars;
}
export class HotelSegmentDepreciated {
/** @param {{HotelSegmentNbr?:string,StatusCode?:string,ArrivalDate?:string,DepartureDate?:string,PropertyName?:string,ConfirmationNbr?:string,Currency?:string,Rate?:string,RoomBookingCode?:string,NbrNights?:number,MultiLevelRateCode?:string,NbrRooms?:number,BookedInName?:string,ServiceInformation?:string,PropertyCityCode?:string,SegmentStatus?:string,HotelVendorCode?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
HotelSegmentNbr;
/** @type {string} */
StatusCode;
/** @type {string} */
ArrivalDate;
/** @type {string} */
DepartureDate;
/** @type {string} */
PropertyName;
/** @type {string} */
ConfirmationNbr;
/** @type {string} */
Currency;
/** @type {string} */
Rate;
/** @type {string} */
RoomBookingCode;
/** @type {number} */
NbrNights;
/** @type {string} */
MultiLevelRateCode;
/** @type {number} */
NbrRooms;
/** @type {string} */
BookedInName;
/** @type {string} */
ServiceInformation;
/** @type {string} */
PropertyCityCode;
/** @type {string} */
SegmentStatus;
/** @type {string} */
HotelVendorCode;
}
export class PassiveSegment {
/** @param {{SegmentStatus?:string,StartDate?:string,DepartureDate?:string,NbrNights?:string,VendorCode?:string,CityCode?:string,SegmentType?:string,Text?:string,Passenger?:string,Address?:string,BookingReasonCode?:string,BookingSource?:string,CommissionInformation?:string,ConfirmationNumber?:string,RateCode?:string,RateQuoted?:string,RateAccessCode?:string,PropertyName?:string,PropertyNumber?:string,ServiceInformation?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
SegmentStatus;
/** @type {string} */
StartDate;
/** @type {string} */
DepartureDate;
/** @type {string} */
NbrNights;
/** @type {string} */
VendorCode;
/** @type {string} */
CityCode;
/** @type {string} */
SegmentType;
/** @type {string} */
Text;
/** @type {string} */
Passenger;
/** @type {string} */
Address;
/** @type {string} */
BookingReasonCode;
/** @type {string} */
BookingSource;
/** @type {string} */
CommissionInformation;
/** @type {string} */
ConfirmationNumber;
/** @type {string} */
RateCode;
/** @type {string} */
RateQuoted;
/** @type {string} */
RateAccessCode;
/** @type {string} */
PropertyName;
/** @type {string} */
PropertyNumber;
/** @type {string} */
ServiceInformation;
}
export class Segments {
/** @param {{AirSegments?:AirSegment[],CarSegments?:CarSegment[],HotelSegments?:HotelSegmentDepreciated[],PassiveSegments?:PassiveSegment[]}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {AirSegment[]} */
AirSegments;
/** @type {CarSegment[]} */
CarSegments;
/** @type {HotelSegmentDepreciated[]} */
HotelSegments;
/** @type {PassiveSegment[]} */
PassiveSegments;
}
export class PNRSegments {
/** @param {{Summary?:PNRSummary,Segments?:Segments}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {PNRSummary} */
Summary;
/** @type {Segments} */
Segments;
}
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 GetPNRSegmentsResponse extends CollectionResponse {
/** @param {{ResponseMetadata?:ResponseMetadata,ResponseReport?:ApiRequestPerHour[],ResponseError?:AgentivityError}} [init] */
constructor(init) { super(init); Object.assign(this, init) }
}
export class GetPNRSegments extends PagingMetadata {
/** @param {{RecordLocator?:string,PNRCreationDate?:string,SegmentType?:string[],PassiveSegmentType?:string[],Offset?:string,Limit?:string,TotalRecords?:number,ResponseRecords?:number}} [init] */
constructor(init) { super(init); Object.assign(this, init) }
/**
* @type {string}
* @description Record locator */
RecordLocator;
/**
* @type {string}
* @description Date in format YYYYMMDD */
PNRCreationDate;
/**
* @type {string[]}
* @description Type of segment */
SegmentType;
/**
* @type {string[]}
* @description Type of passive segment */
PassiveSegmentType;
}
JavaScript GetPNRSegments 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 /PNRSegments 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":[{"Summary":{"RecordLocator":"String","AirlineReferences":[{"Vendor":"String","VendorLocator":"String"}],"Tickets":[{"TktNumber":"String","Passenger":{"LastName":"String","FirstName":"String"},"Coupons":[{"CouponSequenceNbr":"String","CouponBoardPoint":"String","CouponOffPoint":"String","Carrier":"String","FlightNbr":"String","FlightDate":"String","FlightTime":"String"}]}]},"Segments":{"AirSegments":[{"AirSegmentNbr":0,"SegmentStatus":"String","DepartureDate":"String","DepartureTime":"String","CarrierCode":"String","BoardPoint":"String","OffPoint":"String","FlightNbr":"String","BookingCode":"String","ArrivalTime":"String","ChangeOfDay":"String","ConnectionIndicator":"String","OperatingCarrierCode":"String","OperatingCarrierName":"String","JourneyTime":"String","NbrSeats":0,"SeatingData":[{"SeatLocation":"String","SeatStatusCode":"String"}]}],"CarSegments":[{"CarSegmentNbr":0,"SegmentStatus":"String","PickUpDate":"String","PickUpTime":"String","AirportCode":"String","CarLocationCategory":"String","DropOffDate":"String","DropOffTime":"String","ConfirmationNbr":"String","CarVendorCode":"String","CarRateType":"String","CarRateCode":"String","CarType":"String","CarYieldManagementNbr":"String","RateAmount":"String","RateGuaranteeIndicator":"String","MilesKilometerIndicator":"String","DistanceAllowance":"String","DistanceRateAmount":"String","CurrencyCode":"String","NbrOfCars":0}],"HotelSegments":[{"HotelSegmentNbr":"String","StatusCode":"String","ArrivalDate":"String","DepartureDate":"String","PropertyName":"String","ConfirmationNbr":"String","Currency":"String","Rate":"String","RoomBookingCode":"String","NbrNights":0,"MultiLevelRateCode":"String","NbrRooms":0,"BookedInName":"String","ServiceInformation":"String","PropertyCityCode":"String","SegmentStatus":"String","HotelVendorCode":"String"}],"PassiveSegments":[{"SegmentStatus":"String","StartDate":"String","DepartureDate":"String","NbrNights":"String","VendorCode":"String","CityCode":"String","SegmentType":"String","Text":"String","Passenger":"String","Address":"String","BookingReasonCode":"String","BookingSource":"String","CommissionInformation":"String","ConfirmationNumber":"String","RateCode":"String","RateQuoted":"String","RateAccessCode":"String","PropertyName":"String","PropertyNumber":"String","ServiceInformation":"String"}]}}],"ResponseError":{"ErrorCode":"String","Message":"String","StatusCode":"String","VerboseMessage":"String"}}