Places

Get the standard information about a single place.

The placeId provided can either be a Trimble Place Id or a Custom Place Id.

get/places/v1/place/{placeId}

Request

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

Path parameters

placeIdstring required

The identifier of the place to return.

Response

A place.

brandstring nullable
trimblePlaceIdstring nullable

The unique Trimble identifier for this place.

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

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.

lastModifiedstring date-time

The date and time this place was last updated.

Example response

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

Changes

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