Agentivity API

<back to all web services

GetBookingsByAccount

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


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

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

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

    /**
    * Include Itinerary in the response
    */
    @DataMember
    open var IncludeItinerary:Boolean? = null

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

    /**
    * Repeat
    */
    @DataMember
    open var Repeat:Boolean? = 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 BookingsByAccountResponse : CollectionResponse<BookingByAccount>()
{
}

@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="BookingByAccount", Namespace="schemas.agentivity.com/types")
open class BookingByAccount : IBookingItinerary, ICarbonTonnage, ICarbonEmissionDto
{
    @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 Passengers:String? = null

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

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

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

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

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

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

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

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

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

    @DataMember(Order=300)
    override var ItineraryFormatted: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
}

Kotlin GetBookingsByAccount DTOs

GET /BookingsByAccount 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>
    <BookingByAccount>
      <AgentivityRef>0</AgentivityRef>
      <RecordLocator>String</RecordLocator>
      <PNRCreationDate>0001-01-01T00:00:00</PNRCreationDate>
      <OwningAgencyLocationID>String</OwningAgencyLocationID>
      <Passengers>String</Passengers>
      <OwningConsultant>String</OwningConsultant>
      <Account>String</Account>
      <TravelDate>0001-01-01T00:00:00</TravelDate>
      <PNRTicketed>String</PNRTicketed>
      <PNRCancelled>String</PNRCancelled>
      <OrderNumber>String</OrderNumber>
      <EmployeeNumber>String</EmployeeNumber>
      <DestinationCountries>String</DestinationCountries>
      <ItineraryFormatted>String</ItineraryFormatted>
      <CarbonEmissionValue>0</CarbonEmissionValue>
      <CarbonEmissionUnitId>0</CarbonEmissionUnitId>
      <CarbonTonnage>0</CarbonTonnage>
    </BookingByAccount>
  </ResponseReport>
  <ResponseError>
    <ErrorCode>String</ErrorCode>
    <Message>String</Message>
    <StatusCode>String</StatusCode>
    <VerboseMessage>String</VerboseMessage>
  </ResponseError>
</AgentivityResponse>