Address object schemas

PlaceSearch

PropertyTypeRequiredDescription
positionPosition
queryString
sessionTokenString

Places

PropertyTypeRequiredDescription
locationssList

Place

PropertyTypeRequiredDescription
placeIdString
displayAddressString
typePoiType

LocationInfoRequest

PropertyTypeRequiredDescription
placeIdString
sessionTokenString

LocationInfo

PropertyTypeRequiredDescription
placeIdString
timeZoneIdentifierString
positionPosition
poiTypePoiType
addressLocationInfoAddress
detailsPoiDetails
meetingPointPosition
instructionsString

Position

PropertyTypeRequiredDescription
latitudeDoubleThe latitude in degrees. It must be in the range [-90.0, +90.0]
longitudeDoubleThe longitude in degrees. It must be in the range [-180.0, +180.0]

MeetingPoint

PropertyTypeRequiredDescription
positionPosition
instructionsString
typeMeetingPointType

MeetingPointType (enum)

PropertyTypeRequiredDescription
defaultTypeStandard driver behavior for pickup or dropoff.
pickupThis is a special pick up point for this location.
dropOffThis is a special dropoff point for this location.
meetAndGreetUsually when the driver will meet the passenger with a greeting sign.
curbSideThe driver will wait curbside at a designated pickup point.
standByThe passenger must call when they are ready. Usually with their luggage when an airport.
notSetNo meeting point type specified.

PoiType

PropertyTypeRequiredDescription
notSetPoiTypeNot specified
enrichedStandard Karhoo POI Type that usually defines curbSide
regulatedPOI usually defining restricted pickup and dropOff meeting points
nearestPOI usually defining recommended pickup and dropOff meeting points

PoiDetails

PropertyTypeRequiredDescription
iataStringIf POI is an Airport this is its IATA code
terminalString
typePoiDetailsType

PoiDetailsType (enum)

A secondary POI type for more detailed categorisation

PropertyTypeRequiredDescription
notSetDetailsType
airport
trainStation

LocationInfoAddress

PropertyTypeRequiredDescription
displayAddressString
lineOneString
lineTwoString
buildingNumberString
streetNameString
cityString
postalCodeString
countryCodeString
regionString