Agentivity API

<back to all web services

GetTicketsIssued

"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 TicketsIssued {
    /** @param {{RecordLocator?:string,TktNumber?:string,FOP?:string,Passenger?:string,Consultant?:string,RemarkText?:string,AirlineCode?:string,TravAgntID?:string,PCC?:string,PrintedCurrency?:string,FOPFare?:string,Date?:string,DueDate?:string,TicketingAgentID?:string,TicketingAgent?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    RecordLocator;
    /** @type {string} */
    TktNumber;
    /** @type {string} */
    FOP;
    /** @type {string} */
    Passenger;
    /** @type {string} */
    Consultant;
    /** @type {string} */
    RemarkText;
    /** @type {string} */
    AirlineCode;
    /** @type {string} */
    TravAgntID;
    /** @type {string} */
    PCC;
    /** @type {string} */
    PrintedCurrency;
    /** @type {string} */
    FOPFare;
    /** @type {string} */
    Date;
    /** @type {?string} */
    DueDate;
    /** @type {string} */
    TicketingAgentID;
    /** @type {string} */
    TicketingAgent;
}
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 TicketsIssuedByNumber {
    /** @param {{RecordLocator?:string,TktNumber?:string,PlatingCarrier?:string,Passenger?:string,IATA?:string,OwningAgencyLocationID?:string,IssueDate?:string,ExpirationDate?:string,FOPFare?:string,PrintedCurrency?:string,TicketingAgentID?:string,TicketingAgent?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    RecordLocator;
    /** @type {string} */
    TktNumber;
    /** @type {string} */
    PlatingCarrier;
    /** @type {string} */
    Passenger;
    /** @type {string} */
    IATA;
    /** @type {string} */
    OwningAgencyLocationID;
    /** @type {?string} */
    IssueDate;
    /** @type {?string} */
    ExpirationDate;
    /** @type {string} */
    FOPFare;
    /** @type {string} */
    PrintedCurrency;
    /** @type {string} */
    TicketingAgentID;
    /** @type {string} */
    TicketingAgent;
}
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?:TicketsIssuedByNumber[],ResponseError?:AgentivityError}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {ResponseMetadata} */
    ResponseMetadata;
    /** @type {TicketsIssuedByNumber[]} */
    ResponseReport;
    /** @type {AgentivityError} */
    ResponseError;
}
export class TicketsIssuedResponse extends CollectionResponse {
    /** @param {{ResponseMetadata?:ResponseMetadata,ResponseReport?:TicketsIssuedByNumber[],ResponseError?:AgentivityError}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
}
export class GetTicketsIssued extends CompanyLevelRequestBase {
    /** @param {{DateStart?:string,DateEnd?:string,IATA?:string,OwningAgencyLocationID?: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 */
    DateStart;
    /**
     * @type {string}
     * @description Date in format YYYYMMDD */
    DateEnd;
    /**
     * @type {string}
     * @description IATA code */
    IATA;
    /**
     * @type {string[]}
     * @description Comma Delimited List of PCCs */
    OwningAgencyLocationID;
}

JavaScript GetTicketsIssued DTOs

GET /TicketsIssued 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>
    <TicketsIssued>
      <RecordLocator>String</RecordLocator>
      <TktNumber>String</TktNumber>
      <FOP>String</FOP>
      <Passenger>String</Passenger>
      <Consultant>String</Consultant>
      <RemarkText>String</RemarkText>
      <AirlineCode>String</AirlineCode>
      <TravAgntID>String</TravAgntID>
      <PCC>String</PCC>
      <PrintedCurrency>String</PrintedCurrency>
      <FOPFare>String</FOPFare>
      <Date>0001-01-01T00:00:00</Date>
      <DueDate>0001-01-01T00:00:00</DueDate>
      <TicketingAgentID>String</TicketingAgentID>
      <TicketingAgent>String</TicketingAgent>
    </TicketsIssued>
  </ResponseReport>
  <ResponseError>
    <ErrorCode>String</ErrorCode>
    <Message>String</Message>
    <StatusCode>String</StatusCode>
    <VerboseMessage>String</VerboseMessage>
  </ResponseError>
</AgentivityResponse>