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 .xml suffix or ?format=xml

HTTP + XML

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: application/xml

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<AgentivityResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="schemas.agentivity.com/types">
  <ResponseMetadata>
    <Success>false</Success>
    <HasCache>false</HasCache>
    <HasPaging>false</HasPaging>
    <CacheMetadata>
      <IsFromCache>false</IsFromCache>
      <CachedAt>0001-01-01T00:00:00</CachedAt>
      <CacheExpiresAt>0001-01-01T00:00:00</CacheExpiresAt>
    </CacheMetadata>
    <PagingMetadata>
      <Limit>String</Limit>
      <Offset>String</Offset>
      <ResponseRecords>0</ResponseRecords>
      <TotalRecords>0</TotalRecords>
    </PagingMetadata>
  </ResponseMetadata>
  <ResponseReport>
    <Item>
      <PassengerTicketID>0</PassengerTicketID>
      <TktNumber>String</TktNumber>
      <RecordLocator>String</RecordLocator>
      <PNRCreationDate>0001-01-01T00:00:00</PNRCreationDate>
      <TktIssueDate>0001-01-01T00:00:00</TktIssueDate>
      <PlatingCarrier>String</PlatingCarrier>
      <Status>String</Status>
      <BAR>String</BAR>
      <PAR>String</PAR>
      <LastName>String</LastName>
      <FirstName>String</FirstName>
      <TicketExpiryDate>0001-01-01T00:00:00</TicketExpiryDate>
      <FOP>String</FOP>
      <FopFare>String</FopFare>
      <FOPCurrency>String</FOPCurrency>
      <PrintedCurrency>String</PrintedCurrency>
      <PrintedFare>String</PrintedFare>
      <CreditCardFOPAcct>String</CreditCardFOPAcct>
      <OwningAgencyLocationID>String</OwningAgencyLocationID>
      <IATA>String</IATA>
      <Coupons>
        <TicketInfoFlightCoupon>
          <TktNumber>String</TktNumber>
          <Carrier>String</Carrier>
          <CouponSequenceNbr>0</CouponSequenceNbr>
          <FlightNbr>String</FlightNbr>
          <BoardPoint>String</BoardPoint>
          <OffPoint>String</OffPoint>
          <FlightServiceClass>String</FlightServiceClass>
          <FlightDate>0001-01-01T00:00:00</FlightDate>
          <FlightCouponStatus>String</FlightCouponStatus>
          <DateLastChecked>0001-01-01T00:00:00</DateLastChecked>
          <AirTktSegId>0</AirTktSegId>
          <EligibleForRefund>false</EligibleForRefund>
          <EligibleForCovidStatus>false</EligibleForCovidStatus>
          <FareBasis>String</FareBasis>
        </TicketInfoFlightCoupon>
      </Coupons>
      <EligibleForRefund>false</EligibleForRefund>
      <EligibleForCovidStatus>false</EligibleForCovidStatus>
      <TicketExchanges>
        <Exchange>
          <OriginalTktNumber>String</OriginalTktNumber>
        </Exchange>
      </TicketExchanges>
      <Tax>
        <TotalAmt>0</TotalAmt>
        <TaxElements>
          <TaxElement>
            <Amt>0</Amt>
            <PrintedAmt>String</PrintedAmt>
            <Code>String</Code>
          </TaxElement>
        </TaxElements>
      </Tax>
      <OwningCompanyCode>String</OwningCompanyCode>
    </Item>
  </ResponseReport>
  <ResponseError>
    <ErrorCode>String</ErrorCode>
    <Message>String</Message>
    <StatusCode>String</StatusCode>
    <VerboseMessage>String</VerboseMessage>
  </ResponseError>
</AgentivityResponse>