Agentivity API

<back to all web services

GetBookingsWithActiveSegments

The following routes are available for this service:
All Verbs/BookingsWithActiveSegments
"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 BookingWithActiveSegments {
    /** @param {{AgentivityRef?:number,RecordLocator?:string,PNRCreationDate?:string,OwningAgencyLocationID?:string,Account?:string,OwningConsultantID?:string,OwningConsultant?:string,TravelDate?:string,Passenger?:string,PNRTicketed?:string,EmailAddress?:string,PhoneNbr?:string,HasAir?:boolean,HasHtl?:boolean,HasCar?:boolean,DestinationCities?:string,Connections?:string,CarrierCodes?:string,FlightNumbers?:string,IataCodes?:string,TicketNumbers?:string[],VendorLocators?:BookingExtVendorLocator[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    AgentivityRef;
    /** @type {string} */
    RecordLocator;
    /** @type {?string} */
    PNRCreationDate;
    /** @type {string} */
    OwningAgencyLocationID;
    /** @type {string} */
    Account;
    /** @type {string} */
    OwningConsultantID;
    /** @type {string} */
    OwningConsultant;
    /** @type {?string} */
    TravelDate;
    /** @type {string} */
    Passenger;
    /** @type {string} */
    PNRTicketed;
    /** @type {string} */
    EmailAddress;
    /** @type {string} */
    PhoneNbr;
    /** @type {boolean} */
    HasAir;
    /** @type {boolean} */
    HasHtl;
    /** @type {boolean} */
    HasCar;
    /** @type {string} */
    DestinationCities;
    /** @type {string} */
    Connections;
    /** @type {string} */
    CarrierCodes;
    /** @type {string} */
    FlightNumbers;
    /** @type {string} */
    IataCodes;
    /** @type {string[]} */
    TicketNumbers;
    /** @type {BookingExtVendorLocator[]} */
    VendorLocators;
}
/** @typedef TItemResponse {any} */
/** @typedef  TItem {any} */
export class Report {
    /** @param {{Item?:TItem}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {TItem} */
    Item;
}
export class GetBookingsWithActiveSegmentsResponseReport 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 GetBookingsWithActiveSegmentsItemResponse extends ItemResponse {
    /** @param {{ResponseMetadata?:ResponseMetadata,ResponseReport?:TReport,ResponseError?:AgentivityError}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
}
export class GetBookingsWithActiveSegments extends CompanyLevelRequestBase {
    /** @param {{TravelDateStart?:string,TravelDateEnd?:string,AllFutureDate?:boolean,Account?: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 */
    TravelDateStart;
    /**
     * @type {string}
     * @description Date in format YYYYMMDD */
    TravelDateEnd;
    /**
     * @type {boolean}
     * @description All future date */
    AllFutureDate;
    /**
     * @type {string[]}
     * @description Comma Delimited List of Accounts */
    Account;
}

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

{"TravelDateStart":"String","TravelDateEnd":"String","AllFutureDate":false,"Account":["String"],"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":{"AgentivityRef":0,"RecordLocator":"String","PNRCreationDate":"\/Date(-62135596800000-0000)\/","OwningAgencyLocationID":"String","Account":"String","OwningConsultantID":"String","OwningConsultant":"String","TravelDate":"\/Date(-62135596800000-0000)\/","Passenger":"String","PNRTicketed":"String","EmailAddress":"String","PhoneNbr":"String","HasAir":false,"HasHtl":false,"HasCar":false,"DestinationCities":"String","Connections":"String","CarrierCodes":"String","FlightNumbers":"String","IataCodes":"String","TicketNumbers":["String"],"VendorLocators":[{"CarrierCode":"String","VendorLocator":"String"}]}},"ResponseError":{"ErrorCode":"String","Message":"String","StatusCode":"String","VerboseMessage":"String"}}