Overlays: Shapes

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

Supported Roles
Available Services
1. All Shapes
2. Individual Shapes
Shapes 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 Shapes

`/<API Version>/overlays/shapes`

HTTP Method	Description	Conditional	Notes
GET	Returns all Shapes 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"=>"20191106151949018148000000",
                "ResourceUri"=>"/v1/overlays/shapes/20191106151949018148000000",
                "Name"=>"48 @ Arenas",
                "Color"=>"0069ff",
                "OverlayId"=>"20191106144534070706000000",
                "OwnerId"=>"20000426143505724628000000",
                "Geometry"=>"polygon('33.820046 -116.540125,33.820034 -116.541208,33.821468 -116.541208,33.82148 -116.540137,33.820046 -116.540125')"
            },
            {
                "Id"=>"20191106151948929550000000",
                "ResourceUri"=>"/v1/overlays/shapes/20191106151948929550000000",
                "Name"=>"48 @ Baristo",
                "Color"=>"0069ff",
                "OverlayId"=>"20191106144534070706000000",
                "OwnerId"=>"20000426143505724628000000",
                "Geometry"=>"polygon('33.81961 -116.529288,33.819606 -116.529288,33.819611 -116.530393,33.821319 -116.530404,33.82133 -116.529326,33.81961 -116.529288')"
            }
        ],
        "Success": true
    }
}

Individual Overlay Shape

`/<API Version>/overlays/shapes/<Shape.Id>`

HTTP Method	Description	Conditional	Notes
GET	Returns a specified Shape 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"=>"20191106151948929550000000",
                "ResourceUri"=>"/v1/overlays/shapes/20191106151948929550000000",
                "Name"=>"48 @ Baristo",
                "Color"=>"0069ff",
                "OverlayId"=>"20191106144534070706000000",
                "OwnerId"=>"20000426143505724628000000",
                "Geometry"=>"polygon('33.81961 -116.529288,33.819606 -116.529288,33.819611 -116.530393,33.821319 -116.530404,33.82133 -116.529326,33.81961 -116.529288')"
            }
        ],
        "Success": true
    }
}

Overlays Description

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

Expansions

None.