TAG LINE
SMALL TITLE
This entity represents a location with in the GeoTree object used in location rating.
identity READ-ONLY | "identity": 7 Type: Number This is the unique numeric identifier for the GeoTreeLocation |
name | "name": "United States" Type: String User defined name for the level in the GeoTree. |
depth READ-ONLY | "depth": 24 Type: Number System defined depth of the node within the GeoTree. |
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:
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:
| DELETE | api/v2/GeoTree/Location/{id} |
| Delete an instance of the GeoTreeLocation object. Upon successful delete, this API will return a record of all of the reelated objects deleted with this operation. The specifics on which objects have been deleted will depend on which related objects have been populated in the system. | |
| {id} | Unique identifier for the GeoTreeLocation object. |
Delete an instance of the GeoTreeLocation object. DELETE api/v2/GeoTree/Location/{id}HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"type": "delete",
"results": {
"totalCount": 4,
"items": [
{
"identity": 1,
"action": "deleted",
"dtoTypeKey": "geoTreeLocation"
},
{
"lhsId": 2,
"rhsId": 2,
"action": "detached",
"dtoTypeKey": "sampleObjectConnector"
},
{
"foreignKeyIdentity": 2,
"action": "deleted",
"dtoTypeKey": "sampleObject"
}
]
}
} | |
| GET | api/v2/GeoTree/Location/ |
| Retrieve all of the GeoTreeLocation objects. | |
Retrieve all of the GeoTreeLocation objects. GET api/v2/GeoTree/Location/ HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"totalCount": 1,
"items": [
{
"identity": 1,
"name": "United States",
"depth": 21
}
]
} | |
| GET | api/v2/GeoTree/Location/Paged |
| Retrieve all of the GeoTreeLocation objects in a paged fashion. This endpoint implements pagination for its results. Individual pages can be requested to return a particular paged set in the list of results. To learn more, see details on working with paginated endpoints. | |
Retrieve all of the GeoTreeLocation objects in a paged fashion. GET api/v2/GeoTree/Location/Paged HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"pagination": {
"pageNumber": 1,
"pageSize": 20,
"excludeTotalCount": false
},
"pagedResults": {
"totalCount": 1,
"items": [
{
"identity": 1,
"name": "United States",
"depth": 2
}
]
}
} | |
| GET | api/v2/GeoTree/Location/Paged/Detail |
| Retrieve all of the GeoTreeLocation objects in a paged fashion with all object details. This endpoint returns additional detailed data related to this object. The specifics on which data is returned will depend on which related objects have been populated in the system. | |
Retrieve all of the GeoTreeLocation objects in a paged fashion with all object details. GET api/v2/GeoTree/Location/Paged/Detail HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"pagination": {
"pageNumber": 1,
"pageSize": 20,
"excludeTotalCount": false
},
"pagedResults": {
"totalCount": 1,
"items": [
{
"identity": 1,
"name": "United States",
"depth": 15,
"details": {
"sampleSingleObject": {
"identity": 2,
"property1": "Sample Text",
"property2": "2021-04-26T15:25:29.117Z",
"property3": 2
},
"sampleMultipleObjects": {
"totalCount": 1,
"items": [
{
"identity": 2,
"property1": "Sample Text",
"property2": "2021-04-26T15:25:29.117Z",
"property3": 2
}
]
}
}
}
]
}
} | |
| GET | api/v2/GeoTree/Location/{id} |
| Retrieve an instance of the GeoTreeLocation object by its ID. | |
| {id} | Unique identifier for the GeoTreeLocation object. |
Retrieve an instance of the GeoTreeLocation object by its ID. GET api/v2/GeoTree/Location/{id}HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"instance": {
"identity": 1,
"name": "United States",
"depth": 24
}
} | |
| GET | api/v2/GeoTree/Location/{id}/Detail |
| Retrieve deep detail of the GeoTreeLocation object by its ID. This endpoint returns additional detailed data related to this object. The specifics on which data is returned will depend on which related objects have been populated in the system. | |
| {id} | Unique identifier for the GeoTreeLocation object. |
Retrieve deep detail of the GeoTreeLocation object by its ID. GET api/v2/GeoTree/Location/{id}/DetailHTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"instance": {
"identity": 1,
"name": "United States",
"depth": 18,
"details": {
"sampleSingleObject": {
"identity": 2,
"property1": "Sample Text",
"property2": "2021-04-26T15:25:29.117Z",
"property3": 2
},
"sampleMultipleObjects": {
"totalCount": 1,
"items": [
{
"identity": 2,
"property1": "Sample Text",
"property2": "2021-04-26T15:25:29.117Z",
"property3": 2
}
]
}
}
}
} | |
| PATCH | api/v2/GeoTree/Location/{id} |
| Update or Add the GeoTreeLocation object and optionally make changes to any child objects. Patch end points allow for adding/updating multiple related entities and the results of those changes will be reported in the response JSON payload in the items array. | |
| {id} | Unique identifier for the GeoTreeLocation object. |
Update or Add the GeoTreeLocation object and optionally make changes to any child objects. PATCH api/v2/GeoTree/Location/{id}
{
"details": {},
"geoTreeLocations": {
"items": [
{
"patchType": "create",
"patchClientId": 1,
"name": "United States"
}
]
}
}HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"type": "patch",
"results": {
"totalCount": 1,
"items": [
{
"identity": 1,
"action": "created",
"dtoTypeKey": "geoTreeLocation",
"instance": {
"identity": 1,
"name": "United States",
"depth": 22
}
}
]
}
} | |
| POST | api/v2/GeoTree/Location/ |
| Create a new instance of the GeoTreeLocation object. | |
Create a new instance of the GeoTreeLocation object. POST api/v2/GeoTree/Location/
{
"name": "United States"
}HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"type": "create",
"results": {
"totalCount": 1,
"items": [
{
"identity": 1,
"name": "United States",
"depth": 7
}
]
}
} | |
| PUT | api/v2/GeoTree/Location/{id} |
| Update an existing instance of the GeoTreeLocation object. | |
Update an existing instance of the GeoTreeLocation object. PUT api/v2/GeoTree/Location/{id}
{
"identity": 1,
"name": "United States"
}HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"type": "update",
"results": {
"totalCount": 1,
"items": [
{
"identity": 1,
"name": "United States",
"depth": 14
}
]
}
} | |