| GET | /PassengerLocationsByCity |
|---|
import java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*
@DataContract(Namespace="schemas.agentivity.com/types")
open class GetPassengerLocationsByCity : CompanyLevelRequestBase(), IRepeatByPassenger
{
/**
* 3 letter city code
*/
@DataMember
open var CityCode:String? = null
/**
* Date in format YYYYMMDD
*/
@DataMember
open var DateEnd:String? = null
/**
* Date in format YYYYMMDD
*/
@DataMember
open var DateStart:String? = null
/**
* Include passengers that are in transit only in response
*/
@DataMember
open var InTransitOnly:Boolean? = null
/**
* Comma Delimited List of Accounts
*/
@DataMember
open var Account:ArrayList<String>? = null
/**
* Include items with hotel in response
*/
@DataMember
open var WithHotel:Boolean? = null
/**
* Name of the hotel
*/
@DataMember
open var HotelName:String? = null
/**
* Comma Delimited List of Custom Fields
*/
@DataMember
open var CustomField:ArrayList<String>? = null
/**
* Option to place passenger names on separate lines in the downloadable result (spreadsheet)
*/
@DataMember
override var RepeatByPassenger:Boolean? = 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 PassengerLocationsByCityResponse : CollectionResponse<PassengerLocation>()
{
}
@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="Segment", Namespace="schemas.agentivity.com/types")
open class PassengerLocation : IBookingItinerary, IBookingCustomFields, IBookingIdentifier, ITicketNumbers, IVendorLocators, IPassengerInfo
{
@DataMember(Order=1)
override var RecordLocator:String? = null
@DataMember(Order=2)
open var TravelDate:Date? = null
@DataMember(Order=3)
open var DepartureDate:Date? = null
@DataMember(Order=4)
open var BoardPoint:String? = null
@DataMember(Order=5)
open var OffPoint:String? = null
@DataMember(Order=6)
open var PnrTicketed:String? = null
@DataMember(Order=7)
open var Account:String? = null
@DataMember(Order=8)
open var Consultant:String? = null
@DataMember(Order=9)
open var PaxList:String? = null
@DataMember(Order=10)
open var PhoneNbr:String? = null
@DataMember(Order=11)
open var EmailAddress:String? = null
@DataMember(Order=12)
open var DestinationCities:String? = null
@DataMember(Order=13)
open var Connections:String? = null
@DataMember(Order=14)
open var CarrierCodes:String? = null
@DataMember(Order=16)
open var HotelsNames:String? = null
@DataMember(Order=30)
open var FlightNumbers:String? = null
@DataMember(Order=40)
open var OwningAgencyLocationID:String? = null
@DataMember(Order=50)
open var IataCodes:String? = null
@DataMember(Order=15)
override var AgentivityRef:Int? = null
@DataMember(Order=120)
override var Itinerary:ItinerarySegmentsCollection? = null
@DataMember(Order=130)
override var ItineraryFormatted:String? = null
@DataMember(Order=140)
override var CustomFields:CustomFieldsCollection? = null
@DataMember(Order=150)
open var DepartureDateTime:Date? = null
@DataMember(Order=160)
open var CurrentArrivalDateTime:Date? = null
@DataMember(Order=170)
open var SegmentType:String? = null
@DataMember(Order=180)
open var AirSegmentNbr:String? = null
@DataMember(Order=190)
override var PNRCreationDate:Date? = null
@DataMember(Order=200)
override var TicketNumbers:ArrayList<String>? = null
@DataMember(Order=210)
override var VendorLocators:ArrayList<BookingExtVendorLocator>? = null
@DataMember(Order=220)
override var PassengerInfo:ArrayList<BookingPassengerModel>? = 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
}
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="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="Passenger", Namespace="schemas.agentivity.com/types")
open class BookingPassengerModel
{
@DataMember(Order=10)
open var FirstName:String? = null
@DataMember(Order=20)
open var LastName:String? = null
@DataMember(Order=30)
open var PassengerDataId:Int? = null
}
Kotlin GetPassengerLocationsByCity 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 /PassengerLocationsByCity 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>
<Segment>
<RecordLocator>String</RecordLocator>
<TravelDate>0001-01-01T00:00:00</TravelDate>
<DepartureDate>0001-01-01T00:00:00</DepartureDate>
<BoardPoint>String</BoardPoint>
<OffPoint>String</OffPoint>
<PnrTicketed>String</PnrTicketed>
<Account>String</Account>
<Consultant>String</Consultant>
<PaxList>String</PaxList>
<PhoneNbr>String</PhoneNbr>
<EmailAddress>String</EmailAddress>
<DestinationCities>String</DestinationCities>
<Connections>String</Connections>
<CarrierCodes>String</CarrierCodes>
<AgentivityRef>0</AgentivityRef>
<HotelsNames>String</HotelsNames>
<FlightNumbers>String</FlightNumbers>
<OwningAgencyLocationID>String</OwningAgencyLocationID>
<IataCodes>String</IataCodes>
<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>
<CustomFields>
<CustomField>
<FieldName>String</FieldName>
<FieldValue>String</FieldValue>
</CustomField>
</CustomFields>
<DepartureDateTime>0001-01-01T00:00:00</DepartureDateTime>
<CurrentArrivalDateTime>0001-01-01T00:00:00</CurrentArrivalDateTime>
<SegmentType>String</SegmentType>
<AirSegmentNbr>String</AirSegmentNbr>
<PNRCreationDate>0001-01-01T00:00:00</PNRCreationDate>
<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>
<PassengerInfo>
<Passenger>
<FirstName>String</FirstName>
<LastName>String</LastName>
<PassengerDataId>0</PassengerDataId>
<Tickets>
<Ticket>
<Number>String</Number>
<Type>String</Type>
</Ticket>
</Tickets>
</Passenger>
</PassengerInfo>
</Segment>
</ResponseReport>
<ResponseError>
<ErrorCode>String</ErrorCode>
<Message>String</Message>
<StatusCode>String</StatusCode>
<VerboseMessage>String</VerboseMessage>
</ResponseError>
</AgentivityResponse>