Overlays: Geometries

The Overlays: Geometries service returns Geometries that are present in Overlays.

Supported Roles
Available Services
1. All Geometries
2. Individual Geometries
Geometries Description
Expansions

Supported Roles

Role	Reads	Writes
IDX	Yes	No
Public	Yes	No
VOW	Yes	No
Portal	Yes	No
Private	Yes	No

More information about roles may be found here.

Available Services

All Geometries

`/<API Version>/overlays/geometries`

HTTP Method	Description	Conditional	Notes
GET	Returns all Geometries available to the user	No
POST	Returns HTTP 405 (Method Not Allowed)	No	Not implemented
PUT	Returns HTTP 405 (Method Not Allowed)	No	Not implemented
DELETE	Returns HTTP 405 (Method Not Allowed)	No	Not implemented

GET Request

Parameters:

Parameter	Required	Notes
Standard search and paging syntax	No

GET Response

{
    "D": {
        "Results": [
            {
                "Id": "20160818195911460101000000",
                "ResourceUri": "/v1/overlays/geometries/20160818195911460101000000",
                "Name": "A2",
                "Color": "0069ff",
                "OverlayId": "20160818195911449822000000",
                "OwnerId": "20000426143505724628000000",
                "Wkt": "POLYGON((-96.837054 46.862653,-96.80049 46.872863,-96.786242 46.855492,-96.786929 46.854671,-96.837054 46.862653))",
                "CreatedTimestamp": "2016-08-18T19:59:11Z",
                "ModificationTimestamp": "2016-08-18T19:59:11Z"
            },
            {
                "Id": "20200910234008616750000000",
                "ResourceUri": "/v1/overlays/geometries/20200910234008616750000000",
                "Name": "A polygon",
                "Color": "0069ff",
                "OverlayId": "20100301164936991456000000",
                "OwnerId": "20000426143505724628000000",
                "Wkt": "POLYGON((-96.888569 46.904634,-96.878612 46.878357,-96.815441 46.878826,-96.84737 46.913781,-96.888569 46.904634))",
                "CreatedTimestamp": "2020-09-10T23:40:08Z",
                "ModificationTimestamp": "2020-09-10T23:40:08Z"
            }
        ],
        "Success": true
    }
}

Individual Overlay Geometry

`/<API Version>/overlays/geometries/<Geometry.Id>`

HTTP Method	Description	Conditional	Notes
GET	Returns a specified Geometry record	No
POST	Returns HTTP 405 (Method Not Allowed)	No	Not implemented
PUT	Returns HTTP 405 (Method Not Allowed)	No	Not implemented
DELETE	Returns HTTP 405 (Method Not Allowed)	No	Not implemented

GET Request

Parameters:

None

GET Response

{
    "D": {
        "Results": => [
            {
                "Id": "20160818195911460101000000",
                "ResourceUri": "/v1/overlays/geometries/20160818195911460101000000",
                "Name": "A2",
                "Color": "0069ff",
                "OverlayId": "20160818195911449822000000",
                "OwnerId": "20000426143505724628000000",
                "Wkt": "POLYGON((-96.837054 46.862653,-96.80049 46.872863,-96.786242 46.855492,-96.786929 46.854671,-96.837054 46.862653))",
                "CreatedTimestamp": "2016-08-18T19:59:11Z",
                "ModificationTimestamp": "2016-08-18T19:59:11Z"
            }
        ],
        "Success": true
    }
}

Overlays Description

Attribute	Data Type	Description
`Id`	Character	The unique id for the Geometry.
`ResourceUri`	Character	The URI to the Geometry.
`Name`	Character	The Name of the Geometry.
`Color`	Character	RGB hex code for color for shape.
`OverlayId`	Character	The Overlay.Id for the Overlay to which the Geometry belongs.
`OwnerId`	Character	The Account.Id of the Geometry's owner.
`Wkt`	Character	The Geometry literal as Well-known text.

Expansions

None.