| GET | /HotelSegments |
|---|
import java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*
@DataContract(Namespace="schemas.agentivity.com/types")
open class GetHotelSegments : CompanyLevelRequestBase()
{
/**
* Date in format YYYYMMDD
*/
@DataMember
open var DateStart:String? = null
/**
* Date in format YYYYMMDD
*/
@DataMember
open var DateEnd:String? = null
/**
* Comma Delimited List of Accounts
*/
@DataMember
open var Account:ArrayList<String>? = null
/**
* 3 letter city code
*/
@DataMember
open var CityCode:String? = null
/**
* Include Notepad Entry: 1=Yes
*/
@DataMember
open var WithNotepad:String? = null
/**
* Comma Delimited List of PCCs
*/
@DataMember
open var OwningAgencyLocationID:ArrayList<String>? = null
/**
* Comma Delimited List of CountryCodes
*/
@DataMember
open var OwningAgencyCountryCode:ArrayList<String>? = null
/**
* Date search type option, a single character (A to search by Arrival dates, C to search by booking creation dates, S to search by segment creation dates).
*/
@DataMember
open var DateSearchType:String? = null
/**
* IsGDS=0 (bookings from Non-GDS eg Supplier Direct). IsGDS=1 (bookings from GDS).
*/
@DataMember
open var IsGDS:String? = null
/**
* IsPassive=0 (only include non-passive segments). IsPassive=1 (only include passive segments).
*/
@DataMember
open var IsPassive:String? = null
/**
* Comma Delimited List of Custom Fields
*/
@DataMember
open var CustomField: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 HotelSegmentsItemResponse : ItemResponse<HotelSegment, HotelSegmentsResponseReport>()
{
}
@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="Segment", Namespace="schemas.agentivity.com/types")
open class HotelSegment : IBookingCustomFields
{
@DataMember(Order=10)
override var AgentivityRef:Int? = null
@DataMember(Order=15)
open var PNRCreationDate:Date? = null
@DataMember(Order=20)
open var HotelSegmentNbr:String? = null
@DataMember(Order=30)
open var RecordLocator:String? = null
@DataMember(Order=50)
open var OwningAgencyLocationID:String? = null
@DataMember(Order=60)
open var Account:String? = null
@DataMember(Order=70)
open var OwningConsultantID:String? = null
@DataMember(Order=80)
open var OwningConsultant:String? = null
@DataMember(Order=90)
open var StatusCode:String? = null
@DataMember(Order=95)
open var SegmentCreationDate:Date? = null
@DataMember(Order=100)
open var ArrivalDate:Date? = null
@DataMember(Order=110)
open var DepartureDate:Date? = null
@DataMember(Order=120)
open var NbrNights:Int? = null
@DataMember(Order=130)
open var VendorCode:String? = null
@DataMember(Order=140)
open var PropertyName:String? = null
@DataMember(Order=150)
open var PropertyNbr:String? = null
@DataMember(Order=160)
open var PropertyAddress:String? = null
@DataMember(Order=145)
open var PropertyPhoneNbr:String? = null
@DataMember(Order=170)
open var CityCode:String? = null
@DataMember(Order=170)
open var CityName:String? = null
@DataMember(Order=180)
open var CountryCode:String? = null
@DataMember(Order=190)
open var CountryName:String? = null
@DataMember(Order=200)
open var Passenger:String? = null
@DataMember(Order=210)
open var ConfirmationNbr:String? = null
@DataMember(Order=220)
open var RateAccessCode:String? = null
@DataMember(Order=230)
open var RoomBookingCode:String? = null
@DataMember(Order=240)
open var CurrencyCode:String? = null
@DataMember(Order=250)
open var RateAmount:String? = null
@DataMember(Order=260)
open var NbrRooms:Int? = null
@DataMember(Order=270)
open var BookedInName:String? = null
@DataMember(Order=275)
open var ServiceInformation:String? = null
@DataMember(Order=280)
open var TotalAirSegs:String? = null
@DataMember(Order=290)
open var CreatingAgencyIata:String? = null
@DataMember(Order=310)
open var IsCommissionable:Boolean? = null
@DataMember(Order=320)
open var Commission:String? = null
@DataMember(Order=330)
open var IsPassive:Boolean? = null
@DataMember(Order=340)
override var CustomFields:CustomFieldsCollection? = null
@DataMember(Order=350)
open var HotelNotepad:String? = null
}
open class CustomFieldsCollection : ArrayList<CustomFieldData>()
{
}
@DataContract(Name="CustomField", Namespace="schemas.agentivity.com/types")
open class CustomFieldData
{
@DataMember(Order=20)
open var FieldName:String? = null
@DataMember(Order=30)
open var FieldValue:String? = null
}
@DataContract(Name="HotelSegment", Namespace="schemas.agentivity.com/types")
open class HotelSegmentsResponseReport : Report<HotelSegmentsItemResponse, HotelSegment>()
{
}
@DataContract(Namespace="schemas.agentivity.com/types")
open class Report<TItemResponse, TItem>
{
@DataMember(Order=1, EmitDefaultValue=false)
open var Item:TItem? = null
}
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
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /HotelSegments 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,"PNRCreationDate":"\/Date(-62135596800000-0000)\/","HotelSegmentNbr":"String","RecordLocator":"String","OwningAgencyLocationID":"String","Account":"String","OwningConsultantID":"String","OwningConsultant":"String","StatusCode":"String","SegmentCreationDate":"\/Date(-62135596800000-0000)\/","ArrivalDate":"\/Date(-62135596800000-0000)\/","DepartureDate":"\/Date(-62135596800000-0000)\/","NbrNights":0,"VendorCode":"String","PropertyName":"String","PropertyPhoneNbr":"String","PropertyNbr":"String","PropertyAddress":"String","CityCode":"String","CityName":"String","CountryCode":"String","CountryName":"String","Passenger":"String","ConfirmationNbr":"String","RateAccessCode":"String","RoomBookingCode":"String","CurrencyCode":"String","RateAmount":"String","NbrRooms":0,"BookedInName":"String","ServiceInformation":"String","TotalAirSegs":"String","CreatingAgencyIata":"String","IsCommissionable":false,"Commission":"String","IsPassive":false,"CustomFields":[{"FieldName":"String","FieldValue":"String"}],"HotelNotepad":"String"}},"ResponseError":{"ErrorCode":"String","Message":"String","StatusCode":"String","VerboseMessage":"String"}}