Get All Places in a Place Set

Table of 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

NameDescriptionData Type
IdUnique place identifier
Int
DeletedIndicates whether place still exists. Note that this call will not get back deleted places
boolean
ModifiedOnIndicates the last time the place was modified
DateTime
SetIdUnique set identifier to which this place belongs
Int
PlaceNameName of the place
string
ExternalPlaceIdUnique external place Id
Alphanumeric
SiteIdUnique identifier for site around the place
Int
AddressAddress of the location
Complex
CoordsCoordinates of the location
Complex
InfoComments or description about a place
string
PhonePhone number of the place
string
hrefLink to the next page in the response
string
methodHTTP Request type to retrieve the next page
string

Address

DataDescriptionData Type
StreetAddressThe house number and street name
string
CityThe name of the city
string
StateThe two letter state abbreviation
string
PostalCodeThe postal code or zip
string
CountryThe name of the country
string

Coords

DataDescriptionData Type
LatLatitude as a signed decimal with 6 digits to the right of the decimal. (For example, 40.360621)
string
LonLongitude 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

MessageDescription
401 UnauthorizedThis error is thrown when Authorization token is invalid or expired.
Cannot find set with supplied idThis error is thrown when the setId does not belong to the account.
Last updated March 21, 2020.