Agentivity API

<back to all web services

GetPnrInfo

The following routes are available for this service:
All Verbs/PNRInformation
"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 PnrInfoAirlineTicketingDue {
    /** @param {{Airline?:string,DueDate?:string,DueTime?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Airline;
    /** @type {?string} */
    DueDate;
    /** @type {string} */
    DueTime;
}
export class PnrInfoAgentivityWarning {
    /** @param {{Message?:string,Vendor?:string,Timestamp?:string,Details?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Message;
    /** @type {string} */
    Vendor;
    /** @type {?string} */
    Timestamp;
    /** @type {string} */
    Details;
}
export class PnrInfoSuspectedDuplicate {
    /** @param {{AgentivityRef?:number,RecordLocator?:string,PNRCreationDate?:string,DestinationCities?:string,Ticketed?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    AgentivityRef;
    /** @type {string} */
    RecordLocator;
    /** @type {?string} */
    PNRCreationDate;
    /** @type {string} */
    DestinationCities;
    /** @type {string} */
    Ticketed;
}
export class PnrInfo {
    /** @param {{AgentivityRef?:number,RecordLocator?:string,PNRCreationDate?:string,PNRTicketed?:string,OwningConsultantID?:string,OwningConsultant?:string,OwningAgencyLocationID?:string,Account?:string,HasDocs?:boolean,CountryCount?:number,Mobile?:string,CTCMMobile?:string,CTCE?:string,OutOfHoursServicedIndicator?:number,ChangeCount?:number,ItineraryChanges?:number,TripID?:string,AirlineTicketingDues?:PnrInfoAirlineTicketingDue[],AgentivityWarnings?:PnrInfoAgentivityWarning[],Cabin?:string,SuspectedDupeCount?:number,SuspectedDupes?:PnrInfoSuspectedDuplicate[],CarbonTonnage?:number,TravellerGUID?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {?number} */
    AgentivityRef;
    /** @type {string} */
    RecordLocator;
    /** @type {?string} */
    PNRCreationDate;
    /** @type {string} */
    PNRTicketed;
    /** @type {string} */
    OwningConsultantID;
    /** @type {string} */
    OwningConsultant;
    /** @type {string} */
    OwningAgencyLocationID;
    /** @type {string} */
    Account;
    /** @type {boolean} */
    HasDocs;
    /** @type {number} */
    CountryCount;
    /** @type {string} */
    Mobile;
    /** @type {string} */
    CTCMMobile;
    /** @type {string} */
    CTCE;
    /** @type {number} */
    OutOfHoursServicedIndicator;
    /** @type {number} */
    ChangeCount;
    /** @type {number} */
    ItineraryChanges;
    /** @type {string} */
    TripID;
    /** @type {PnrInfoAirlineTicketingDue[]} */
    AirlineTicketingDues;
    /** @type {PnrInfoAgentivityWarning[]} */
    AgentivityWarnings;
    /** @type {string} */
    Cabin;
    /** @type {number} */
    SuspectedDupeCount;
    /** @type {PnrInfoSuspectedDuplicate[]} */
    SuspectedDupes;
    /** @type {?number} */
    CarbonTonnage;
    /** @type {string} */
    TravellerGUID;
}
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 GetPnrInfoResponse extends CollectionResponse {
    /** @param {{ResponseMetadata?:ResponseMetadata,ResponseReport?:ApiRequestPerHour[],ResponseError?:AgentivityError}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
}
export class GetPnrInfo extends PagingMetadata {
    /** @param {{RecordLocator?:string,PNRCreationDate?:string,RequestConsultantID?:string,Offset?:string,Limit?:string,TotalRecords?:number,ResponseRecords?:number}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /**
     * @type {string}
     * @description Record locator */
    RecordLocator;
    /**
     * @type {string}
     * @description Date in format YYYYMMDD */
    PNRCreationDate;
    /**
     * @type {string}
     * @description Request Consultant ID (sign on) */
    RequestConsultantID;
}

JavaScript GetPnrInfo DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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

POST /PNRInformation HTTP/1.1 
Host: api.agentivity.com 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"RecordLocator":"String","PNRCreationDate":"String","RequestConsultantID":"String","Offset":"String","Limit":"String","TotalRecords":0,"ResponseRecords":0}

HTTP/1.1 200 OK
Content-Type: application/json
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":[{"AgentivityRef":0,"RecordLocator":"String","PNRCreationDate":"\/Date(-62135596800000-0000)\/","PNRTicketed":"String","OwningConsultantID":"String","OwningConsultant":"String","OwningAgencyLocationID":"String","Account":"String","HasDocs":false,"CountryCount":0,"Mobile":"String","CTCMMobile":"String","CTCE":"String","OutOfHoursServicedIndicator":0,"ChangeCount":0,"ItineraryChanges":0,"TripID":"String","AirlineTicketingDues":[{"Airline":"String","DueDate":"\/Date(-62135596800000-0000)\/","DueTime":"String"}],"AgentivityWarnings":[{"Message":"String","Vendor":"String","Timestamp":"\/Date(-62135596800000-0000)\/","Details":"String"}],"Cabin":"String","SuspectedDupeCount":0,"SuspectedDupes":[{"AgentivityRef":0,"RecordLocator":"String","PNRCreationDate":"\/Date(-62135596800000-0000)\/","DestinationCities":"String","Ticketed":"String"}],"CarbonTonnage":0,"TravellerGUID":"String"}],"ResponseError":{"ErrorCode":"String","Message":"String","StatusCode":"String","VerboseMessage":"String"}}