Agentivity API

<back to all web services

TicketCouponsIssued

import java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*


@DataContract(Namespace="schemas.agentivity.com/types")
open class TicketCouponsIssued : PagingMetadata()
{
    /**
    * Comma Delimited List of Accounts
    */
    @DataMember
    open var Account:ArrayList<String>? = null

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

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

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

    /**
    * ID of a travel agent
    */
    @DataMember
    open var TravelAgentID:String? = null

    /**
    * One letter code for flight coupon status
    */
    @DataMember
    open var FlightCouponStatus:String? = null

    /**
    * Format style
    */
    @DataMember
    open var FormatStyle: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 TicketCouponsIssuedItemResponse : ItemResponse<TicketCouponIssued, TicketCouponsIssuedResponseReport>()
{
}

@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="TicketCoupon", Namespace="schemas.agentivity.com/types")
open class TicketCouponIssued
{
    @DataMember(Order=10)
    open var RecordLocator:String? = null

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

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

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

    @DataMember(Order=50)
    open var VendorIssueDate:Date? = null

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

@DataContract(Name="TicketCouponIssued", Namespace="schemas.agentivity.com/types")
open class TicketCouponsIssuedResponseReport : Report<TicketCouponsIssuedItemResponse, TicketCouponIssued>()
{
}

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

Kotlin TicketCouponsIssued DTOs

GET /TicketCouponsIssued 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>
    <Item>
      <RecordLocator>String</RecordLocator>
      <PNRCreationDate>0001-01-01T00:00:00</PNRCreationDate>
      <TktNumber>String</TktNumber>
      <Passenger>String</Passenger>
      <VendorIssueDate>0001-01-01T00:00:00</VendorIssueDate>
      <FOP>String</FOP>
      <FOPCurrncy>String</FOPCurrncy>
      <FOPFare>String</FOPFare>
      <CouponSequenceNbr>String</CouponSequenceNbr>
      <FlightDate>0001-01-01T00:00:00</FlightDate>
      <Routing>String</Routing>
      <FlightServiceClass>String</FlightServiceClass>
      <FareBasis>String</FareBasis>
      <Carrier>String</Carrier>
      <Account>String</Account>
      <OwningAgencyLocationID>String</OwningAgencyLocationID>
      <FlightCouponStatus>String</FlightCouponStatus>
      <DateLastChecked>0001-01-01T00:00:00</DateLastChecked>
      <OwningConsultantID>String</OwningConsultantID>
      <TicketingAgent>String</TicketingAgent>
    </Item>
  </ResponseReport>
  <ResponseError>
    <ErrorCode>String</ErrorCode>
    <Message>String</Message>
    <StatusCode>String</StatusCode>
    <VerboseMessage>String</VerboseMessage>
  </ResponseError>
</AgentivityResponse>