Agentivity API

<back to all web services

GetTicketDetails

// @DataContract(Name="Metadata", Namespace="schemas.agentivity.com/types")
export class PagingMetadata
{
    /** @description Starting Record */
    // @DataMember
    // @ApiMember(DataType="string", Description="Starting Record", Name="Offset", ParameterType="query")
    public Offset: string;

    /** @description Number of records to return (PageSize) */
    // @DataMember
    // @ApiMember(DataType="string", Description="Number of records to return (PageSize)", Name="Limit", ParameterType="query")
    public Limit: string;

    /** @description Total Number of Records in a Full Reponse (if no paging) */
    // @DataMember
    // @ApiMember(DataType="string", Description="Total Number of Records in a Full Reponse (if no paging)", Name="TotalRecords", ParameterType="query")
    public TotalRecords: number;

    /** @description Total Number of Records in this Reponse (on this page) */
    // @DataMember
    // @ApiMember(DataType="string", Description="Total Number of Records in this Reponse (on this page)", Name="ResponseRecords", ParameterType="query")
    public ResponseRecords: number;

    public constructor(init?: Partial<PagingMetadata>) { (Object as any).assign(this, init); }
}

// @DataContract(Namespace="schemas.agentivity.com/types")
export class CompanyLevelRequestBase extends PagingMetadata implements IMemberUsername, IMemberOwningCompanyCode
{
    /** @description Comma Delimited List of Owning Company Codes */
    // @DataMember
    public OwningCompanyCode: string[];

    /** @description UserName in form of an email address */
    // @DataMember
    public UserName: string;

    public constructor(init?: Partial<CompanyLevelRequestBase>) { super(init); (Object as any).assign(this, init); }
}

// @DataContract(Name="TicketInfoFlightCoupon", Namespace="schemas.agentivity.com/types")
export class TicketInfoFlightCoupon
{
    // @DataMember(Order=10)
    public TktNumber: string;

    // @DataMember(Order=20)
    public CouponSequenceNbr: number;

    // @DataMember(Order=20)
    public Carrier: string;

    // @DataMember(Order=30)
    public FlightNbr: string;

    // @DataMember(Order=40)
    public BoardPoint: string;

    // @DataMember(Order=50)
    public OffPoint: string;

    // @DataMember(Order=60)
    public FlightServiceClass: string;

    // @DataMember(Order=70)
    public FlightDate?: string;

    // @DataMember(Order=80)
    public FlightCouponStatus: string;

    // @DataMember(Order=90)
    public DateLastChecked?: string;

    // @DataMember(Order=100)
    public AirTktSegId: number;

    // @DataMember(Order=110)
    public EligibleForRefund: boolean;

    // @DataMember(Order=120)
    public EligibleForCovidStatus: boolean;

    // @DataMember(Order=130)
    public FareBasis: string;

    public constructor(init?: Partial<TicketInfoFlightCoupon>) { (Object as any).assign(this, init); }
}

// @DataContract(Name="Exchange", Namespace="schemas.agentivity.com/types")
export class TicketExchange
{
    // @DataMember(Order=10)
    public OriginalTktNumber: string;

    public constructor(init?: Partial<TicketExchange>) { (Object as any).assign(this, init); }
}

// @DataContract(Name="TaxElement", Namespace="schemas.agentivity.com/types")
export class TicketTaxElement
{
    // @DataMember(Order=10)
    public Amt?: number;

    // @DataMember(Order=20)
    public PrintedAmt: string;

    // @DataMember(Order=30)
    public Code: string;

    public constructor(init?: Partial<TicketTaxElement>) { (Object as any).assign(this, init); }
}

// @DataContract(Name="Tax", Namespace="schemas.agentivity.com/types")
export class TicketTaxDetails
{
    // @DataMember(Order=10)
    public TotalAmt?: number;

    // @DataMember(Order=20)
    public TaxElements: TicketTaxElement[];

    public constructor(init?: Partial<TicketTaxDetails>) { (Object as any).assign(this, init); }
}

// @DataContract(Name="TicketInfo", Namespace="schemas.agentivity.com/types")
export class TicketInfo
{
    // @DataMember(Order=5)
    public PassengerTicketID: number;

    // @DataMember(Order=10)
    public TktNumber: string;

    // @DataMember(Order=20)
    public RecordLocator: string;

    // @DataMember(Order=30)
    public PNRCreationDate?: string;

    // @DataMember(Order=40)
    public TktIssueDate?: string;

    // @DataMember(Order=50)
    public PlatingCarrier: string;

    // @DataMember(Order=60)
    public Status: string;

    // @DataMember(Order=70)
    public BAR: string;

    // @DataMember(Order=80)
    public PAR: string;

    // @DataMember(Order=90)
    public LastName: string;

    // @DataMember(Order=100)
    public FirstName: string;

    // @DataMember(Order=110)
    public TicketExpiryDate?: string;

    // @DataMember(Order=120)
    public FOP: string;

    // @DataMember(Order=130)
    public FopFare: string;

    // @DataMember(Order=140)
    public FOPCurrency: string;

    // @DataMember(Order=150)
    public PrintedCurrency: string;

    // @DataMember(Order=160)
    public PrintedFare: string;

    // @DataMember(Order=170)
    public CreditCardFOPAcct: string;

    // @DataMember(Order=180)
    public OwningAgencyLocationID: string;

    // @DataMember(Order=190)
    public IATA: string;

    // @DataMember(Order=200)
    public Coupons: TicketInfoFlightCoupon[];

    // @DataMember(Order=210)
    public EligibleForRefund: boolean;

    // @DataMember(Order=220)
    public EligibleForCovidStatus: boolean;

    // @DataMember(Order=230)
    public TicketExchanges: TicketExchange[];

    // @DataMember(Order=240)
    public Tax: TicketTaxDetails;

    // @DataMember(Order=500)
    public OwningCompanyCode: string;

    public constructor(init?: Partial<TicketInfo>) { (Object as any).assign(this, init); }
}

// @DataContract(Namespace="schemas.agentivity.com/types")
export class Report<TItemResponse, TItem>
{
    // @DataMember(Order=1, EmitDefaultValue=false)
    public Item: TItem;

    public constructor(init?: Partial<Report<TItemResponse, TItem>>) { (Object as any).assign(this, init); }
}

// @DataContract(Name="TicketInfo", Namespace="schemas.agentivity.com/types")
export class TicketDetailsResponseReport extends Report<TicketDetailsItemResponse, TicketInfo>
{

    public constructor(init?: Partial<TicketDetailsResponseReport>) { super(init); (Object as any).assign(this, init); }
}

// @DataContract(Name="CacheMetadata", Namespace="schemas.agentivity.com/types")
export class CacheMetadata
{
    // @DataMember(Order=1)
    public CachedAt: string;

    // @DataMember(Order=2)
    public CacheExpiresAt: string;

    // @DataMember(Order=0)
    public IsFromCache: boolean;

    public constructor(init?: Partial<CacheMetadata>) { (Object as any).assign(this, init); }
}

// @DataContract(Name="ResponseMetadata", Namespace="schemas.agentivity.com/types")
export class ResponseMetadata
{
    // @DataMember(Order=0)
    public Success: boolean;

    // @DataMember(Order=1)
    public HasCache: boolean;

    // @DataMember(Order=2)
    public HasPaging: boolean;

    // @DataMember(Order=3, EmitDefaultValue=false)
    public CacheMetadata: CacheMetadata;

    // @DataMember(Order=4, EmitDefaultValue=false)
    public PagingMetadata: PagingMetadata;

    public constructor(init?: Partial<ResponseMetadata>) { (Object as any).assign(this, init); }
}

// @DataContract(Name="ResponseMetadata", Namespace="schemas.agentivity.com/types")
export class AgentivityError
{
    // @DataMember
    public ErrorCode: string;

    // @DataMember
    public Message: string;

    // @DataMember
    public StatusCode: string;

    // @DataMember
    public VerboseMessage: string;

    public constructor(init?: Partial<AgentivityError>) { (Object as any).assign(this, init); }
}

// @DataContract(Name="AgentivityResponse", Namespace="schemas.agentivity.com/types")
export class ItemResponse<TItem, TReport>
{
    // @DataMember(Order=1)
    public ResponseMetadata: ResponseMetadata;

    // @DataMember(Order=2, EmitDefaultValue=false)
    public ResponseReport: TReport;

    // @DataMember(Order=3, EmitDefaultValue=false)
    public ResponseError: AgentivityError;

    public constructor(init?: Partial<ItemResponse<TItem, TReport>>) { (Object as any).assign(this, init); }
}

// @DataContract(Name="AgentivityResponse", Namespace="schemas.agentivity.com/types")
export class TicketDetailsItemResponse extends ItemResponse<TicketInfo, TicketDetailsResponseReport>
{

    public constructor(init?: Partial<TicketDetailsItemResponse>) { super(init); (Object as any).assign(this, init); }
}

// @DataContract(Namespace="schemas.agentivity.com/types")
export class GetTicketDetails extends CompanyLevelRequestBase implements IRequestConsultantID
{
    /** @description Ticket number */
    // @DataMember
    public TktNumber: string;

    /** @description Cache Guid */
    // @DataMember
    public CacheGuid: string;

    /** @description Request Consultant ID (sign on) */
    // @DataMember
    public RequestConsultantID: string;

    public constructor(init?: Partial<GetTicketDetails>) { super(init); (Object as any).assign(this, init); }
}

TypeScript GetTicketDetails DTOs

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>