Agentivity API

<back to all web services

GetTicketDetails

The following routes are available for this service:
GET/TicketDetails/UserDepreciated, please use ticketdetails
GET/TicketDetails
import java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*


@DataContract(Namespace="schemas.agentivity.com/types")
open class GetTicketDetails : CompanyLevelRequestBase(), IRequestConsultantID
{
    /**
    * Ticket number
    */
    @DataMember
    open var TktNumber:String? = null

    /**
    * Cache Guid
    */
    @DataMember
    open var CacheGuid:String? = null

    /**
    * Request Consultant ID (sign on)
    */
    @DataMember
    override var RequestConsultantID:String? = null
}

@DataContract(Namespace="schemas.agentivity.com/types")
open class CompanyLevelRequestBase : PagingMetadata(), IMemberUsername, IMemberOwningCompanyCode
{
    /**
    * Comma Delimited List of Owning Company Codes
    */
    @DataMember
    override var OwningCompanyCode:ArrayList<String>? = null

    /**
    * UserName in form of an email address
    */
    @DataMember
    override var UserName:String? = null
}

@DataContract(Name="Metadata", Namespace="schemas.agentivity.com/types")
open class PagingMetadata
{
    /**
    * Starting Record
    */
    @DataMember
    @ApiMember(DataType="string", Description="Starting Record", Name="Offset", ParameterType="query")
    open var Offset:String? = null

    /**
    * Number of records to return (PageSize)
    */
    @DataMember
    @ApiMember(DataType="string", Description="Number of records to return (PageSize)", Name="Limit", ParameterType="query")
    open var Limit:String? = null

    /**
    * 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")
    open var TotalRecords:Int? = null

    /**
    * 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")
    open var ResponseRecords:Int? = null
}

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

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

    @DataMember(Order=2, EmitDefaultValue=false)
    open var ResponseReport:TReport? = null

    @DataMember(Order=3, EmitDefaultValue=false)
    open var ResponseError:AgentivityError? = null
}

@DataContract(Name="ResponseMetadata", Namespace="schemas.agentivity.com/types")
open class ResponseMetadata
{
    @DataMember(Order=0)
    open var Success:Boolean? = null

    @DataMember(Order=1)
    open var HasCache:Boolean? = null

    @DataMember(Order=2)
    open var HasPaging:Boolean? = null

    @DataMember(Order=3, EmitDefaultValue=false)
    open var CacheMetadata:CacheMetadata? = null

    @DataMember(Order=4, EmitDefaultValue=false)
    open var PagingMetadata:PagingMetadata? = null
}

@DataContract(Name="CacheMetadata", Namespace="schemas.agentivity.com/types")
open class CacheMetadata
{
    @DataMember(Order=1)
    open var CachedAt:Date? = null

    @DataMember(Order=2)
    open var CacheExpiresAt:Date? = null

    @DataMember(Order=0)
    open var IsFromCache:Boolean? = null
}

@DataContract(Name="ResponseMetadata", Namespace="schemas.agentivity.com/types")
open class AgentivityError
{
    @DataMember
    open var ErrorCode:String? = null

    @DataMember
    open var Message:String? = null

    @DataMember
    open var StatusCode:String? = null

    @DataMember
    open var VerboseMessage:String? = null
}

@DataContract(Name="TicketInfo", Namespace="schemas.agentivity.com/types")
open class TicketInfo
{
    @DataMember(Order=5)
    open var PassengerTicketID:Int? = null

    @DataMember(Order=10)
    open var TktNumber:String? = null

    @DataMember(Order=20)
    open var RecordLocator:String? = null

    @DataMember(Order=30)
    open var PNRCreationDate:Date? = null

    @DataMember(Order=40)
    open var TktIssueDate:Date? = null

    @DataMember(Order=50)
    open var PlatingCarrier:String? = null

    @DataMember(Order=60)
    open var Status:String? = null

    @DataMember(Order=70)
    open var BAR:String? = null

    @DataMember(Order=80)
    open var PAR:String? = null

    @DataMember(Order=90)
    open var LastName:String? = null

    @DataMember(Order=100)
    open var FirstName:String? = null

    @DataMember(Order=110)
    open var TicketExpiryDate:Date? = null

    @DataMember(Order=120)
    open var FOP:String? = null

    @DataMember(Order=130)
    open var FopFare:String? = null

    @DataMember(Order=140)
    open var FOPCurrency:String? = null

    @DataMember(Order=150)
    open var PrintedCurrency:String? = null

    @DataMember(Order=160)
    open var PrintedFare:String? = null

    @DataMember(Order=170)
    open var CreditCardFOPAcct:String? = null

    @DataMember(Order=180)
    open var OwningAgencyLocationID:String? = null

    @DataMember(Order=190)
    open var IATA:String? = null

    @DataMember(Order=200)
    open var Coupons:ArrayList<TicketInfoFlightCoupon>? = null

    @DataMember(Order=210)
    open var EligibleForRefund:Boolean? = null

    @DataMember(Order=220)
    open var EligibleForCovidStatus:Boolean? = null

    @DataMember(Order=230)
    open var TicketExchanges:ArrayList<TicketExchange>? = null

    @DataMember(Order=240)
    open var Tax:TicketTaxDetails? = null

    @DataMember(Order=500)
    open var OwningCompanyCode:String? = null
}

@DataContract(Name="TicketInfoFlightCoupon", Namespace="schemas.agentivity.com/types")
open class TicketInfoFlightCoupon
{
    @DataMember(Order=10)
    open var TktNumber:String? = null

    @DataMember(Order=20)
    open var CouponSequenceNbr:Int? = null

    @DataMember(Order=20)
    open var Carrier:String? = null

    @DataMember(Order=30)
    open var FlightNbr:String? = null

    @DataMember(Order=40)
    open var BoardPoint:String? = null

    @DataMember(Order=50)
    open var OffPoint:String? = null

    @DataMember(Order=60)
    open var FlightServiceClass:String? = null

    @DataMember(Order=70)
    open var FlightDate:Date? = null

    @DataMember(Order=80)
    open var FlightCouponStatus:String? = null

    @DataMember(Order=90)
    open var DateLastChecked:Date? = null

    @DataMember(Order=100)
    open var AirTktSegId:Int? = null

    @DataMember(Order=110)
    open var EligibleForRefund:Boolean? = null

    @DataMember(Order=120)
    open var EligibleForCovidStatus:Boolean? = null

    @DataMember(Order=130)
    open var FareBasis:String? = null
}

@DataContract(Name="Exchange", Namespace="schemas.agentivity.com/types")
open class TicketExchange
{
    @DataMember(Order=10)
    open var OriginalTktNumber:String? = null
}

@DataContract(Name="Tax", Namespace="schemas.agentivity.com/types")
open class TicketTaxDetails
{
    @DataMember(Order=10)
    open var TotalAmt:BigDecimal? = null

    @DataMember(Order=20)
    open var TaxElements:ArrayList<TicketTaxElement>? = null
}

@DataContract(Name="TaxElement", Namespace="schemas.agentivity.com/types")
open class TicketTaxElement
{
    @DataMember(Order=10)
    open var Amt:BigDecimal? = null

    @DataMember(Order=20)
    open var PrintedAmt:String? = null

    @DataMember(Order=30)
    open var Code:String? = null
}

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

@DataContract(Namespace="schemas.agentivity.com/types")
open class Report<TItemResponse, TItem>
{
    @DataMember(Order=1, EmitDefaultValue=false)
    open var Item:TItem? = null
}

Kotlin GetTicketDetails DTOs

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

HTTP + OTHER

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/jsonl

HTTP/1.1 200 OK
Content-Type: text/jsonl
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"}}