Agentivity API

<back to all web services

GetTicketCouponsByStatusCode

The following routes are available for this service:
GET/TicketCouponsByStatusCode
import java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*


@DataContract(Namespace="schemas.agentivity.com/types")
open class GetTicketCouponsByStatusCode : CompanyLevelRequestBase(), IRequestConsultantID
{
    /**
    * Date in format YYYYMMDD
    */
    @DataMember
    open var DateStart:String? = null

    /**
    * Date in format YYYYMMDD
    */
    @DataMember
    open var DateEnd:String? = null

    /**
    * Travel agent ID
    */
    @DataMember
    open var TravAgntID:String? = null

    /**
    * Comma Delimited List of Accounts
    */
    @DataMember
    open var Account:ArrayList<String>? = null

    /**
    * Comma Delimited List of PCCs
    */
    @DataMember
    open var OwningAgencyLocationID:ArrayList<String>? = null

    /**
    * Coupon code group ("ALL OPEN") or any Coupon Status eg USED, OPEN
    */
    @DataMember
    open var CouponCodeGroup:String? = null

    /**
    * Date range type. A single character: I = Issue date, T = Travel date, E = Expiry date
    */
    @DataMember
    open var DateTracker:String? = null

    /**
    * Repeat
    */
    @DataMember
    open var Repeat:Boolean? = null

    /**
    * Lists only segments that are not active
    */
    @DataMember
    open var NoActiveSegments:Boolean? = null

    /**
    * Include partial matches
    */
    @DataMember
    open var IncludePartialMatches:Boolean? = null

    /**
    * Show Matching Coupons Only
    */
    @DataMember
    open var ShowMatchingCouponsOnly:Boolean? = null

    /**
    * Pax surname
    */
    @DataMember
    open var PaxSurname:String? = null

    /**
    * Two letter code for carrier
    */
    @DataMember
    open var CarrierCode:String? = null

    /**
    * Comma delimited list of 3-character plating carriers
    */
    @DataMember
    open var ExcludedPlatingCarrier:ArrayList<String>? = null

    /**
    * Id of the owning consultant
    */
    @DataMember
    open var OwningConsultantID:String? = null

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

    /**
    * Agentivity Traveller GUID
    */
    @DataMember
    open var TravellerGUID:String? = null

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

    /**
    * Traveller CRM ID or reference
    */
    @DataMember
    open var TravellerReference:String? = null

    /**
    * The CRM Name
    */
    @DataMember
    open var CRM: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 TicketCouponsByStatusCodeResponse : CollectionResponse<TicketCouponsByStatusCode>()
{
}

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

    @DataMember(Order=2, EmitDefaultValue=false)
    open var ResponseReport:ArrayList<ApiRequestPerHour>? = 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="ApiRequestPerHour", Namespace="schemas.agentivity.com/types")
open class ApiRequestPerHour
{
    @DataMember(Order=10)
    open var RequestDate:Date? = null

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

    @DataMember(Order=110)
    open var Hour1:Int? = null

    @DataMember(Order=120)
    open var Hour2:Int? = null

    @DataMember(Order=130)
    open var Hour3:Int? = null

    @DataMember(Order=140)
    open var Hour4:Int? = null

    @DataMember(Order=150)
    open var Hour5:Int? = null

    @DataMember(Order=160)
    open var Hour6:Int? = null

    @DataMember(Order=170)
    open var Hour7:Int? = null

    @DataMember(Order=180)
    open var Hour8:Int? = null

    @DataMember(Order=190)
    open var Hour9:Int? = null

    @DataMember(Order=200)
    open var Hour10:Int? = null

    @DataMember(Order=210)
    open var Hour11:Int? = null

    @DataMember(Order=220)
    open var Hour12:Int? = null

    @DataMember(Order=230)
    open var Hour13:Int? = null

    @DataMember(Order=240)
    open var Hour14:Int? = null

    @DataMember(Order=250)
    open var Hour15:Int? = null

    @DataMember(Order=260)
    open var Hour16:Int? = null

    @DataMember(Order=270)
    open var Hour17:Int? = null

    @DataMember(Order=280)
    open var Hour18:Int? = null

    @DataMember(Order=290)
    open var Hour19:Int? = null

    @DataMember(Order=300)
    open var Hour20:Int? = null

    @DataMember(Order=310)
    open var Hour21:Int? = null

    @DataMember(Order=320)
    open var Hour22:Int? = null

    @DataMember(Order=330)
    open var Hour23:Int? = 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="TicketCouponsByStatusCode", Namespace="schemas.agentivity.com/types")
open class TicketCouponsByStatusCode : IBookingIdentifier, ICustomFields
{
    @DataMember(Order=5)
    open var CompanyName:String? = null

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

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

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

    @DataMember(Order=35)
    open var VndIssueDt:Date? = null

    @DataMember(Order=40)
    override var RecordLocator:String? = null

    @DataMember(Order=45)
    open var Passenger:String? = null

    @DataMember(Order=51)
    open var TravAgntID:String? = null

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

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

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

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

    @DataMember(Order=110)
    open var TotalTax:String? = null

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

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

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

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

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

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

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

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

    @DataMember(Order=200)
    open var Tax5Code:String? = null

    @DataMember(Order=210)
    open var Tax5Amt:String? = null

    @DataMember(Order=220)
    open var Account:String? = null

    @DataMember(Order=230)
    open var ExchangedForTicket:String? = null

    @DataMember(Order=240)
    open var CouponSequenceNbr:String? = null

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

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

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

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

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

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

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

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

    @DataMember(Order=330)
    open var PCC:String? = null

    @DataMember(Order=340)
    open var AirlineCode:String? = null

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

    @DataMember(Order=510)
    open var CreditCurrency:String? = null

    @DataMember(Order=520)
    open var CreditValue:BigDecimal? = null

    @DataMember(Order=530)
    open var FlightServiceClassName:String? = null

    @DataMember(Order=540)
    open var FlownKM:Int? = null

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

    @DataMember(Order=560)
    override var PNRCreationDate:Date? = null

    @DataMember(Order=570)
    override var AgentivityRef:Int? = null

    @DataMember(Order=580)
    override var CustomFields:CustomFieldsCollection? = null
}

open class CustomFieldsCollection : ArrayList<CustomFieldData>()
{
}

@DataContract(Name="CustomField", Namespace="schemas.agentivity.com/types")
open class CustomFieldData
{
    @DataMember(Order=20)
    open var FieldName:String? = null

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

Kotlin 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: servicestack.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>