Places

Create a suggestion for a place

post/places/v1/{place_handle}/suggestions/

Request

Base URL
https://v3.api.hypertrack.com
Auth
- HTTP basic
- or HTTP bearer
TypeScript
https://skmtc.dev/hypertrack/apis/hypertrack-api/docs/places/v1/:place_handle/suggestions/post.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

place_handlestring required

Request body

radiusinteger nullable

Radius in meters for point geometry suggestions

suggested_bystring nullable

User who suggested this geofence

order_handlestring nullable

Order handle associated with this suggestion

Response

Successful response

suggestion_idstring required

Unique identifier for the suggestion

radiusinteger nullable

Radius in meters for point geometry suggestions

hex_idstring required

Hex ID associated with this suggestion

applied_bystring nullable

User who applied this suggestion

applied_onstring nullable

Time when this suggestion was applied

suggested_bystring nullable

User who suggested this geofence

suggested_onstring required

Time when this suggestion was made

order_handlestring nullable

Order handle associated with this suggestion

source'ht_generated' | 'customer_provided'

Source which created this suggestion

typestring

Type of suggestion (manual, inferred, bounding_box)

skewnumber nullable

Skew between current geofence and suggestion, values can be between 0 and 1. 0 means no skew (perfect overlap) and 1 means no overlap

area_rationumber nullable

Ratio of suggested geometry area to current geofence area (suggested/current)

centroid_shiftnumber nullable

Distance in meters between the centroid of current geofence and suggestion

inclusivitystring nullable

More inclusivity means more loosely defined service area

Changes

No recorded changes to this operation across all 1 revision of this API.