Agentivity API

<back to all web services

AirSegmentsByEquipmentCode

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


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

    /**
    * Date in format YYYYMMDD
    */
    @DataMember
    open var DepartureDateEnd: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 AirSegmentsByEquipmentCodeItemResponse : ItemResponse<AirSegmentByEquipmentCode, AirSegmentsByEquipmentCodeResponseReport>()
{
}

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

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

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

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

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

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

    @DataMember(Order=70)
    open var TravelDate:Date? = null

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

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

    @DataMember(Order=100)
    open var CarrierCode:String? = null

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

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

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

    @DataMember(Order=140)
    open var DepartureDateTime:Date? = null

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

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

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

@DataContract(Name="AirSegmentsByEquipmentCode", Namespace="schemas.agentivity.com/types")
open class AirSegmentsByEquipmentCodeResponseReport : Report<AirSegmentsByEquipmentCodeItemResponse, AirSegmentByEquipmentCode>()
{
}

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

Kotlin AirSegmentsByEquipmentCode DTOs

GET /AirSegmentsByEquipmentCode 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":{"AgentivityRef":"String","RecordLocator":"String","PNRCreationDate":"\/Date(-62135596800000-0000)\/","OwningAgencyLocationID":"String","Account":"String","OwningConsultant":"String","TravelDate":"\/Date(-62135596800000-0000)\/","PNRTicketed":"String","PNRCancelled":"String","CarrierCode":"String","FlightNbr":"String","BoardPoint":"String","OffPoint":"String","DepartureDateTime":"\/Date(-62135596800000-0000)\/","EquipmentCode":"String","EquipmentShortNameOrCode":"String","EquipmentNameOrCode":"String"}},"ResponseError":{"ErrorCode":"String","Message":"String","StatusCode":"String","VerboseMessage":"String"}}