Agentivity API

<back to all web services

TicketCouponsIssued

The following routes are available for this service:
GET/TicketCouponsIssued
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

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.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(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:="TicketCoupon", Namespace:="schemas.agentivity.com/types")>
        Public Partial Class TicketCouponIssued
            <DataMember(Order:=10)>
            Public Overridable Property RecordLocator As String

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

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

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

            <DataMember(Order:=50)>
            Public Overridable Property VendorIssueDate As Date?

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

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

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

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

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

            <DataMember(Order:=110)>
            Public Overridable Property Routing As String

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

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

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

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

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

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

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

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

            <DataMember(Order:=200)>
            Public Overridable Property TicketingAgent As String
        End Class

        <DataContract(Namespace:="schemas.agentivity.com/types")>
        Public Partial Class TicketCouponsIssued
            Inherits PagingMetadata
            '''<Summary>
            '''Comma Delimited List of Accounts
            '''</Summary>
            <DataMember>
            Public Overridable Property Account As String()

            '''<Summary>
            '''UserName in form of an email address
            '''</Summary>
            <DataMember>
            Public Overridable Property UserName As String

            '''<Summary>
            '''Date in format YYYYMMDD
            '''</Summary>
            <DataMember>
            Public Overridable Property IssueDateStart As String

            '''<Summary>
            '''Date in format YYYYMMDD
            '''</Summary>
            <DataMember>
            Public Overridable Property IssueDateEnd As String

            '''<Summary>
            '''ID of a travel agent
            '''</Summary>
            <DataMember>
            Public Overridable Property TravelAgentID As String

            '''<Summary>
            '''One letter code for flight coupon status
            '''</Summary>
            <DataMember>
            Public Overridable Property FlightCouponStatus As String

            '''<Summary>
            '''Format style
            '''</Summary>
            <DataMember>
            Public Overridable Property FormatStyle As String
        End Class

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

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

VB.NET TicketCouponsIssued 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 /TicketCouponsIssued 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":{"RecordLocator":"String","PNRCreationDate":"\/Date(-62135596800000-0000)\/","TktNumber":"String","Passenger":"String","VendorIssueDate":"\/Date(-62135596800000-0000)\/","FOP":"String","FOPCurrncy":"String","FOPFare":"String","CouponSequenceNbr":"String","FlightDate":"\/Date(-62135596800000-0000)\/","Routing":"String","FlightServiceClass":"String","FareBasis":"String","Carrier":"String","Account":"String","OwningAgencyLocationID":"String","FlightCouponStatus":"String","DateLastChecked":"\/Date(-62135596800000-0000)\/","OwningConsultantID":"String","TicketingAgent":"String"}},"ResponseError":{"ErrorCode":"String","Message":"String","StatusCode":"String","VerboseMessage":"String"}}