Agentivity API

<back to all web services

GetTicketCouponsByStatusCode

The following routes are available for this service:
GET/TicketCouponsByStatusCode
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 CollectionResponse(Of TItem)
            <DataMember(Order:=1)>
            Public Overridable Property ResponseMetadata As ResponseMetadata

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

            <DataMember(Order:=3, EmitDefaultValue:=false)>
            Public Overridable Property ResponseError As AgentivityError
        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:="ApiRequestPerHour", Namespace:="schemas.agentivity.com/types")>
        Public Partial Class ApiRequestPerHour
            <DataMember(Order:=10)>
            Public Overridable Property RequestDate As Date

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

            <DataMember(Order:=110)>
            Public Overridable Property Hour1 As Integer

            <DataMember(Order:=120)>
            Public Overridable Property Hour2 As Integer

            <DataMember(Order:=130)>
            Public Overridable Property Hour3 As Integer

            <DataMember(Order:=140)>
            Public Overridable Property Hour4 As Integer

            <DataMember(Order:=150)>
            Public Overridable Property Hour5 As Integer

            <DataMember(Order:=160)>
            Public Overridable Property Hour6 As Integer

            <DataMember(Order:=170)>
            Public Overridable Property Hour7 As Integer

            <DataMember(Order:=180)>
            Public Overridable Property Hour8 As Integer

            <DataMember(Order:=190)>
            Public Overridable Property Hour9 As Integer

            <DataMember(Order:=200)>
            Public Overridable Property Hour10 As Integer

            <DataMember(Order:=210)>
            Public Overridable Property Hour11 As Integer

            <DataMember(Order:=220)>
            Public Overridable Property Hour12 As Integer

            <DataMember(Order:=230)>
            Public Overridable Property Hour13 As Integer

            <DataMember(Order:=240)>
            Public Overridable Property Hour14 As Integer

            <DataMember(Order:=250)>
            Public Overridable Property Hour15 As Integer

            <DataMember(Order:=260)>
            Public Overridable Property Hour16 As Integer

            <DataMember(Order:=270)>
            Public Overridable Property Hour17 As Integer

            <DataMember(Order:=280)>
            Public Overridable Property Hour18 As Integer

            <DataMember(Order:=290)>
            Public Overridable Property Hour19 As Integer

            <DataMember(Order:=300)>
            Public Overridable Property Hour20 As Integer

            <DataMember(Order:=310)>
            Public Overridable Property Hour21 As Integer

            <DataMember(Order:=320)>
            Public Overridable Property Hour22 As Integer

            <DataMember(Order:=330)>
            Public Overridable Property Hour23 As Integer
        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:="CustomField", Namespace:="schemas.agentivity.com/types")>
        Public Partial Class CustomFieldData
            <DataMember(Order:=20)>
            Public Overridable Property FieldName As String

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

        Public Partial Class CustomFieldsCollection
            Inherits List(Of CustomFieldData)
        End Class

        <DataContract(Namespace:="schemas.agentivity.com/types")>
        Public Partial Class GetTicketCouponsByStatusCode
            Inherits CompanyLevelRequestBase
            Implements IRequestConsultantID
            '''<Summary>
            '''Date in format YYYYMMDD
            '''</Summary>
            <DataMember>
            Public Overridable Property DateStart As String

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

            '''<Summary>
            '''Travel agent ID
            '''</Summary>
            <DataMember>
            Public Overridable Property TravAgntID As String

            '''<Summary>
            '''Comma Delimited List of Accounts
            '''</Summary>
            <DataMember>
            Public Overridable Property Account As String()

            '''<Summary>
            '''Comma Delimited List of PCCs
            '''</Summary>
            <DataMember>
            Public Overridable Property OwningAgencyLocationID As String()

            '''<Summary>
            '''Coupon code group ("ALL OPEN") or any Coupon Status eg USED, OPEN
            '''</Summary>
            <DataMember>
            Public Overridable Property CouponCodeGroup As String

            '''<Summary>
            '''Date range type. A single character: I = Issue date, T = Travel date, E = Expiry date
            '''</Summary>
            <DataMember>
            Public Overridable Property DateTracker As String

            '''<Summary>
            '''Repeat
            '''</Summary>
            <DataMember>
            Public Overridable Property Repeat As Boolean

            '''<Summary>
            '''Lists only segments that are not active
            '''</Summary>
            <DataMember>
            Public Overridable Property NoActiveSegments As Boolean

            '''<Summary>
            '''Include partial matches
            '''</Summary>
            <DataMember>
            Public Overridable Property IncludePartialMatches As Boolean

            '''<Summary>
            '''Show Matching Coupons Only
            '''</Summary>
            <DataMember>
            Public Overridable Property ShowMatchingCouponsOnly As Boolean

            '''<Summary>
            '''Pax surname
            '''</Summary>
            <DataMember>
            Public Overridable Property PaxSurname As String

            '''<Summary>
            '''Two letter code for carrier
            '''</Summary>
            <DataMember>
            Public Overridable Property CarrierCode As String

            '''<Summary>
            '''Comma delimited list of 3-character plating carriers
            '''</Summary>
            <DataMember>
            Public Overridable Property ExcludedPlatingCarrier As String()

            '''<Summary>
            '''Id of the owning consultant
            '''</Summary>
            <DataMember>
            Public Overridable Property OwningConsultantID As String

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

            '''<Summary>
            '''Agentivity Traveller GUID
            '''</Summary>
            <DataMember>
            Public Overridable Property TravellerGUID As String

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

            <DataMember>
            Public Overridable Property CRMCode As Integer

            <DataMember>
            Public Overridable Property CRMID As String
        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:="TicketCouponsByStatusCode", Namespace:="schemas.agentivity.com/types")>
        Public Partial Class TicketCouponsByStatusCode
            Implements IBookingIdentifier
            Implements ICustomFields
            <DataMember(Order:=5)>
            Public Overridable Property CompanyName As String

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

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

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

            <DataMember(Order:=35)>
            Public Overridable Property VndIssueDt As Date?

            <DataMember(Order:=40)>
            Public Overridable Property RecordLocator As String Implements IBookingIdentifier.RecordLocator

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

            <DataMember(Order:=51)>
            Public Overridable Property TravAgntID As String

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

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

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

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

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

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

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

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

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

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

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

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

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

            <DataMember(Order:=200)>
            Public Overridable Property Tax5Code As String

            <DataMember(Order:=210)>
            Public Overridable Property Tax5Amt As String

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

            <DataMember(Order:=230)>
            Public Overridable Property ExchangedForTicket As String

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

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

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

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

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

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

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

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

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

            <DataMember(Order:=330)>
            Public Overridable Property PCC As String

            <DataMember(Order:=340)>
            Public Overridable Property AirlineCode As String

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

            <DataMember(Order:=510)>
            Public Overridable Property CreditCurrency As String

            <DataMember(Order:=520)>
            Public Overridable Property CreditValue As Decimal?

            <DataMember(Order:=530)>
            Public Overridable Property FlightServiceClassName As String

            <DataMember(Order:=540)>
            Public Overridable Property FlownKM As Integer?

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

            <DataMember(Order:=560)>
            Public Overridable Property PNRCreationDate As Date? Implements IBookingIdentifier.PNRCreationDate

            <DataMember(Order:=570)>
            Public Overridable Property AgentivityRef As Integer Implements IBookingIdentifier.AgentivityRef

            <DataMember(Order:=580)>
            Public Overridable Property CustomFields As CustomFieldsCollection Implements ICustomFields.CustomFields
        End Class

        <DataContract(Name:="AgentivityResponse", Namespace:="schemas.agentivity.com/types")>
        Public Partial Class TicketCouponsByStatusCodeResponse
            Inherits CollectionResponse(Of TicketCouponsByStatusCode)
        End Class
    End Namespace
End Namespace

VB.NET GetTicketCouponsByStatusCode DTOs

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

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /TicketCouponsByStatusCode 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>
    <TicketCouponsByStatusCode>
      <CompanyName>String</CompanyName>
      <TktNumber>String</TktNumber>
      <RN>String</RN>
      <AirTktSegId>String</AirTktSegId>
      <VndIssueDt>0001-01-01T00:00:00</VndIssueDt>
      <RecordLocator>String</RecordLocator>
      <Passenger>String</Passenger>
      <TravAgntID>String</TravAgntID>
      <OwningConsultantID>String</OwningConsultantID>
      <FOPFare>String</FOPFare>
      <BaseFare>String</BaseFare>
      <FOP>String</FOP>
      <TotalTax>String</TotalTax>
      <Tax1Code>String</Tax1Code>
      <Tax1Amt>String</Tax1Amt>
      <Tax2Code>String</Tax2Code>
      <Tax2Amt>String</Tax2Amt>
      <Tax3Code>String</Tax3Code>
      <Tax3Amt>String</Tax3Amt>
      <Tax4Amt>String</Tax4Amt>
      <Tax4Code>String</Tax4Code>
      <Tax5Code>String</Tax5Code>
      <Tax5Amt>String</Tax5Amt>
      <Account>String</Account>
      <ExchangedForTicket>String</ExchangedForTicket>
      <CouponSequenceNbr>String</CouponSequenceNbr>
      <Carrier>String</Carrier>
      <BoardPoint>String</BoardPoint>
      <OffPoint>String</OffPoint>
      <FlightDate>0001-01-01T00:00:00</FlightDate>
      <FlightServiceClass>String</FlightServiceClass>
      <FareBasis>String</FareBasis>
      <FlightCouponStatus>String</FlightCouponStatus>
      <DateLastChecked>0001-01-01T00:00:00</DateLastChecked>
      <PCC>String</PCC>
      <AirlineCode>String</AirlineCode>
      <OwningCompanyCode>String</OwningCompanyCode>
      <CreditCurrency>String</CreditCurrency>
      <CreditValue>0</CreditValue>
      <FlightServiceClassName>String</FlightServiceClassName>
      <FlownKM>0</FlownKM>
      <BAR>String</BAR>
      <PNRCreationDate>0001-01-01T00:00:00</PNRCreationDate>
      <AgentivityRef>0</AgentivityRef>
      <CustomFields>
        <CustomField>
          <FieldName>String</FieldName>
          <FieldValue>String</FieldValue>
        </CustomField>
      </CustomFields>
    </TicketCouponsByStatusCode>
  </ResponseReport>
  <ResponseError>
    <ErrorCode>String</ErrorCode>
    <Message>String</Message>
    <StatusCode>String</StatusCode>
    <VerboseMessage>String</VerboseMessage>
  </ResponseError>
</AgentivityResponse>