GeoTree / Location Group

What can you do with GeoTreeLocationGroup?


Properties

Property Details
id
"id": 263
Type: Number
This is the unique numeric identifier for the GeoTreeLocationGroup
ownerId
"ownerId": 591
Type: Number
Unique identifier for the associated Owner object.
name
"name": "Hello World"
Type: String
description
"description": "Hello World"
Type: String
sortOrder
"sortOrder": 924
Type: Number
visible
"visible": true
Type: Boolean


Update Request Filters

When updating an object you use the update request header with the list of properties to update. Then you need only supply the new values in the body of your request. Please note, this header can only be used with PUT or PATCH requests.

Field List:

  • name
  • description
  • sortOrder
  • visible

Patch Types

The PATCH verb allows you to update an object. Just like a put, you only need to supply the fields that will be updated in the payload. However, a patch allows you to update many objects at once.

PATCH operations can be used as a standard API call or nested within the envelope of a DataFlow. Below you will find the child objects that can be updated as part of PATCH operations for the GeoTreeLocationGroup object.

Standard PATCH objects:

DataFlow PATCH objects:


End Points

DELETEapi/v1/GeoTree/LocationGroup/{id:int}
Delete an instance of the GeoTreeLocationGroup object.
GETapi/v1/GeoTree/LocationGroup
Retrieve all of the GeoTreeLocationGroup objects.
GETapi/v1/GeoTree/LocationGroup/Metadata
Retrieve all of the meta data details of the GeoTreeLocationGroup object.
GETapi/v1/GeoTree/LocationGroup/Metadata/{option}
Retrieve all the meta data details of the GeoTreeLocationGroup object based on provided options.
{option}Metadata options for the GeoTreeLocationGroup object.
GETapi/v1/GeoTree/LocationGroup/Paged
Retreive all of the GeoTreeLocationGroup objects in a paged fashion.
GETapi/v1/GeoTree/LocationGroup/Paged/Detail
Retreive all of the GeoTreeLocationGroup objects in a paged fashion with all object details.
GETapi/v1/GeoTree/LocationGroup/{id:int}
Retrieve an instance of the GeoTreeLocationGroup object by it's ID.
{id:int}Unique identifier for the GeoTreeLocationGroup object.
GETapi/v1/GeoTree/LocationGroup/{id:int}/Detail
Retreive all of the Detail objects for the specified GeoTreeLocationGroup.
{id:int}Unique identifier for the GeoTreeLocationGroup object.
PATCHapi/v1/GeoTree/LocationGroup/{id:int}
Update the GeoTreeLocationGroup object and optionally make changes to any child objects.
POSTapi/v1/GeoTree/LocationGroup
Create a new instance of the GeoTreeLocationGroup object.
PUTapi/v1/GeoTree/LocationGroup/{id:int}
Update an existing instance of the GeoTreeLocationGroup object.