Agentivity API

<back to all web services

GetTicketDetails

The following routes are available for this service:
GET/TicketDetails/UserDepreciated, please use ticketdetails
GET/TicketDetails
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

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

HTTP + CSV

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: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
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":{"Item":{"PassengerTicketID":0,"TktNumber":"String","RecordLocator":"String","PNRCreationDate":"\/Date(-62135596800000-0000)\/","TktIssueDate":"\/Date(-62135596800000-0000)\/","PlatingCarrier":"String","Status":"String","BAR":"String","PAR":"String","LastName":"String","FirstName":"String","TicketExpiryDate":"\/Date(-62135596800000-0000)\/","FOP":"String","FopFare":"String","FOPCurrency":"String","PrintedCurrency":"String","PrintedFare":"String","CreditCardFOPAcct":"String","OwningAgencyLocationID":"String","IATA":"String","Coupons":[{"TktNumber":"String","CouponSequenceNbr":0,"Carrier":"String","FlightNbr":"String","BoardPoint":"String","OffPoint":"String","FlightServiceClass":"String","FlightDate":"\/Date(-62135596800000-0000)\/","FlightCouponStatus":"String","DateLastChecked":"\/Date(-62135596800000-0000)\/","AirTktSegId":0,"EligibleForRefund":false,"EligibleForCovidStatus":false,"FareBasis":"String"}],"EligibleForRefund":false,"EligibleForCovidStatus":false,"TicketExchanges":[{"OriginalTktNumber":"String"}],"Tax":{"TotalAmt":0,"TaxElements":[{"Amt":0,"PrintedAmt":"String","Code":"String"}]},"OwningCompanyCode":"String"}},"ResponseError":{"ErrorCode":"String","Message":"String","StatusCode":"String","VerboseMessage":"String"}}