Agentivity API

<back to all web services

GetBookingsWithActiveSegments

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


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

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

    /**
    * All future date
    */
    @DataMember
    open var AllFutureDate:Boolean? = null

    /**
    * Comma Delimited List of Accounts
    */
    @DataMember
    open var Account:ArrayList<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 GetBookingsWithActiveSegmentsItemResponse : ItemResponse<BookingWithActiveSegments, GetBookingsWithActiveSegmentsResponseReport>()
{
}

@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="BookingWithActiveSegments", Namespace="schemas.agentivity.com/types")
open class BookingWithActiveSegments : IBookingIdentifier, ITicketNumbers, IVendorLocators
{
    @DataMember(Order=10)
    override var AgentivityRef:Int? = null

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

    @DataMember(Order=30)
    override 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 OwningConsultantID:String? = null

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

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

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

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

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

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

    @DataMember(Order=120)
    open var HasAir:Boolean? = null

    @DataMember(Order=130)
    open var HasHtl:Boolean? = null

    @DataMember(Order=140)
    open var HasCar:Boolean? = null

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

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

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

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

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

    @DataMember(Order=200)
    override var TicketNumbers:ArrayList<String>? = null

    @DataMember(Order=210)
    override var VendorLocators:ArrayList<BookingExtVendorLocator>? = null
}

@DataContract(Name="VendorLocator", Namespace="schemas.agentivity.com/types")
open class BookingExtVendorLocator : IBookingIdentifier
{
    @DataMember(Order=10)
    open var CarrierCode:String? = null

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

@DataContract(Name="BookingWithActiveSegments", Namespace="schemas.agentivity.com/types")
open class GetBookingsWithActiveSegmentsResponseReport : Report<GetBookingsWithActiveSegmentsItemResponse, BookingWithActiveSegments>()
{
}

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

Kotlin GetBookingsWithActiveSegments 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.

POST /BookingsWithActiveSegments HTTP/1.1 
Host: api.agentivity.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<GetBookingsWithActiveSegments xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="schemas.agentivity.com/types">
  <Limit>String</Limit>
  <Offset>String</Offset>
  <ResponseRecords>0</ResponseRecords>
  <TotalRecords>0</TotalRecords>
  <OwningCompanyCode xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </OwningCompanyCode>
  <UserName>String</UserName>
  <Account xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </Account>
  <AllFutureDate>false</AllFutureDate>
  <TravelDateEnd>String</TravelDateEnd>
  <TravelDateStart>String</TravelDateStart>
</GetBookingsWithActiveSegments>

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>
      <PNRCreationDate>0001-01-01T00:00:00</PNRCreationDate>
      <OwningAgencyLocationID>String</OwningAgencyLocationID>
      <Account>String</Account>
      <OwningConsultantID>String</OwningConsultantID>
      <OwningConsultant>String</OwningConsultant>
      <TravelDate>0001-01-01T00:00:00</TravelDate>
      <Passenger>String</Passenger>
      <PNRTicketed>String</PNRTicketed>
      <EmailAddress>String</EmailAddress>
      <PhoneNbr>String</PhoneNbr>
      <HasAir>false</HasAir>
      <HasHtl>false</HasHtl>
      <HasCar>false</HasCar>
      <DestinationCities>String</DestinationCities>
      <Connections>String</Connections>
      <CarrierCodes>String</CarrierCodes>
      <FlightNumbers>String</FlightNumbers>
      <IataCodes>String</IataCodes>
      <TicketNumbers xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>String</d4p1:string>
      </TicketNumbers>
      <VendorLocators>
        <VendorLocator>
          <CarrierCode>String</CarrierCode>
          <VendorLocator>String</VendorLocator>
        </VendorLocator>
      </VendorLocators>
    </Item>
  </ResponseReport>
  <ResponseError>
    <ErrorCode>String</ErrorCode>
    <Message>String</Message>
    <StatusCode>String</StatusCode>
    <VerboseMessage>String</VerboseMessage>
  </ResponseError>
</AgentivityResponse>