Agentivity API

<back to all web services

GetPassengerLocationsByAirport

The following routes are available for this service:
All Verbs/PassengerLocationsByAirport
"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 ItinerarySegment {
    /** @param {{SegmentType?:string,SegmentNbr?:number,BoardPoint?:string,OffPoint?:string,OperatorCode?:string,OperatorService?:string,SegmentStatus?:string,DepartureTimeFormatted?:string,ArrivalTimeFormatted?:string,ChangeOfDayFormatted?:string,ServiceCode?:string,StartDate?:string,EndDate?:string,TicketNumber?:string,VendorLocators?:string,EquipmentCode?:string,Equipment?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    SegmentType;
    /** @type {number} */
    SegmentNbr;
    /** @type {string} */
    BoardPoint;
    /** @type {string} */
    OffPoint;
    /** @type {string} */
    OperatorCode;
    /** @type {string} */
    OperatorService;
    /** @type {string} */
    SegmentStatus;
    /** @type {string} */
    DepartureTimeFormatted;
    /** @type {string} */
    ArrivalTimeFormatted;
    /** @type {string} */
    ChangeOfDayFormatted;
    /** @type {string} */
    ServiceCode;
    /** @type {string} */
    StartDate;
    /** @type {string} */
    EndDate;
    /** @type {string} */
    TicketNumber;
    /**
     * @type {string}
     * @description Comma separated list of vendor locators */
    VendorLocators;
    /** @type {string} */
    EquipmentCode;
    /** @type {string} */
    Equipment;
}
export class ItinerarySegmentsCollection extends Array {
    constructor(init) { super(init); Object.assign(this, init) }
}
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 BookingExtVendorLocator {
    /** @param {{CarrierCode?:string,VendorLocator?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    CarrierCode;
    /** @type {string} */
    VendorLocator;
}
export class BookingPassengerModel {
    /** @param {{FirstName?:string,LastName?:string,PassengerDataId?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    FirstName;
    /** @type {string} */
    LastName;
    /** @type {number} */
    PassengerDataId;
}
export class PassengerLocation {
    /** @param {{RecordLocator?:string,TravelDate?:string,DepartureDate?:string,BoardPoint?:string,OffPoint?:string,PnrTicketed?:string,Account?:string,Consultant?:string,PaxList?:string,PhoneNbr?:string,EmailAddress?:string,DestinationCities?:string,Connections?:string,CarrierCodes?:string,HotelsNames?:string,FlightNumbers?:string,OwningAgencyLocationID?:string,IataCodes?:string,AgentivityRef?:number,Itinerary?:ItinerarySegmentsCollection,ItineraryFormatted?:string,CustomFields?:CustomFieldsCollection,DepartureDateTime?:string,CurrentArrivalDateTime?:string,SegmentType?:string,AirSegmentNbr?:string,PNRCreationDate?:string,TicketNumbers?:string[],VendorLocators?:BookingExtVendorLocator[],PassengerInfo?:BookingPassengerModel[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    RecordLocator;
    /** @type {?string} */
    TravelDate;
    /** @type {?string} */
    DepartureDate;
    /** @type {string} */
    BoardPoint;
    /** @type {string} */
    OffPoint;
    /** @type {string} */
    PnrTicketed;
    /** @type {string} */
    Account;
    /** @type {string} */
    Consultant;
    /** @type {string} */
    PaxList;
    /** @type {string} */
    PhoneNbr;
    /** @type {string} */
    EmailAddress;
    /** @type {string} */
    DestinationCities;
    /** @type {string} */
    Connections;
    /** @type {string} */
    CarrierCodes;
    /** @type {string} */
    HotelsNames;
    /** @type {string} */
    FlightNumbers;
    /** @type {string} */
    OwningAgencyLocationID;
    /** @type {string} */
    IataCodes;
    /** @type {number} */
    AgentivityRef;
    /** @type {ItinerarySegmentsCollection} */
    Itinerary;
    /** @type {string} */
    ItineraryFormatted;
    /** @type {CustomFieldsCollection} */
    CustomFields;
    /** @type {?string} */
    DepartureDateTime;
    /** @type {?string} */
    CurrentArrivalDateTime;
    /** @type {string} */
    SegmentType;
    /** @type {string} */
    AirSegmentNbr;
    /** @type {?string} */
    PNRCreationDate;
    /** @type {string[]} */
    TicketNumbers;
    /** @type {BookingExtVendorLocator[]} */
    VendorLocators;
    /** @type {BookingPassengerModel[]} */
    PassengerInfo;
}
/** @typedef TItemResponse {any} */
/** @typedef  TItem {any} */
export class Report {
    /** @param {{Item?:TItem}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {TItem} */
    Item;
}
export class PassengerLocationsByAirportResponseReport 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 PassengerLocationsByAirportItemResponse extends ItemResponse {
    /** @param {{ResponseMetadata?:ResponseMetadata,ResponseReport?:TReport,ResponseError?:AgentivityError}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
}
export class GetPassengerLocationsByAirport extends CompanyLevelRequestBase {
    /** @param {{AirportCode?:string,DateEnd?:string,DateStart?:string,InTransitOnly?:boolean,Account?:string[],CustomField?:string[],RepeatByPassenger?: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 Airport code */
    AirportCode;
    /**
     * @type {string}
     * @description Date in format YYYYMMDD */
    DateEnd;
    /**
     * @type {string}
     * @description Date in format YYYYMMDD */
    DateStart;
    /**
     * @type {?boolean}
     * @description Include passengers that are in transit only in response */
    InTransitOnly;
    /**
     * @type {string[]}
     * @description Comma Delimited List of Accounts */
    Account;
    /**
     * @type {string[]}
     * @description Comma Delimited List of Custom Fields */
    CustomField;
    /**
     * @type {boolean}
     * @description Option to place passenger names on separate lines in the downloadable result (spreadsheet) */
    RepeatByPassenger;
}

JavaScript GetPassengerLocationsByAirport DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /PassengerLocationsByAirport HTTP/1.1 
Host: api.agentivity.com 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"AirportCode":"String","DateEnd":"String","DateStart":"String","InTransitOnly":false,"Account":["String"],"CustomField":["String"],"RepeatByPassenger":false,"OwningCompanyCode":["String"],"UserName":"String","Offset":"String","Limit":"String","TotalRecords":0,"ResponseRecords":0}

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","TravelDate":"\/Date(-62135596800000-0000)\/","DepartureDate":"\/Date(-62135596800000-0000)\/","BoardPoint":"String","OffPoint":"String","PnrTicketed":"String","Account":"String","Consultant":"String","PaxList":"String","PhoneNbr":"String","EmailAddress":"String","DestinationCities":"String","Connections":"String","CarrierCodes":"String","AgentivityRef":0,"HotelsNames":"String","FlightNumbers":"String","OwningAgencyLocationID":"String","IataCodes":"String","Itinerary":[{"SegmentType":"String","SegmentNbr":0,"BoardPoint":"String","OffPoint":"String","OperatorCode":"String","OperatorService":"String","SegmentStatus":"String","DepartureTimeFormatted":"String","ArrivalTimeFormatted":"String","ChangeOfDayFormatted":"String","ServiceCode":"String","StartDate":"String","EndDate":"String","TicketNumber":"String","VendorLocators":"String","EquipmentCode":"String","Equipment":"String"}],"ItineraryFormatted":"String","CustomFields":[{"FieldName":"String","FieldValue":"String"}],"DepartureDateTime":"\/Date(-62135596800000-0000)\/","CurrentArrivalDateTime":"\/Date(-62135596800000-0000)\/","SegmentType":"String","AirSegmentNbr":"String","PNRCreationDate":"\/Date(-62135596800000-0000)\/","TicketNumbers":["String"],"VendorLocators":[{"CarrierCode":"String","VendorLocator":"String"}],"PassengerInfo":[{"FirstName":"String","LastName":"String","PassengerDataId":0,"Tickets":[{"Number":"String","Type":"String"}]}]}},"ResponseError":{"ErrorCode":"String","Message":"String","StatusCode":"String","VerboseMessage":"String"}}