Places

Creates a new place.

post/places/v1/place

Request

  • Base URL: https://api.trimblemaps.com
  • URL: https://api.trimblemaps.com/places/v1/place
  • Auth: API key in header Authorization

Request body

brandstring nullable
customPlaceIdstring nullable

Your company-specific identifier for this place.

namestring required

The name of a place.

setIdinteger nullable

For company owned places, the Id of the place set containing this place.

categoryNamestring nullable

The name of the category assigned to this place.

formattedAddressstring nullable

A display formatted address of this place.

regionstring nullable

The region of this place

notesstring nullable

Any company specific notes.

breakApprovedboolean nullable

Indicates if this place is break approved.

restrictedFuelLocationboolean nullable

Indicates if this place is a restricted fuel location.

statusstring nullable

Indicates if this place is permanently/temporarily closed.

placeClassificationstring nullable

Indicates the type of this place.

promotableboolean nullable

Indicates if this Place can be made a public place by Trimble MAPS or if it's always private.

Example request

{
  "customPlaceId": "TRIMB57",
  "name": "Schneider Dairy",
  "categoryName": "Distribution Center",
  "formattedAddress": "123 Main Street, Pittsburgh, PA  15212",
  "status": "Temporarily Closed"
}

Response

Created

trimblePlaceIdstring nullable

The Trimble Place Id.

namestring nullable

The name of a place.

siteNamestring nullable

The name of a site.

customPlaceIdstring nullable

The Custom Place Id.

breakApprovedboolean nullable

Indicates if this place is break approved.

restrictedFuelLocationboolean nullable

Indicates if this place is a restricted fuel location.

statusstring nullable

Indicates if this place is permanently/temporarily closed.

placeClassificationstring nullable

The type of a place.

categoryNamestring nullable

The Category Name.

regionstring nullable

The region of this place

distanceOffRoutenumber double

The distance of this place from the route line.

brandstring nullable

Example response

{
  "trimblePlaceId": "0x6MTu_03diEyV9O5tusIVFg",
  "name": "Place Name",
  "siteName": "Site Name",
  "customPlaceId": "Company Name",
  "status": "Temporarily Closed",
  "placeClassification": "Premium",
  "categoryName": "Truck Repair"
}

Changes

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