Agentivity API

<back to all web services

GetGroupAirTravel

The following routes are available for this service:
All Verbs/GroupAirTravel
"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 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 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 GroupAirTravelItem {
    /** @param {{RecordLocator?:string,PNRCreationDate?:string,DepartureDate?:string,BoardPoint?:string,OffPoint?:string,PnrTicketed?:string,Account?:string,PaxList?:string,Connections?:string,CarrierCode?:string,FlightNumber?:string,TicketNumbers?:string[],VendorLocators?:BookingExtVendorLocator[],PassengerInfo?:BookingPassengerModel[],DepartureDateTime?:string,CurrentArrivalDateTime?:string,AgentivityRef?:number,CustomFields?:CustomFieldsCollection}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    RecordLocator;
    /** @type {?string} */
    PNRCreationDate;
    /** @type {?string} */
    DepartureDate;
    /** @type {string} */
    BoardPoint;
    /** @type {string} */
    OffPoint;
    /** @type {string} */
    PnrTicketed;
    /** @type {string} */
    Account;
    /** @type {string} */
    PaxList;
    /** @type {string} */
    Connections;
    /** @type {string} */
    CarrierCode;
    /** @type {string} */
    FlightNumber;
    /** @type {string[]} */
    TicketNumbers;
    /** @type {BookingExtVendorLocator[]} */
    VendorLocators;
    /** @type {BookingPassengerModel[]} */
    PassengerInfo;
    /** @type {?string} */
    DepartureDateTime;
    /** @type {?string} */
    CurrentArrivalDateTime;
    /** @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 GetGroupAirTravelResponse extends CollectionResponse {
    /** @param {{ResponseMetadata?:ResponseMetadata,ResponseReport?:ApiRequestPerHour[],ResponseError?:AgentivityError}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
}
export class GetGroupAirTravel extends CompanyLevelRequestBase {
    /** @param {{Account?:string[],DateStart?:string,DateEnd?:string,FromAirportCode?:string,ToAirportCode?: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 Comma Delimited List of Accounts */
    Account;
    /**
     * @type {string}
     * @description Date in format YYYYMMDD */
    DateStart;
    /**
     * @type {string}
     * @description Date in format YYYYMMDD */
    DateEnd;
    /**
     * @type {string}
     * @description From Airport Code */
    FromAirportCode;
    /**
     * @type {string}
     * @description To Airport Code */
    ToAirportCode;
    /**
     * @type {boolean}
     * @description Option to place passenger names on separate lines in the downloadable result (spreadsheet) */
    RepeatByPassenger;
}

JavaScript GetGroupAirTravel 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 /GroupAirTravel HTTP/1.1 
Host: servicestack.agentivity.com 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"Account":["String"],"DateStart":"String","DateEnd":"String","FromAirportCode":"String","ToAirportCode":"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":[{"RecordLocator":"String","PNRCreationDate":"\/Date(-62135596800000-0000)\/","DepartureDate":"\/Date(-62135596800000-0000)\/","BoardPoint":"String","OffPoint":"String","PnrTicketed":"String","Account":"String","PaxList":"String","Connections":"String","CarrierCode":"String","FlightNumber":"String","TicketNumbers":["String"],"VendorLocators":[{"CarrierCode":"String","VendorLocator":"String"}],"PassengerInfo":[{"FirstName":"String","LastName":"String","PassengerDataId":0,"Tickets":[{"Number":"String","Type":"String"}]}],"DepartureDateTime":"\/Date(-62135596800000-0000)\/","CurrentArrivalDateTime":"\/Date(-62135596800000-0000)\/","AgentivityRef":0,"CustomFields":[{"FieldName":"String","FieldValue":"String"}]}],"ResponseError":{"ErrorCode":"String","Message":"String","StatusCode":"String","VerboseMessage":"String"}}