Agentivity API

<back to all web services

CorporateTrackerBookings

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


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

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

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

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

    /**
    * Indicates the required formatting: 0=None(Default); 1= Html; 2 = Chart
    */
    @DataMember
    open var ItineraryFormatting:FormattingStyle? = null

    /**
    * Itinerary segments to show
    */
    @DataMember
    open var ItinerarySegmentsToShow: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
}

@Flags()
enum class FormattingStyle(val value:Int)
{
    @SerializedName("0") None(0),
    @SerializedName("1") Html(1),
    @SerializedName("2") Charting(2),
}

@DataContract(Name="AgentivityResponse", Namespace="schemas.agentivity.com/types")
open class CorporateTrackerBookingsItemResponse : ItemResponse<CorporateTrackerBooking, CorporateTrackerBookingsResponseReport>()
{
}

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

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

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

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

    @DataMember(Order=55)
    open var PhoneNbr:String? = null

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

    @DataMember(Order=60)
    override var Itinerary:ItinerarySegmentsCollection? = null

    @DataMember(Order=70)
    override var ItineraryFormatted:String? = null

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

    @DataMember(Order=2000)
    override var CarbonEmissionValue:Double? = null

    @DataMember(Order=2010)
    override var CarbonEmissionUnitId:Short? = null

    @DataMember(Order=2020)
    override var CarbonTonnage:Double? = null
}

open class ItinerarySegmentsCollection : ArrayList<ItinerarySegment>()
{
}

@DataContract(Name="ItinerarySegment", Namespace="schemas.agentivity.com/types")
open class ItinerarySegment
{
    @DataMember
    open var SegmentType:String? = null

    @DataMember
    open var SegmentNbr:Int? = null

    @DataMember
    open var BoardPoint:String? = null

    @DataMember
    open var OffPoint:String? = null

    @DataMember
    open var OperatorCode:String? = null

    @DataMember
    open var OperatorService:String? = null

    @DataMember
    open var SegmentStatus:String? = null

    @DataMember
    open var DepartureTimeFormatted:String? = null

    @DataMember
    open var ArrivalTimeFormatted:String? = null

    @DataMember
    open var ChangeOfDayFormatted:String? = null

    @DataMember
    open var ServiceCode:String? = null

    @DataMember
    open var StartDate:String? = null

    @DataMember
    open var EndDate:String? = null

    @DataMember
    open var TicketNumber:String? = null

    /**
    * Comma separated list of vendor locators
    */
    @DataMember
    open var VendorLocators:String? = null

    @DataMember
    open var EquipmentCode:String? = null

    @DataMember
    open var Equipment:String? = null
}

@DataContract(Name="CorporateTrackerBooking", Namespace="schemas.agentivity.com/types")
open class CorporateTrackerBookingsResponseReport : Report<CorporateTrackerBookingsItemResponse, CorporateTrackerBooking>()
{
}

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

Kotlin CorporateTrackerBookings DTOs

GET /CorporateTrackerBookings 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>
      <AgentivityRef>0</AgentivityRef>
      <RecordLocator>String</RecordLocator>
      <Passenger>String</Passenger>
      <Account>String</Account>
      <OwningConsultant>String</OwningConsultant>
      <PhoneNbr>String</PhoneNbr>
      <Itinerary>
        <ItinerarySegment>
          <ArrivalTimeFormatted>String</ArrivalTimeFormatted>
          <BoardPoint>String</BoardPoint>
          <ChangeOfDayFormatted>String</ChangeOfDayFormatted>
          <DepartureTimeFormatted>String</DepartureTimeFormatted>
          <EndDate>String</EndDate>
          <Equipment>String</Equipment>
          <EquipmentCode>String</EquipmentCode>
          <OffPoint>String</OffPoint>
          <OperatorCode>String</OperatorCode>
          <OperatorService>String</OperatorService>
          <SegmentNbr>0</SegmentNbr>
          <SegmentStatus>String</SegmentStatus>
          <SegmentType>String</SegmentType>
          <ServiceCode>String</ServiceCode>
          <StartDate>String</StartDate>
          <TicketNumber>String</TicketNumber>
          <VendorLocators>String</VendorLocators>
        </ItinerarySegment>
      </Itinerary>
      <ItineraryFormatted>String</ItineraryFormatted>
      <DestinationCountries>String</DestinationCountries>
      <CarbonEmissionValue>0</CarbonEmissionValue>
      <CarbonEmissionUnitId>0</CarbonEmissionUnitId>
      <CarbonTonnage>0</CarbonTonnage>
    </Item>
  </ResponseReport>
  <ResponseError>
    <ErrorCode>String</ErrorCode>
    <Message>String</Message>
    <StatusCode>String</StatusCode>
    <VerboseMessage>String</VerboseMessage>
  </ResponseError>
</AgentivityResponse>