Agentivity API

<back to all web services

GetPassengerDepartures

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


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

    /**
    * Name of the class
    */
    @DataMember
    open var ClassName:ArrayList<String>? = null

    /**
    * Carrier name
    */
    @DataMember
    open var Carrier:ArrayList<String>? = null

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

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

    /**
    * Include items with SMS sent in response
    */
    @DataMember
    open var WithSMS:Boolean? = null

    /**
    * Add transfers
    */
    @DataMember
    open var AddVouchers:Boolean? = null

    /**
    * Add transfers
    */
    @DataMember
    open var AddTransfers:Boolean? = null

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

    /**
    * Return only PNRs that are or are not flagged as VIP bookings
    */
    @DataMember
    open var IsVip:Boolean? = null

    /**
    * Show SMS
    */
    @DataMember
    open var ShowSMS:Boolean? = null

    /**
    * Indicates the required formatting: 0=None(Default); 1= Html; 2 = Chart
    */
    @DataMember
    open var ItineraryFormatting:FormattingStyle? = 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 PassengerDeparturesItemResponse : ItemResponse<PassengerDeparture, PassengerDeparturesResponseReport>()
{
}

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

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

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

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

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

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

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

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

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

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

    @DataMember(Order=75)
    open var TicketedStatus:String? = null

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

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

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

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

    @DataMember(Order=110)
    open var IsVip:Boolean? = null

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

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

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

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

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

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

    @DataMember(Order=210)
    override var ItineraryFormatted:String? = 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="PassengerDeparture", Namespace="schemas.agentivity.com/types")
open class PassengerDeparturesResponseReport : Report<PassengerDeparturesItemResponse, PassengerDeparture>()
{
}

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

Kotlin GetPassengerDepartures DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /PassengerDepartures HTTP/1.1 
Host: api.agentivity.com 
Accept: application/json

HTTP/1.1 200 OK
Content-Type: application/json
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":0,"RecordLocator":"String","OwningAgencyLocationID":"String","OwningConsultant":"String","OwningConsultantID":"String","GdsCode":"String","Passenger":"String","Account":"String","TravelDate":"\/Date(-62135596800000-0000)\/","TicketedStatusCode":"String","TicketedStatus":"String","SupplierReference":"String","SMS":"String","Vouchers":"String","Transfers":"String","IsVip":false,"PhoneNbr":"String","EmailAddress":"String","DestinationCities":"String","DestinationCountries":"String","Connections":"String","Itinerary":[{"SegmentType":"String","SegmentNbr":0,"BoardPoint":"String","OffPoint":"String","OperatorCode":"String","OperatorService":"String","SegmentStatus":"String","DepartureTimeFormatted":"String","ArrivalTimeFormatted":"String","ChangeOfDayFormatted":"String","ServiceCode":"String","StartDate":"String","EndDate":"String","TicketNumber":"String","VendorLocators":"String","EquipmentCode":"String","Equipment":"String"}],"ItineraryFormatted":"String"}},"ResponseError":{"ErrorCode":"String","Message":"String","StatusCode":"String","VerboseMessage":"String"}}