| GET | /BookingsTravelling |
|---|
import java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*
@DataContract(Namespace="schemas.agentivity.com/types")
open class GetBookingsTravelling : 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
/**
* Return only PNRs with/without a mobile number
*/
@DataMember
open var HasMobile:Boolean? = null
/**
* Return only PNRs with/without an email address
*/
@DataMember
open var HasEmail:Boolean? = null
/**
* Return only PNRs with/without an email address OR a mobile number
*/
@DataMember
open var MissingEmailOrPhone:Boolean? = null
/**
* Return only PNRs with/without a hotel
*/
@DataMember
open var HasHotel:Boolean? = null
/**
* Return only PNRs with/without an account
*/
@DataMember
open var HasAccount:Boolean? = null
/**
* Include Itinerary in the response
*/
@DataMember
open var IncludeItinerary:Boolean? = null
/**
* Return only PNRs that equal or exceed a certain number of segments
*/
@DataMember
open var MinSegments:Int? = 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 BookingsTravellingResponse : CollectionResponse<BookingTravelling>()
{
}
@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="BookingTravelling", Namespace="schemas.agentivity.com/types")
open class BookingTravelling : IBookingItinerary
{
@DataMember(Order=20)
open var RecordLocator:String? = null
@DataMember(Order=25)
open var OwningAgencyLocationID:String? = null
@DataMember(Order=30)
open var PNRCreationDate:Date? = null
@DataMember(Order=40)
open var Passengers:String? = null
@DataMember(Order=50)
open var OwningConsultant:String? = null
@DataMember(Order=60)
open var Account:String? = null
@DataMember(Order=70)
open var TravelDate:Date? = null
@DataMember(Order=80)
open var Mobile:String? = null
@DataMember(Order=90)
open var Emails:String? = null
@DataMember(Order=100)
open var PNRTicketed:String? = null
@DataMember(Order=110)
open var DestinationCount:Int? = null
@DataMember(Order=100)
open var CTCM:String? = null
@DataMember(Order=110)
open var CTCE:String? = null
@DataMember(Order=10)
override var AgentivityRef:Int? = null
@DataMember(Order=300)
override var ItineraryFormatted:String? = null
}
Kotlin GetBookingsTravelling DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /BookingsTravelling 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":[{"AgentivityRef":0,"RecordLocator":"String","OwningAgencyLocationID":"String","PNRCreationDate":"\/Date(-62135596800000-0000)\/","Passengers":"String","OwningConsultant":"String","Account":"String","TravelDate":"\/Date(-62135596800000-0000)\/","Mobile":"String","Emails":"String","PNRTicketed":"String","CTCM":"String","DestinationCount":0,"CTCE":"String","ItineraryFormatted":"String"}],"ResponseError":{"ErrorCode":"String","Message":"String","StatusCode":"String","VerboseMessage":"String"}}