Agentivity API

<back to all web services

GetTicketDetails

using System;
using System.IO;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using AgentivityAPI.ServiceModel.Types;
using AgentivityAPI.ServiceModel.Base;
using AgentivityAPI.ServiceModel;

namespace AgentivityAPI.ServiceModel
{
    [DataContract(Name="AgentivityResponse", Namespace="schemas.agentivity.com/types")]
    public partial class ItemResponse<TItem, TReport>
    {
        [DataMember(Order=1)]
        public virtual ResponseMetadata ResponseMetadata { get; set; }

        [DataMember(Order=2, EmitDefaultValue=false)]
        public virtual TReport ResponseReport { get; set; }

        [DataMember(Order=3, EmitDefaultValue=false)]
        public virtual AgentivityError ResponseError { get; set; }
    }

    [DataContract(Namespace="schemas.agentivity.com/types")]
    public partial class Report<TItemResponse, TItem>
    {
        [DataMember(Order=1, EmitDefaultValue=false)]
        public virtual TItem Item { get; set; }
    }

}

namespace AgentivityAPI.ServiceModel.Base
{
    [DataContract(Namespace="schemas.agentivity.com/types")]
    public partial class CompanyLevelRequestBase
        : PagingMetadata, IMemberUsername, IMemberOwningCompanyCode
    {
        ///<summary>
        ///Comma Delimited List of Owning Company Codes
        ///</summary>
        [DataMember]
        public virtual string[] OwningCompanyCode { get; set; }

        ///<summary>
        ///UserName in form of an email address
        ///</summary>
        [DataMember]
        public virtual string UserName { get; set; }
    }

}

namespace AgentivityAPI.ServiceModel.Types
{
    [DataContract(Name="ResponseMetadata", Namespace="schemas.agentivity.com/types")]
    public partial class AgentivityError
    {
        [DataMember]
        public virtual string ErrorCode { get; set; }

        [DataMember]
        public virtual string Message { get; set; }

        [DataMember]
        public virtual string StatusCode { get; set; }

        [DataMember]
        public virtual string VerboseMessage { get; set; }
    }

    [DataContract(Name="CacheMetadata", Namespace="schemas.agentivity.com/types")]
    public partial class CacheMetadata
    {
        [DataMember(Order=1)]
        public virtual DateTime CachedAt { get; set; }

        [DataMember(Order=2)]
        public virtual DateTime CacheExpiresAt { get; set; }

        [DataMember(Order=0)]
        public virtual bool IsFromCache { get; set; }
    }

    [DataContract(Namespace="schemas.agentivity.com/types")]
    public partial class GetTicketDetails
        : CompanyLevelRequestBase, IRequestConsultantID
    {
        ///<summary>
        ///Ticket number
        ///</summary>
        [DataMember]
        public virtual string TktNumber { get; set; }

        ///<summary>
        ///Cache Guid
        ///</summary>
        [DataMember]
        public virtual string CacheGuid { get; set; }

        ///<summary>
        ///Request Consultant ID (sign on)
        ///</summary>
        [DataMember]
        public virtual string RequestConsultantID { get; set; }
    }

    [DataContract(Name="Metadata", Namespace="schemas.agentivity.com/types")]
    public partial class PagingMetadata
    {
        ///<summary>
        ///Starting Record
        ///</summary>
        [DataMember]
        [ApiMember(DataType="string", Description="Starting Record", Name="Offset", ParameterType="query")]
        public virtual string Offset { get; set; }

        ///<summary>
        ///Number of records to return (PageSize)
        ///</summary>
        [DataMember]
        [ApiMember(DataType="string", Description="Number of records to return (PageSize)", Name="Limit", ParameterType="query")]
        public virtual string Limit { get; set; }

        ///<summary>
        ///Total Number of Records in a Full Reponse (if no paging)
        ///</summary>
        [DataMember]
        [ApiMember(DataType="string", Description="Total Number of Records in a Full Reponse (if no paging)", Name="TotalRecords", ParameterType="query")]
        public virtual int TotalRecords { get; set; }

        ///<summary>
        ///Total Number of Records in this Reponse (on this page)
        ///</summary>
        [DataMember]
        [ApiMember(DataType="string", Description="Total Number of Records in this Reponse (on this page)", Name="ResponseRecords", ParameterType="query")]
        public virtual int ResponseRecords { get; set; }
    }

    [DataContract(Name="ResponseMetadata", Namespace="schemas.agentivity.com/types")]
    public partial class ResponseMetadata
    {
        [DataMember(Order=0)]
        public virtual bool Success { get; set; }

        [DataMember(Order=1)]
        public virtual bool HasCache { get; set; }

        [DataMember(Order=2)]
        public virtual bool HasPaging { get; set; }

        [DataMember(Order=3, EmitDefaultValue=false)]
        public virtual CacheMetadata CacheMetadata { get; set; }

        [DataMember(Order=4, EmitDefaultValue=false)]
        public virtual PagingMetadata PagingMetadata { get; set; }
    }

    [DataContract(Name="AgentivityResponse", Namespace="schemas.agentivity.com/types")]
    public partial class TicketDetailsItemResponse
        : ItemResponse<TicketInfo, TicketDetailsResponseReport>
    {
    }

    [DataContract(Name="TicketInfo", Namespace="schemas.agentivity.com/types")]
    public partial class TicketDetailsResponseReport
        : Report<TicketDetailsItemResponse, TicketInfo>
    {
    }

    [DataContract(Name="Exchange", Namespace="schemas.agentivity.com/types")]
    public partial class TicketExchange
    {
        [DataMember(Order=10)]
        public virtual string OriginalTktNumber { get; set; }
    }

    [DataContract(Name="TicketInfo", Namespace="schemas.agentivity.com/types")]
    public partial class TicketInfo
    {
        [DataMember(Order=5)]
        public virtual int PassengerTicketID { get; set; }

        [DataMember(Order=10)]
        public virtual string TktNumber { get; set; }

        [DataMember(Order=20)]
        public virtual string RecordLocator { get; set; }

        [DataMember(Order=30)]
        public virtual DateTime? PNRCreationDate { get; set; }

        [DataMember(Order=40)]
        public virtual DateTime? TktIssueDate { get; set; }

        [DataMember(Order=50)]
        public virtual string PlatingCarrier { get; set; }

        [DataMember(Order=60)]
        public virtual string Status { get; set; }

        [DataMember(Order=70)]
        public virtual string BAR { get; set; }

        [DataMember(Order=80)]
        public virtual string PAR { get; set; }

        [DataMember(Order=90)]
        public virtual string LastName { get; set; }

        [DataMember(Order=100)]
        public virtual string FirstName { get; set; }

        [DataMember(Order=110)]
        public virtual DateTime? TicketExpiryDate { get; set; }

        [DataMember(Order=120)]
        public virtual string FOP { get; set; }

        [DataMember(Order=130)]
        public virtual string FopFare { get; set; }

        [DataMember(Order=140)]
        public virtual string FOPCurrency { get; set; }

        [DataMember(Order=150)]
        public virtual string PrintedCurrency { get; set; }

        [DataMember(Order=160)]
        public virtual string PrintedFare { get; set; }

        [DataMember(Order=170)]
        public virtual string CreditCardFOPAcct { get; set; }

        [DataMember(Order=180)]
        public virtual string OwningAgencyLocationID { get; set; }

        [DataMember(Order=190)]
        public virtual string IATA { get; set; }

        [DataMember(Order=200)]
        public virtual List<TicketInfoFlightCoupon> Coupons { get; set; }

        [DataMember(Order=210)]
        public virtual bool EligibleForRefund { get; set; }

        [DataMember(Order=220)]
        public virtual bool EligibleForCovidStatus { get; set; }

        [DataMember(Order=230)]
        public virtual List<TicketExchange> TicketExchanges { get; set; }

        [DataMember(Order=240)]
        public virtual TicketTaxDetails Tax { get; set; }

        [DataMember(Order=500)]
        public virtual string OwningCompanyCode { get; set; }
    }

    [DataContract(Name="TicketInfoFlightCoupon", Namespace="schemas.agentivity.com/types")]
    public partial class TicketInfoFlightCoupon
    {
        [DataMember(Order=10)]
        public virtual string TktNumber { get; set; }

        [DataMember(Order=20)]
        public virtual int CouponSequenceNbr { get; set; }

        [DataMember(Order=20)]
        public virtual string Carrier { get; set; }

        [DataMember(Order=30)]
        public virtual string FlightNbr { get; set; }

        [DataMember(Order=40)]
        public virtual string BoardPoint { get; set; }

        [DataMember(Order=50)]
        public virtual string OffPoint { get; set; }

        [DataMember(Order=60)]
        public virtual string FlightServiceClass { get; set; }

        [DataMember(Order=70)]
        public virtual DateTime? FlightDate { get; set; }

        [DataMember(Order=80)]
        public virtual string FlightCouponStatus { get; set; }

        [DataMember(Order=90)]
        public virtual DateTime? DateLastChecked { get; set; }

        [DataMember(Order=100)]
        public virtual int AirTktSegId { get; set; }

        [DataMember(Order=110)]
        public virtual bool EligibleForRefund { get; set; }

        [DataMember(Order=120)]
        public virtual bool EligibleForCovidStatus { get; set; }

        [DataMember(Order=130)]
        public virtual string FareBasis { get; set; }
    }

    [DataContract(Name="Tax", Namespace="schemas.agentivity.com/types")]
    public partial class TicketTaxDetails
    {
        [DataMember(Order=10)]
        public virtual decimal? TotalAmt { get; set; }

        [DataMember(Order=20)]
        public virtual List<TicketTaxElement> TaxElements { get; set; }
    }

    [DataContract(Name="TaxElement", Namespace="schemas.agentivity.com/types")]
    public partial class TicketTaxElement
    {
        [DataMember(Order=10)]
        public virtual decimal? Amt { get; set; }

        [DataMember(Order=20)]
        public virtual string PrintedAmt { get; set; }

        [DataMember(Order=30)]
        public virtual string Code { get; set; }
    }

}

C# 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>