GeoTree / Location / Pattern

(API Version v10)

This entity represents a pattern to use on a mediated record to determine if it belongs to a Location. In telecom a good example of this is the area or country code.

What can you do with GeoTreeLocationPattern?

DELETE GeoTree/Location/Pattern/{id}
Delete an instance of the GeoTreeLocationPattern object.
GET GeoTree/Location/Pattern/
Retrieve all of the GeoTreeLocationPattern objects.
GET GeoTree/Location/Pattern/Paged
Retrieve all of the GeoTreeLocationPattern objects in a paged fashion.
GET GeoTree/Location/Pattern/{id}
Retrieve an instance of the GeoTreeLocationPattern object by its ID.
POST GeoTree/Location/Pattern/
Create a new instance of the GeoTreeLocationPattern object.
PUT GeoTree/Location/Pattern/{id}
Update an existing instance of the GeoTreeLocationPattern object.

Properties

Property Details

identity READ-ONLY	"identity": 9 Type: Number This is the unique numeric identifier for the GeoTreeLocationPattern
name	"name": "01" Type: String User defined name for the pattern.
geoTreeLocationId	"geoTreeLocationId": 12 Type: Number Unique identifier for the associated GeoTreeLocation object.
geoTreeLocationName	"geoTreeLocationName": "Sample Name" Type: String The name of the object associated with the geoTreeLocationId property.
country	"country": "US" Type: String User defined country name for the pattern.
state	"state": "CA" Type: String User defined state for the pattern.
city	"city": "LA" Type: String User defined city for the pattern
lata	"lata": "Hello World" Type: String Unused

End Points

DELETE	GeoTree/Location/Pattern/{id}
Delete an instance of the GeoTreeLocationPattern 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 GeoTreeLocationPattern object.
Delete an instance of the GeoTreeLocationPattern object. DELETE GeoTree/Location/Pattern/{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": "geoTreeLocationPattern" }, { "lhsId": 2, "rhsId": 2, "action": "detached", "dtoTypeKey": "sampleObjectConnector" }, { "foreignKeyIdentity": 2, "action": "deleted", "dtoTypeKey": "sampleObject" } ] } }

Retrieve all of the GeoTreeLocationPattern objects.

GET GeoTree/Location/Pattern/

View Sample Response

HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "totalCount": 1,
    "items": [
        {
            "identity": 1,
            "name": "01",
            "geoTreeLocationId": 9,
            "geoTreeLocationName": "Sample Text Data",
            "country": "US",
            "state": "CA",
            "city": "LA",
            "lata": "Sample Text Data"
        }
    ]
}

Retrieve all of the GeoTreeLocationPattern 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 GeoTreeLocationPattern objects in a paged fashion.

GET GeoTree/Location/Pattern/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": "01",
                "geoTreeLocationId": 3,
                "geoTreeLocationName": "Sample Text Data",
                "country": "US",
                "state": "CA",
                "city": "LA",
                "lata": "Sample Text Data"
            }
        ]
    }
}

GET	GeoTree/Location/Pattern/{id}
Retrieve an instance of the GeoTreeLocationPattern object by its ID.
{id}	Unique identifier for the GeoTreeLocationPattern object.
Retrieve an instance of the GeoTreeLocationPattern object by its ID. GET GeoTree/Location/Pattern/{id} View Sample Response HTTP/1.1 200 OK { "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b", "instance": { "identity": 1, "name": "01", "geoTreeLocationId": 20, "geoTreeLocationName": "Sample Text Data", "country": "US", "state": "CA", "city": "LA", "lata": "Sample Text Data" } }

Create a new instance of the GeoTreeLocationPattern object.

POST GeoTree/Location/Pattern/

{
    "name": "01",
    "geoTreeLocationId": 13,
    "country": "US",
    "state": "CA",
    "city": "LA",
    "lata": "Sample Text Data"
}

View Sample Response

HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "type": "create",
    "results": {
        "totalCount": 1,
        "items": [
            {
                "identity": 1,
                "name": "01",
                "geoTreeLocationId": 24,
                "geoTreeLocationName": "Sample Text Data",
                "country": "US",
                "state": "CA",
                "city": "LA",
                "lata": "Sample Text Data"
            }
        ]
    }
}

Update an existing instance of the GeoTreeLocationPattern object.

PUT GeoTree/Location/Pattern/{id}

{
    "identity": 1,
    "name": "01",
    "geoTreeLocationId": 23,
    "country": "US",
    "state": "CA",
    "city": "LA",
    "lata": "Sample Text Data"
}

View Sample Response

HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "type": "update",
    "results": {
        "totalCount": 1,
        "items": [
            {
                "identity": 1,
                "name": "01",
                "geoTreeLocationId": 21,
                "geoTreeLocationName": "Sample Text Data",
                "country": "US",
                "state": "CA",
                "city": "LA",
                "lata": "Sample Text Data"
            }
        ]
    }
}