GeoTree / Location

What can you do with GeoTreeLocation?


Properties

Property Details
id
"id": 791
Type: Number
This is the unique numeric identifier for the GeoTreeLocation
name
"name": "Hello World"
Type: String
depth
"depth": 813
Type: Number


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
  • depth

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 GeoTreeLocation object.

Standard PATCH objects:

DataFlow PATCH objects:


End Points

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