GeoTree / Location

(API Version v10)

This entity represents a location with in the GeoTree object used in location rating.

What can you do with GeoTreeLocation?

DELETE GeoTree/Location/{id}
Delete an instance of the GeoTreeLocation object.
GET GeoTree/Location/
Retrieve all of the GeoTreeLocation objects.
GET GeoTree/Location/Paged
Retrieve all of the GeoTreeLocation objects in a paged fashion.
GET GeoTree/Location/Paged/Detail
Retrieve all of the GeoTreeLocation objects in a paged fashion with all object details.
GET GeoTree/Location/{id}
Retrieve an instance of the GeoTreeLocation object by its ID.
GET GeoTree/Location/{id}/Detail
Retrieve deep detail of the GeoTreeLocation object by its ID.
PATCH GeoTree/Location/{id}
Update or Add the GeoTreeLocation object and optionally make changes to any child objects.
POST GeoTree/Location/
Create a new instance of the GeoTreeLocation object.
PUT GeoTree/Location/{id}
Update an existing instance of the GeoTreeLocation object.

Properties

Property Details

identity READ-ONLY	"identity": 15 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": 25 Type: Number System defined depth of the node within the GeoTree.

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. Below you will find the child objects that can be updated as part of PATCH operations for the GeoTreeLocation object.

Standard PATCH objects:

geoTreeLocationPattern - create, update, delete

DataFlow PATCH objects:

geoTreeLocation - create, update, delete
geoTreeLocationPattern - create, update, delete

End Points

DELETE	GeoTree/Location/{id}
Delete an instance of the GeoTreeLocation object. Upon successful delete, this API will return a record of all of the related 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 GeoTree/Location/{id} View Sample Response 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	GeoTree/Location/
Retrieve all of the GeoTreeLocation objects.
Retrieve all of the GeoTreeLocation objects. GET GeoTree/Location/ View Sample Response HTTP/1.1 200 OK { "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b", "totalCount": 1, "items": [ { "identity": 1, "name": "United States", "depth": 14 } ] }

GET	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 GeoTree/Location/Paged View Sample Response 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": 0 } ] } }

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 GeoTree/Location/Paged/Detail

View Sample Response

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": 27,
                "details": {
                    "identity": 14,
                    "name": "Sample Text Data",
                    "geoTreeLocationId": 95,
                    "geoTreeLocationName": "Sample Text Data",
                    "country": "Sample Text Data",
                    "state": "Sample Text Data",
                    "city": "Sample Text Data",
                    "lata": "Sample Text Data"
                }
            }
        ]
    }
}

GET	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 GeoTree/Location/{id} View Sample Response HTTP/1.1 200 OK { "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b", "instance": { "identity": 1, "name": "United States", "depth": 26 } }

GET	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 GeoTree/Location/{id}/Detail View Sample Response HTTP/1.1 200 OK { "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b", "instance": { "identity": 1, "name": "United States", "depth": 15, "details": { "identity": 14, "name": "Sample Text Data", "geoTreeLocationId": 95, "geoTreeLocationName": "Sample Text Data", "country": "Sample Text Data", "state": "Sample Text Data", "city": "Sample Text Data", "lata": "Sample Text Data" } } }

PATCH	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 GeoTree/Location/{id} { "details": {}, "geoTreeLocations": { "items": [ { "patchType": "create", "patchClientId": 1, "name": "United States" } ] } } View Sample Response 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": 11 } } ] } }

Create a new instance of the GeoTreeLocation object.

POST GeoTree/Location/

{
    "name": "United States"
}

View Sample Response

HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "type": "create",
    "results": {
        "totalCount": 1,
        "items": [
            {
                "identity": 1,
                "name": "United States",
                "depth": 11
            }
        ]
    }
}

Update an existing instance of the GeoTreeLocation object.

PUT GeoTree/Location/{id}

{
    "identity": 1,
    "name": "United States"
}

View Sample Response

HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "type": "update",
    "results": {
        "totalCount": 1,
        "items": [
            {
                "identity": 1,
                "name": "United States",
                "depth": 1
            }
        ]
    }
}