Address object schemas

PlaceSearch

Property

Type

Required

Description

position

Position

query

String

sessionToken

String

Places

Property

Type

Required

Description

locations

sList

Place

Property

Type

Required

Description

placeId

String

displayAddress

String

type

PoiType

LocationInfoRequest

Property

Type

Required

Description

placeId

String

sessionToken

String

LocationInfo

Property

Type

Required

Description

placeId

String

timeZoneIdentifier

String

position

Position

poiType

PoiType

address

LocationInfoAddress

details

PoiDetails

meetingPoint

Position

instructions

String

Position

Property

Type

Required

Description

latitude

Double

The latitude in degrees. It must be in the range [-90.0, +90.0]

longitude

Double

The longitude in degrees. It must be in the range [-180.0, +180.0]

MeetingPoint

Property

Type

Required

Description

position

Position

instructions

String

type

MeetingPointType

MeetingPointType (enum)

Property

Type

Required

Description

defaultType

Standard driver behavior for pickup or dropoff.

pickup

This is a special pick up point for this location.

dropOff

This is a special dropoff point for this location.

meetAndGreet

Usually when the driver will meet the passenger with a greeting sign.

curbSide

The driver will wait curbside at a designated pickup point.

standBy

The passenger must call when they are ready. Usually with their luggage when an airport.

notSet

No meeting point type specified.

PoiType

Property

Type

Required

Description

notSetPoiType

Not specified

enriched

Standard Karhoo POI Type that usually defines curbSide

regulated

POI usually defining restricted pickup and dropOff meeting points

nearest

POI usually defining recommended pickup and dropOff meeting points

PoiDetails

Property

Type

Required

Description

iata

String

If POI is an Airport this is its IATA code

terminal

String

type

PoiDetailsType

PoiDetailsType (enum)

A secondary POI type for more detailed categorisation

Property

Type

Required

Description

notSetDetailsType

airport

trainStation

LocationInfoAddress

Property

Type

Required

Description

displayAddress

String

lineOne

String

lineTwo

String

buildingNumber

String

streetName

String

city

String

postalCode

String

countryCode

String

region

String