| GET | /BookingsCreated |
|---|
import java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*
@DataContract(Namespace="schemas.agentivity.com/types")
open class GetBookingsCreated : CompanyLevelRequestBase(), IMemberAccount, IMemberPNRCreationDateStart, IMemberPNRCreationDateEnd, IMemberPNRCancelled, IMemberHasMobile, IMemberHasEmail, IMemberMissingEmailOrPhone, IMemberHasHotel, IMemberHasAccount, IMemberIncludeItinerary, IMemberMinSegments, IMemberIsVip, IMemberItineraryFormatting
{
/**
* Includes CTCM and CTCE in results
*/
@DataMember
open var IncludeCTFields:Boolean? = null
/**
* Comma Delimited List of Accounts
*/
@DataMember
override var Account:ArrayList<String>? = null
/**
* Return only PNRs with/without an account
*/
@DataMember
override var HasAccount:Boolean? = null
/**
* Return only PNRs with/without an email address
*/
@DataMember
override var HasEmail:Boolean? = null
/**
* Return only PNRs with/without a hotel
*/
@DataMember
override var HasHotel:Boolean? = null
/**
* Return only PNRs with/without a mobile number
*/
@DataMember
override var HasMobile:Boolean? = null
/**
* Include Itinerary in the response
*/
@DataMember
override var IncludeItinerary:Boolean? = null
/**
* Return only PNRs that are or are not flagged as VIP bookings
*/
@DataMember
override var IsVip:Boolean? = null
/**
* Indicates the required formatting: 0=None(Default); 1= Html; 2 = Chart
*/
@DataMember
override var ItineraryFormatting:FormattingStyle? = null
/**
* Return only PNRs that equal or exceed a certain number of segments
*/
@DataMember
override var MinSegments:Int? = null
/**
* Return only PNRs with/without an email address OR a mobile number
*/
@DataMember
override var MissingEmailOrPhone:Boolean? = null
/**
* Date in format YYYYMMDD
*/
@DataMember
override var PNRCreationDateEnd:String? = null
/**
* Date in format YYYYMMDD
*/
@DataMember
override var PNRCreationDateStart:String? = null
/**
* Return only PNRs that are cancelled(Y)/not cancelled(N)/all
*/
@DataMember
override var PNRCancelled:String? = null
/**
* Comma Delimited List of PCCs
*/
@DataMember
open var OwningAgencyLocationID: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
}
@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 BookingsCreatedResponse : CollectionResponse<BookingCreated>()
{
}
@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="BookingCreated", Namespace="schemas.agentivity.com/types")
open class BookingCreated : IBookingItinerary, ICarbonTonnage
{
@DataMember(Order=10)
override var AgentivityRef:Int? = null
@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 Account:String? = null
@DataMember(Order=60)
open var OwningConsultantID:String? = null
@DataMember(Order=70)
open var OwningConsultant:String? = null
@DataMember(Order=80)
open var PNRTicketed:String? = null
@DataMember(Order=90)
open var PNRTicketedDate:Date? = null
@DataMember(Order=100)
open var PNRCancelled:String? = null
@DataMember(Order=110)
open var TravelDate:Date? = null
@DataMember(Order=120)
open var CancelledTravelDate:Date? = null
@DataMember(Order=130)
open var Passengers:String? = null
@DataMember(Order=140)
open var Mobile:String? = null
@DataMember(Order=150)
open var Emails:String? = null
@DataMember(Order=160)
open var DestinationCount:Int? = null
@DataMember(Order=170)
open var IsVip:Boolean? = null
@DataMember(Order=180)
open var CTCM:String? = null
@DataMember(Order=190)
open var CTCE:String? = null
@DataMember(Order=200)
override var Itinerary:ItinerarySegmentsCollection? = null
@DataMember(Order=210)
override var ItineraryFormatted:String? = null
@DataMember(Order=220)
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
}
Kotlin GetBookingsCreated DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /BookingsCreated 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>
<BookingCreated>
<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>
<PNRTicketed>String</PNRTicketed>
<PNRTicketedDate>0001-01-01T00:00:00</PNRTicketedDate>
<PNRCancelled>String</PNRCancelled>
<TravelDate>0001-01-01T00:00:00</TravelDate>
<CancelledTravelDate>0001-01-01T00:00:00</CancelledTravelDate>
<Passengers>String</Passengers>
<Mobile>String</Mobile>
<Emails>String</Emails>
<DestinationCount>0</DestinationCount>
<IsVip>false</IsVip>
<CTCM>String</CTCM>
<CTCE>String</CTCE>
<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>
<CarbonTonnage>0</CarbonTonnage>
</BookingCreated>
</ResponseReport>
<ResponseError>
<ErrorCode>String</ErrorCode>
<Message>String</Message>
<StatusCode>String</StatusCode>
<VerboseMessage>String</VerboseMessage>
</ResponseError>
</AgentivityResponse>