Skip to main content
Skip table of contents

Get the list of plans

List of plans

GET /api/v1/maps

Parameters

int per_page, Number of elements in one pagination page.


int page, Pagination page number


string search, Filter


int camera, camera identifier, this field is for filtering plans that contain this camera


int group, Group ID for map filtration, if empty value returns Maps belongs for no Group.


string cluster_key, Filter plans by location in cluster on map


boolean has_location, Filtering plans, whether they have a location set or not.

200 OK

Successful response

JSON
{
    "data": [
        {
            "id": 14,
            "name": "test",
            "created_at": "2022-04-22 14:51:54",
            "updated_at": "2022-04-22 14:51:54",
            "url": "https://vms.local/storage/path.jpg",
            "cameras": [
                {
                    "x": 29,
                    "y": 82,
                    "angle": 61,
                    "radius": 50.5463836852,
                    "segment_angle": 80.3322,
                    "camera": {
                        "id": 92650,
                        "group_id": 52039,
                        "status": "active",
                        "type": "mediaserver_v2",
                        "start_at": "2022-03-23 14:51:54",
                        "created_at": "2020-11-27 16:40:23",
                        "billing_id": null,
                        "pretty_name": "camera 2",
                        "pretty_text": "Region region, District district, City, street Street 1",
                        "short_address": "City, street Street 1",
                        "full_address": "Region region, District district, City, street Street 1",
                        "lat": null,
                        "lng": null,
                        "azimuth": null,
                        "streams": [
                            {
                                "id": 204868,
                                "type": "high",
                                "camera_id": 92650,
                                "is_preview_from_server": true,
                                "is_archive_from_server": null,
                                "status": "active",
                                "has_sound": false
                            },
                            {
                                "id": 204871,
                                "type": "low",
                                "camera_id": 92650,
                                "is_preview_from_server": true,
                                "is_archive_from_server": null,
                                "status": "active",
                                "has_sound": false
                            }
                        ],
                        "services": {
                            "ptz": false,
                            "motion_detect": false
                        },
                        "has_sound": false,
                        "archive_recording_timetable": {
                            "days": [
                                {
                                    "to": "13:39:25",
                                    "from": "13:38:25",
                                    "type": "monday"
                                }
                            ]
                        },
                        "archive_ranges": [
                            {
                                "end": 1650627922,
                                "from": 1649312173,
                                "duration": 1315749
                            }
                        ],
                        "is_archive_recording": true,
                        "is_bridge": false,
                        "is_favorite": false,
                        "is_owner": true,
                        "can_change_archive_timetable": true,
                        "archive_recording_type": "timetable",
                        "user_status": "active",
                        "name": "camera 2"
                    }
                }
            ]
        }
    ],
    "links": {
        "first": "https://vms.local/api/v3/maps?page=1",
        "last": "https://vms.local/api/v3/maps?page=1",
        "prev": null,
        "next": null
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 1,
        "links": [
            {
                "url": null,
                "label": "pagination.previous",
                "active": false
            },
            {
                "url": "https://vms.local/api/v3/maps?page=1",
                "label": "1",
                "active": true
            },
            {
                "url": null,
                "label": "pagination.next",
                "active": false
            }
        ],
        "path": "https://vms.local/api/v3/maps",
        "per_page": 25,
        "to": 1,
        "total": 1
    }
}

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' \
	--header 'Content-Type: application/json' \
	--header 'Accept: application/json' \
	--data '{
    "per_page": 0,
    "page": 0,
    "search": "string",
    "camera": 0,
    "group": 0,
    "cluster_key": "string",
    "has_location": "boolean"
}'
PHP
PHP
$data = array (
  'per_page' => 0,
  'page' => 0,
  'search' => 'string',
  'camera' => 0,
  'group' => 0,
  'cluster_key' => 'string',
  'has_location' => 'boolean',
);
$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', false, $context);
JavaScript errors detected

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

If this problem persists, please contact our support.