Agentivity API

GetTicketDetails

The following routes are available for this service:
GET	/TicketDetails/User		Depreciated, please use ticketdetails
GET	/TicketDetails

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

Namespace Global

    Namespace AgentivityAPI.ServiceModel

        <DataContract(Name:="AgentivityResponse", Namespace:="schemas.agentivity.com/types")>
        Public Partial Class ItemResponse(Of TItem, TReport)
            <DataMember(Order:=1)>
            Public Overridable Property ResponseMetadata As ResponseMetadata

            <DataMember(Order:=2, EmitDefaultValue:=false)>
            Public Overridable Property ResponseReport As TReport

            <DataMember(Order:=3, EmitDefaultValue:=false)>
            Public Overridable Property ResponseError As AgentivityError
        End Class

        <DataContract(Namespace:="schemas.agentivity.com/types")>
        Public Partial Class Report(Of TItemResponse, TItem)
            <DataMember(Order:=1, EmitDefaultValue:=false)>
            Public Overridable Property Item As TItem
        End Class
    End Namespace

    Namespace AgentivityAPI.ServiceModel.Base

        <DataContract(Namespace:="schemas.agentivity.com/types")>
        Public Partial Class CompanyLevelRequestBase
            Inherits PagingMetadata
            Implements IMemberUsername
            Implements IMemberOwningCompanyCode
            '''<Summary>
            '''Comma Delimited List of Owning Company Codes
            '''</Summary>
            <DataMember>
            Public Overridable Property OwningCompanyCode As String() Implements IMemberOwningCompanyCode.OwningCompanyCode

            '''<Summary>
            '''UserName in form of an email address
            '''</Summary>
            <DataMember>
            Public Overridable Property UserName As String Implements IMemberUsername.UserName
        End Class
    End Namespace

    Namespace AgentivityAPI.ServiceModel.Types

        <DataContract(Name:="ResponseMetadata", Namespace:="schemas.agentivity.com/types")>
        Public Partial Class AgentivityError
            <DataMember>
            Public Overridable Property ErrorCode As String

            <DataMember>
            Public Overridable Property Message As String

            <DataMember>
            Public Overridable Property StatusCode As String

            <DataMember>
            Public Overridable Property VerboseMessage As String
        End Class

        <DataContract(Name:="CacheMetadata", Namespace:="schemas.agentivity.com/types")>
        Public Partial Class CacheMetadata
            <DataMember(Order:=1)>
            Public Overridable Property CachedAt As Date

            <DataMember(Order:=2)>
            Public Overridable Property CacheExpiresAt As Date

            <DataMember(Order:=0)>
            Public Overridable Property IsFromCache As Boolean
        End Class

        <DataContract(Namespace:="schemas.agentivity.com/types")>
        Public Partial Class GetTicketDetails
            Inherits CompanyLevelRequestBase
            Implements IRequestConsultantID
            '''<Summary>
            '''Ticket number
            '''</Summary>
            <DataMember>
            Public Overridable Property TktNumber As String

            '''<Summary>
            '''Cache Guid
            '''</Summary>
            <DataMember>
            Public Overridable Property CacheGuid As String

            '''<Summary>
            '''Request Consultant ID (sign on)
            '''</Summary>
            <DataMember>
            Public Overridable Property RequestConsultantID As String Implements IRequestConsultantID.RequestConsultantID
        End Class

        <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 Overridable Property Offset As String

            '''<Summary>
            '''Number of records to return (PageSize)
            '''</Summary>
            <DataMember>
            <ApiMember(DataType:="string", Description:="Number of records to return (PageSize)", Name:="Limit", ParameterType:="query")>
            Public Overridable Property Limit As String

            '''<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 Overridable Property TotalRecords As Integer

            '''<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 Overridable Property ResponseRecords As Integer
        End Class

        <DataContract(Name:="ResponseMetadata", Namespace:="schemas.agentivity.com/types")>
        Public Partial Class ResponseMetadata
            <DataMember(Order:=0)>
            Public Overridable Property Success As Boolean

            <DataMember(Order:=1)>
            Public Overridable Property HasCache As Boolean

            <DataMember(Order:=2)>
            Public Overridable Property HasPaging As Boolean

            <DataMember(Order:=3, EmitDefaultValue:=false)>
            Public Overridable Property CacheMetadata As CacheMetadata

            <DataMember(Order:=4, EmitDefaultValue:=false)>
            Public Overridable Property PagingMetadata As PagingMetadata
        End Class

        <DataContract(Name:="AgentivityResponse", Namespace:="schemas.agentivity.com/types")>
        Public Partial Class TicketDetailsItemResponse
            Inherits ItemResponse(Of TicketInfo, TicketDetailsResponseReport)
        End Class

        <DataContract(Name:="TicketInfo", Namespace:="schemas.agentivity.com/types")>
        Public Partial Class TicketDetailsResponseReport
            Inherits Report(Of TicketDetailsItemResponse, TicketInfo)
        End Class

        <DataContract(Name:="Exchange", Namespace:="schemas.agentivity.com/types")>
        Public Partial Class TicketExchange
            <DataMember(Order:=10)>
            Public Overridable Property OriginalTktNumber As String
        End Class

        <DataContract(Name:="TicketInfo", Namespace:="schemas.agentivity.com/types")>
        Public Partial Class TicketInfo
            <DataMember(Order:=5)>
            Public Overridable Property PassengerTicketID As Integer

            <DataMember(Order:=10)>
            Public Overridable Property TktNumber As String

            <DataMember(Order:=20)>
            Public Overridable Property RecordLocator As String

            <DataMember(Order:=30)>
            Public Overridable Property PNRCreationDate As Date?

            <DataMember(Order:=40)>
            Public Overridable Property TktIssueDate As Date?

            <DataMember(Order:=50)>
            Public Overridable Property PlatingCarrier As String

            <DataMember(Order:=60)>
            Public Overridable Property Status As String

            <DataMember(Order:=70)>
            Public Overridable Property BAR As String

            <DataMember(Order:=80)>
            Public Overridable Property PAR As String

            <DataMember(Order:=90)>
            Public Overridable Property LastName As String

            <DataMember(Order:=100)>
            Public Overridable Property FirstName As String

            <DataMember(Order:=110)>
            Public Overridable Property TicketExpiryDate As Date?

            <DataMember(Order:=120)>
            Public Overridable Property FOP As String

            <DataMember(Order:=130)>
            Public Overridable Property FopFare As String

            <DataMember(Order:=140)>
            Public Overridable Property FOPCurrency As String

            <DataMember(Order:=150)>
            Public Overridable Property PrintedCurrency As String

            <DataMember(Order:=160)>
            Public Overridable Property PrintedFare As String

            <DataMember(Order:=170)>
            Public Overridable Property CreditCardFOPAcct As String

            <DataMember(Order:=180)>
            Public Overridable Property OwningAgencyLocationID As String

            <DataMember(Order:=190)>
            Public Overridable Property IATA As String

            <DataMember(Order:=200)>
            Public Overridable Property Coupons As List(Of TicketInfoFlightCoupon)

            <DataMember(Order:=210)>
            Public Overridable Property EligibleForRefund As Boolean

            <DataMember(Order:=220)>
            Public Overridable Property EligibleForCovidStatus As Boolean

            <DataMember(Order:=230)>
            Public Overridable Property TicketExchanges As List(Of TicketExchange)

            <DataMember(Order:=240)>
            Public Overridable Property Tax As TicketTaxDetails

            <DataMember(Order:=500)>
            Public Overridable Property OwningCompanyCode As String
        End Class

        <DataContract(Name:="TicketInfoFlightCoupon", Namespace:="schemas.agentivity.com/types")>
        Public Partial Class TicketInfoFlightCoupon
            <DataMember(Order:=10)>
            Public Overridable Property TktNumber As String

            <DataMember(Order:=20)>
            Public Overridable Property CouponSequenceNbr As Integer

            <DataMember(Order:=20)>
            Public Overridable Property Carrier As String

            <DataMember(Order:=30)>
            Public Overridable Property FlightNbr As String

            <DataMember(Order:=40)>
            Public Overridable Property BoardPoint As String

            <DataMember(Order:=50)>
            Public Overridable Property OffPoint As String

            <DataMember(Order:=60)>
            Public Overridable Property FlightServiceClass As String

            <DataMember(Order:=70)>
            Public Overridable Property FlightDate As Date?

            <DataMember(Order:=80)>
            Public Overridable Property FlightCouponStatus As String

            <DataMember(Order:=90)>
            Public Overridable Property DateLastChecked As Date?

            <DataMember(Order:=100)>
            Public Overridable Property AirTktSegId As Integer

            <DataMember(Order:=110)>
            Public Overridable Property EligibleForRefund As Boolean

            <DataMember(Order:=120)>
            Public Overridable Property EligibleForCovidStatus As Boolean

            <DataMember(Order:=130)>
            Public Overridable Property FareBasis As String
        End Class

        <DataContract(Name:="Tax", Namespace:="schemas.agentivity.com/types")>
        Public Partial Class TicketTaxDetails
            <DataMember(Order:=10)>
            Public Overridable Property TotalAmt As Decimal?

            <DataMember(Order:=20)>
            Public Overridable Property TaxElements As List(Of TicketTaxElement)
        End Class

        <DataContract(Name:="TaxElement", Namespace:="schemas.agentivity.com/types")>
        Public Partial Class TicketTaxElement
            <DataMember(Order:=10)>
            Public Overridable Property Amt As Decimal?

            <DataMember(Order:=20)>
            Public Overridable Property PrintedAmt As String

            <DataMember(Order:=30)>
            Public Overridable Property Code As String
        End Class
    End Namespace
End Namespace

VB.NET 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"}}