Agentivity API

<back to all web services

GetTicketDetails

The following routes are available for this service:
GET/TicketDetails/UserDepreciated, please use ticketdetails
GET/TicketDetails
"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 TicketInfoFlightCoupon {
    /** @param {{TktNumber?:string,CouponSequenceNbr?:number,Carrier?:string,FlightNbr?:string,BoardPoint?:string,OffPoint?:string,FlightServiceClass?:string,FlightDate?:string,FlightCouponStatus?:string,DateLastChecked?:string,AirTktSegId?:number,EligibleForRefund?:boolean,EligibleForCovidStatus?:boolean,FareBasis?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    TktNumber;
    /** @type {number} */
    CouponSequenceNbr;
    /** @type {string} */
    Carrier;
    /** @type {string} */
    FlightNbr;
    /** @type {string} */
    BoardPoint;
    /** @type {string} */
    OffPoint;
    /** @type {string} */
    FlightServiceClass;
    /** @type {?string} */
    FlightDate;
    /** @type {string} */
    FlightCouponStatus;
    /** @type {?string} */
    DateLastChecked;
    /** @type {number} */
    AirTktSegId;
    /** @type {boolean} */
    EligibleForRefund;
    /** @type {boolean} */
    EligibleForCovidStatus;
    /** @type {string} */
    FareBasis;
}
export class TicketExchange {
    /** @param {{OriginalTktNumber?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    OriginalTktNumber;
}
export class TicketTaxElement {
    /** @param {{Amt?:number,PrintedAmt?:string,Code?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {?number} */
    Amt;
    /** @type {string} */
    PrintedAmt;
    /** @type {string} */
    Code;
}
export class TicketTaxDetails {
    /** @param {{TotalAmt?:number,TaxElements?:TicketTaxElement[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {?number} */
    TotalAmt;
    /** @type {TicketTaxElement[]} */
    TaxElements;
}
export class TicketInfo {
    /** @param {{PassengerTicketID?:number,TktNumber?:string,RecordLocator?:string,PNRCreationDate?:string,TktIssueDate?:string,PlatingCarrier?:string,Status?:string,BAR?:string,PAR?:string,LastName?:string,FirstName?:string,TicketExpiryDate?:string,FOP?:string,FopFare?:string,FOPCurrency?:string,PrintedCurrency?:string,PrintedFare?:string,CreditCardFOPAcct?:string,OwningAgencyLocationID?:string,IATA?:string,Coupons?:TicketInfoFlightCoupon[],EligibleForRefund?:boolean,EligibleForCovidStatus?:boolean,TicketExchanges?:TicketExchange[],Tax?:TicketTaxDetails,OwningCompanyCode?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    PassengerTicketID;
    /** @type {string} */
    TktNumber;
    /** @type {string} */
    RecordLocator;
    /** @type {?string} */
    PNRCreationDate;
    /** @type {?string} */
    TktIssueDate;
    /** @type {string} */
    PlatingCarrier;
    /** @type {string} */
    Status;
    /** @type {string} */
    BAR;
    /** @type {string} */
    PAR;
    /** @type {string} */
    LastName;
    /** @type {string} */
    FirstName;
    /** @type {?string} */
    TicketExpiryDate;
    /** @type {string} */
    FOP;
    /** @type {string} */
    FopFare;
    /** @type {string} */
    FOPCurrency;
    /** @type {string} */
    PrintedCurrency;
    /** @type {string} */
    PrintedFare;
    /** @type {string} */
    CreditCardFOPAcct;
    /** @type {string} */
    OwningAgencyLocationID;
    /** @type {string} */
    IATA;
    /** @type {TicketInfoFlightCoupon[]} */
    Coupons;
    /** @type {boolean} */
    EligibleForRefund;
    /** @type {boolean} */
    EligibleForCovidStatus;
    /** @type {TicketExchange[]} */
    TicketExchanges;
    /** @type {TicketTaxDetails} */
    Tax;
    /** @type {string} */
    OwningCompanyCode;
}
/** @typedef TItemResponse {any} */
/** @typedef  TItem {any} */
export class Report {
    /** @param {{Item?:TItem}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {TItem} */
    Item;
}
export class TicketDetailsResponseReport 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 TicketDetailsItemResponse extends ItemResponse {
    /** @param {{ResponseMetadata?:ResponseMetadata,ResponseReport?:TReport,ResponseError?:AgentivityError}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
}
export class GetTicketDetails extends CompanyLevelRequestBase {
    /** @param {{TktNumber?:string,CacheGuid?:string,RequestConsultantID?: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 Ticket number */
    TktNumber;
    /**
     * @type {string}
     * @description Cache Guid */
    CacheGuid;
    /**
     * @type {string}
     * @description Request Consultant ID (sign on) */
    RequestConsultantID;
}

JavaScript GetTicketDetails 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.

GET /TicketDetails/User HTTP/1.1 
Host: api.agentivity.com 
Accept: text/csv

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":{"PassengerTicketID":0,"TktNumber":"String","RecordLocator":"String","PNRCreationDate":"\/Date(-62135596800000-0000)\/","TktIssueDate":"\/Date(-62135596800000-0000)\/","PlatingCarrier":"String","Status":"String","BAR":"String","PAR":"String","LastName":"String","FirstName":"String","TicketExpiryDate":"\/Date(-62135596800000-0000)\/","FOP":"String","FopFare":"String","FOPCurrency":"String","PrintedCurrency":"String","PrintedFare":"String","CreditCardFOPAcct":"String","OwningAgencyLocationID":"String","IATA":"String","Coupons":[{"TktNumber":"String","CouponSequenceNbr":0,"Carrier":"String","FlightNbr":"String","BoardPoint":"String","OffPoint":"String","FlightServiceClass":"String","FlightDate":"\/Date(-62135596800000-0000)\/","FlightCouponStatus":"String","DateLastChecked":"\/Date(-62135596800000-0000)\/","AirTktSegId":0,"EligibleForRefund":false,"EligibleForCovidStatus":false,"FareBasis":"String"}],"EligibleForRefund":false,"EligibleForCovidStatus":false,"TicketExchanges":[{"OriginalTktNumber":"String"}],"Tax":{"TotalAmt":0,"TaxElements":[{"Amt":0,"PrintedAmt":"String","Code":"String"}]},"OwningCompanyCode":"String"}},"ResponseError":{"ErrorCode":"String","Message":"String","StatusCode":"String","VerboseMessage":"String"}}