Skip to main content
Skip table of contents

Get the list of plans in the client group

List of plans in a group

List of plans available to the user in a given plan group

GET /api/v1/maps-by-group/{group}

Parameters

int group, Group ID, if not passed, root maps will be returned.


string search, Search by name of parent group name, map name or camera name

200 OK

Camera list

JSON
[
    {
        "id": 1,
        "name": "map-1",
        "group_id": 1,
        "created_at": "2024-05-31T08:10:04.000000Z",
        "updated_at": "2024-05-31T09:16:02.000000Z",
        "url": "http://localhost:8080/storage/maps/2024/5/31/hotU8REJn66CI6VBTuAiH2OjTWmZLUY1Fto6MAbB.jpg",
        "latitude": 11.111111,
        "longitude": 22.222222
    }
]

200 OK

Empty list if there are no plans in the group

JSON
null

401 Unauthorized

Authorization token not sent or not valid

422 Unprocessable Entity

Returns a JSON object with an error.

JSON
{
    "message": "There will be no informative message here",
    "errors": {
        "any_key": [
            "The cause of the error will be described here"
        ]
    }
}
cURL
BASH
curl -k --request POST \
	--url 'https://your-domain/api/v1/maps-by-group/{group}' \
	--header 'Content-Type: application/json' \
	--header 'Accept: application/json' \
	--data '{
    "group": 0,
    "search": "string"
}'
PHP
PHP
$data = array (
  'group' => 0,
  'search' => 'string',
);
$context = stream_context_create([
	'ssl'=>['verify_peer' => false],
	'http' => [
		'method' => 'GET',
		'header' => "Content-Type: application/json\r
Accept: application/json",
		'content'=>json_encode($data)
	]
]);
$result = file_get_contents('https://your-domain/api/v1/maps-by-group/{group}', false, $context);
JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.