Schema
All the addresses are returned in standard GeoJSON feature object. Each address has its own feature objects with few additional fields.
Response Object:
Parameter | Type | Descriptions |
---|---|---|
placeId | string | Stoovo generated Unique ID |
type | string | Standard Geojson format type, it could be 'Feature'. You can read about it more here. |
geometry | Geometry Object | Standard RC 7946 Geometry Object with type as Point. Read more here. |
properties | POI Object | All the point of interest details are inside the properties. |
POI Property Object: Each POI Object encompasses intricate details such as entrances, parkings, delivery options, and other descriptors, with a payload offering variable instructions for each.
Parameter | Type | Descriptions |
---|---|---|
buildingType | String | Type of the building, one of apartment, house, office, store or other |
address | String | Standardized location's address |
floors | Number | Number of floors in the building. |
apn | String | A unique number assigned to a parcel of property by the local tax assessor's office to identify it for property tax purposes. This number is specific to the real estate industry and is used primarily for property identification and record-keeping. |
openingHours | Array | Array of 7 elements of text with opening hours for 7 days. |
curbsidePickup | Boolean | True, if curb side pick up is available for this location. |
building | Building Object | This gives information about the building |
delivery | Delivery Object | This gives more information catered for delivery. Such as dropoff Type and specific delivery instructions for that address. |
boundaries | Feature Collection Object | Generally shape of the poi interest address, it is coordinates describing the address. |
photos | Array | Consists of array of pictures for that address. |
waypoints | Array of Feature Objects | This is different from features, waypoints are point objects inside the buildings such as elevators, stairs. |
entrances | Feature Collection Object | Entrances of the poi of interest address. It also have subkind as Emergency door and handicap doors. |
units | Feature Collection Object | Each unit in the building, with floor and unit number as their properties. |
footpaths | Feature Collection Object | Footpaths around the buildings |
parking | Feature Collection Object | Locations where visitors can park their vehicles. |
Building Object: Building Object provides comprehensive details, including height, area, length and floor for a specified point of interest
Parameter | Type | Descriptions |
---|---|---|
height | number | Height of the building |
area | number | Area spread out of the building |
length | number | Length of the building |
floor | number | Number of floors in the building. |
Feature Collection Object: This object encompasses multiple points of interest, providing a comprehensive representation of various features within the system. These contains GeoJson Collection Feature Object with features as points objects. Feature collection object is array of features.
Feature Object Details:
This represents a feature object that is presented as an array within Feature Collection objects.
Parameter | Type | Descriptions |
---|---|---|
type | string | Standard Geojson format type, it is point, polygon or line as string. You can read about it more here. |
geometry | Geojson Geometry | Array of coordinates for the point of that feature. |
properties | Object | consists name and Stoovo generated id. ( floor and unit for units) |
Delivery Object:
This specifies the delivery instructions and details on where to deliver.
Parameter | Type | Descriptions |
---|---|---|
dropoffType | string | One of mailbox, frontdoor, reception', mailroom, staff, backdoor, sideporch, garage |
buildingInstructions | string | Instructions on delivery package |
timeToDeliver | string | Average delivery times on this location. |
Waypoint Object:
It provides information and coordinates for a specific point inside the building. Generally helps in indoor navigation to that points. This is also feature collection object.
The following represents a feature object that is presented as an array within Feature Collection objects.
Parameter | Type | Descriptions |
---|---|---|
type | string | Standard Geojson format type, it is point object. You can read about it more here. |
geometry | GeoJSON Point Object | Geojson Point Object. |
properties | Waypoint Property Object | consists text (description of waypoint), id of the waypoint (id is Stoovo generated) and waypointKind. |
Waypoint Property Object:
Parameter | Type | Descriptions |
---|---|---|
type | waypointKind | Type of Waypoints |
Waypoints Kind Descriptions:
Waypoints | Descriptions |
---|---|
Elevator | An elevator inside the building |
Deliverylocker | A Delivery locker inside the building. |
Leasingoffice | A Leasing office inside the building. |
Stairs | A staircase inside the building. |
Bathroom | A Bathroom inside the building. |
Handicapramp | A Handicap ramp in the building. |
Here is the sample json with all the data.
Last updated