Get All Places in a Place Set

Contents

GET /places/{setId}/placeset

Returns all places contained within a place set. The response is paginated and 100 places are returned with a parameter that has a link to fetch the next page of results, if available.

Request

Authorization: bearer {token}

Response

Name Description Data Type
Id Unique place identifier
Int
Deleted Indicates whether place still exists. Note that this call will not get back deleted places
boolean
ModifiedOn Indicates the last time the place was modified
DateTime
SetId Unique set identifier to which this place belongs
Int
PlaceName Name of the place
string
ExternalPlaceId Unique external place Id
Alphanumeric
SiteId Unique identifier for site around the place
Int
Address Address of the location
Complex
Coords Coordinates of the location
Complex
Info Comments or description about a place
string
Phone Phone number of the place
string
href Link to the next page in the response
string
method HTTP Request type to retrieve the next page
string

Address

Data Description Data Type
StreetAddress The house number and street name
string
City The name of the city
string
State The two letter state abbreviation
string
PostalCode The postal code or zip
string
Country The name of the country
string

Coords

Data Description Data Type
Lat Latitude as a signed decimal with 6 digits to the right of the decimal. (For example, 40.360621)
string
Lon Longitude as a signed decimal with 6 digits to the right of the decimal. (For example, -74.599027)
string

Sample Response

{
  "data": [
    {
      "Id": 6017941,
      "Deleted": false,
      "SetId": 162288,
      "PlaceName": "Business Location 1",
      "ExternalPlaceId": null,
      "SiteId": 123456,
      "Address": {
        "StreetAddress": "18320 Bixby Avenue",
        "City": "Elgin",
        "State": "IA",
        "PostalCode": "52141",
        "Country": "US"
      },
      "Coords": {
        "Lat": "42.959849",
        "Lon": "-91.55673"
      },
      "Info": null,
      "Phone": null
    },
    {
      "Id": 6017949,
      "Deleted": false,
      "SetId": 162288,
      "PlaceName": "Business Location 2",
      "ExternalPlaceId": null,
      "SiteId": 123457,
      "Address": {
        "StreetAddress": "17963 Pregal Drive",
        "City": "Hillpoint",
        "State": "WI",
        "PostalCode": "53937",
        "Country": "US"
      },
      "Coords": {
        "Lat": "43.444319",
        "Lon": "-90.200388"
      },
      "Info": null,
      "Phone": null
    }
  ],
  "next": {
    "href": "https://contentapi.trimblemaps.com/api/v1/places/380946/placeset?pageSize=2&pageNumber=2",
    "method": "GET"
  }
}

Error Codes

Message Description
401 Unauthorized This error is thrown when Authorization token is invalid or expired.
Cannot find set with supplied id This error is thrown when the setId does not belong to the account.
Last updated September 24, 2020.