diff --git a/source/index.html.md b/source/index.html.md
index 6e3b766597f..f01dd4769cd 100644
--- a/source/index.html.md
+++ b/source/index.html.md
@@ -423,7 +423,25 @@ curl "https://my.timelline.is/api/v3p/locations/:id/arm" \
-H "Content-Type: application/json"
```
-> The above command returns 200 status without body
+> The above command returns JSON structured like this:
+
+```json
+{
+ "data": {
+ "armed": true,
+ "when": "2021-11-17T14:54:31.487+02:00"
+ },
+ "jsonapi": { "version": "1.0" }
+}
+```
+
+**Response fields**
+
+| Name | Located in | Description | Type |
+| ---- | ---------- | ----------- | ---- |
+| armed | data | Displays arm action | Boolean |
+| when | data | Date/time when arm will happen | Datetime |
+
## Disarm location
This endpoint disarms location with passed delay.
@@ -446,7 +464,25 @@ curl "https://my.timelline.is/api/v3p/locations/:id/disarm" \
-H "Content-Type: application/json"
```
-> The above command returns 200 status without body
+> The above command returns JSON structured like this:
+
+```json
+{
+ "data": {
+ "armed": false,
+ "when": "2021-11-17T14:54:31.487+02:00"
+ },
+ "jsonapi": { "version": "1.0" }
+}
+```
+
+**Response fields**
+
+| Name | Located in | Description | Type |
+| ---- | ---------- | ----------- | ---- |
+| armed | data | Displays disarm action | Boolean |
+| when | data | Date/time when disarm will happen | Datetime |
+
# LPR
## Get license plates
@@ -831,7 +867,24 @@ curl "https://my.timelline.is/api/v3p/zones/arm" \
-H "Content-Type: application/json"
```
-> The above command returns 200 status without body
+> The above command returns JSON structured like this:
+
+```json
+{
+ "data": {
+ "armed": true,
+ "when": "2021-11-17T14:54:31.487+02:00"
+ },
+ "jsonapi": { "version": "1.0" }
+}
+```
+
+**Response fields**
+
+| Name | Located in | Description | Type |
+| ---- | ---------- | ----------- | ---- |
+| armed | data | Displays arm action | Boolean |
+| when | data | Date/time when arm will happen | Datetime |
@@ -856,8 +909,24 @@ curl "https://my.timelline.is/api/v3p/zones/disarm" \
-H "Content-Type: application/json"
```
-> The above command returns 200 status without body
+> The above command returns JSON structured like this:
+```json
+{
+ "data": {
+ "armed": false,
+ "when": "2021-11-17T14:54:31.487+02:00"
+ },
+ "jsonapi": { "version": "1.0" }
+}
+```
+
+**Response fields**
+
+| Name | Located in | Description | Type |
+| ---- | ---------- | ----------- | ---- |
+| armed | data | Displays arm action | Boolean |
+| when | data | Date/time when disarm will happen | Datetime |
@@ -1465,8 +1534,7 @@ This endpoint retrieves all recordings related to user.
| urls | attributes | URLs for event | Object |
| prev_recording_id | attributes | Previously recording identifier | String |
| next_recording_id | attributes | Next recording identifier | String |
-| relationships | data | Object stores information about timelapses and their identifiers | Object |
-| included | data | Stores information about thumbnail timelapses and their identifiers | Array |
+| timelapses | attributes | Stores information about thumbnail timelapse paths and their random identifiers (random per recording object)| Array |
```shell
curl "https://my.timeline.is/api/v3p/recordings?zone_id=5f06e4e741092794a7010c29&at=2020-04-25T08:03:36.094+01:00" -H "Authorization: Bearer YOUR_OAUTH_TOKEN"
@@ -1476,290 +1544,134 @@ curl "https://my.timeline.is/api/v3p/recordings?zone_id=5f06e4e741092794a7010c29
```json
{
"data": [{
- "id": "6101404183825a26993e6dcc",
+ "id": "5d1f0c0a41092775efbddfe7",
"type": "recordings",
"attributes": {
"agent_image": true,
"agent_video": true,
- "checksum": "d0aa470033c415197017fd26dcc33eaeb187d714",
- "cloud_path": "https://s3.eu-west-2.amazonaws.com/xancloud.com/monitor/efi-test/internal/5cb588e083825a669055cf99/20210728_13/20210728_133106_to_133206.jpg",
+ "checksum": null,
+ "cloud_path": null,
"cloud_snapshot": true,
- "cloud_thumbnail": false,
- "cloud_timelapse": false,
+ "cloud_thumbnail": true,
+ "cloud_timelapse": true,
"cloud_timelapse_error": null,
"cloud_timelapse_interval": null,
- "cloud_video": false,
+ "cloud_video": true,
"cloud_waveform": false,
- "created_at": "2021-07-28T12:32:17.331+01:00",
- "ends_at": "2021-07-28T12:32:06.000+01:00",
- "ends_at_seconds_since_midnight": 45126,
- "filesize": 23265840,
+ "created_at": "2019-07-05T09:36:26.584+01:00",
+ "ends_at": "2019-03-02T16:02:26.577+00:00",
+ "ends_at_seconds_since_midnight": 57746,
+ "filesize": 0,
"flagged": false,
- "motion": 0.148,
- "object_count": 1,
- "path": "/internal/5cb588e083825a669055cf99/20210728_13/20210728_133106_to_133206.mp4",
+ "motion": 0,
+ "object_count": 0,
+ "path": "/recordings/et406",
"skip_notify": false,
- "starts_at": "2021-07-28T12:31:06.000+01:00",
- "starts_at_seconds_since_midnight": 45066,
- "updated_at": "2021-07-28T12:32:17.503+01:00",
+ "starts_at": "2019-03-02T16:01:26.577+00:00",
+ "starts_at_seconds_since_midnight": 57686,
+ "updated_at": "2019-07-05T09:36:26.584+01:00",
"seek_to_event": 0,
- "epoch_time": "28072021-1231PM-1232PM",
- "agent_id": "5d2b130383825a5dffe34bc0",
- "camera_id": "5cb588e083825a669055cf99",
+ "epoch_time": "02032019-0401PM-0402PM",
+ "agent_id": "5d1f0be841092775efbddb7e",
+ "camera_id": "5d1f0bf541092775efbddd33",
"device_id": null,
- "event_id": "61013f9283825a612b7f2895",
+ "event_id": "5d1f0c0a41092775efbddfe2",
"flagged_by_id": null,
- "location_id": "558fd39578616e3705000023",
- "timeline_id": "56fc1da8a0fff57b229298c6",
+ "location_id": "5d1f0be741092775efbddb71",
+ "timeline_id": "5d1f0be641092775efbddb62",
"unflagged_by_id": null,
- "zone_id": "5cb588e083825a669055cf98",
+ "zone_id": "5d1f0bf541092775efbddd32",
"urls": {
- "proxy": "/recordings/6101404183825a26993e6dcc/view?token=YULw7qm9fefoLZmBOF3jBw",
- "proxy_download": "/recordings/6101404183825a26993e6dcc/download",
- "proxy_snapshot": "https://s3.eu-west-2.amazonaws.com/xancloud.com/monitor/efi-test/internal/5cb588e083825a669055cf99/20210728_13/20210728_133106_to_133206.jpg",
- "local": "lan-efi-test.xancloud.com/api/v3/recordings/download.mp4?recording%5Bpath%5D=%2Finternal%2F5cb588e083825a669055cf99%2F20210728_13%2F20210728_133106_to_133206.mp4&token=feAQlGjqBigML1__A2LAfg",
- "local_snapshot": "lan-efi-test.xancloud.com/api/v3/recordings/snapshot?recording%5Bpath%5D=%2Finternal%2F5cb588e083825a669055cf99%2F20210728_13%2F20210728_133106_to_133206.jpg&token=feAQlGjqBigML1__A2LAfg",
- "external": "external-efi-test.xancloud.com/api/v3/recordings/download.mp4?recording%5Bpath%5D=%2Finternal%2F5cb588e083825a669055cf99%2F20210728_13%2F20210728_133106_to_133206.mp4&token=feAQlGjqBigML1__A2LAfg",
- "external_snapshot": "external-efi-test.xancloud.com/api/v3/recordings/snapshot?recording%5Bpath%5D=%2Finternal%2F5cb588e083825a669055cf99%2F20210728_13%2F20210728_133106_to_133206.jpg&token=feAQlGjqBigML1__A2LAfg"
+ "proxy": "https://s3.eu-west-2.amazonaws.com/xancloud.com/customer-timeline/porro13/recordings/et406",
+ "proxy_download": "https://s3.eu-west-2.amazonaws.com/xancloud.com/customer-timeline/porro13/recordings/et406",
+ "proxy_snapshot": "https://s3.eu-west-2.amazonaws.com/xancloud.com/customer-timeline/porro13/recordings/et406.jpg",
+ "local": "127.0.0.1:2999/api/v3/recordings/download.mp4?recording%5Bpath%5D=%2Frecordings%2Fet406&token=tc49Xv1q84dWYPmuhpBLFw",
+ "local_snapshot": "127.0.0.1:2999/api/v3/recordings/snapshot?recording%5Bpath%5D=%2Frecordings%2Fet406.jpg&token=tc49Xv1q84dWYPmuhpBLFw",
+ "external": "external-porro13.xancloud.com/api/v3/recordings/download.mp4?recording%5Bpath%5D=%2Frecordings%2Fet406&token=tc49Xv1q84dWYPmuhpBLFw",
+ "external_snapshot": "external-porro13.xancloud.com/api/v3/recordings/snapshot?recording%5Bpath%5D=%2Frecordings%2Fet406.jpg&token=tc49Xv1q84dWYPmuhpBLFw"
},
- "prev_recording_id": "6101400d83825a26993e6dcb",
- "next_recording_id": "610140f683825a26983e6dcb"
- },
- "relationships": {
- "timelapses": {
- "data": [{
- "type": "timelapses",
- "id": "47253540017560"
- },
- {
- "type": "timelapses",
- "id": "47253540017240"
- },
- {
- "type": "timelapses",
- "id": "47253540017020"
- },
- {
- "type": "timelapses",
- "id": "47253540016780"
- },
- {
- "type": "timelapses",
- "id": "47253540016520"
- },
- {
- "type": "timelapses",
- "id": "47253540016220"
- },
- {
- "type": "timelapses",
- "id": "47253540015960"
- },
- {
- "type": "timelapses",
- "id": "47253540015740"
- },
- {
- "type": "timelapses",
- "id": "47253540015440"
- },
- {
- "type": "timelapses",
- "id": "47253540015200"
- },
- {
- "type": "timelapses",
- "id": "47253540015020"
- },
- {
- "type": "timelapses",
- "id": "47253540014820"
- },
- {
- "type": "timelapses",
- "id": "47253540014600"
- },
- {
- "type": "timelapses",
- "id": "47253540014420"
- },
- {
- "type": "timelapses",
- "id": "47253540014240"
- },
- {
- "type": "timelapses",
- "id": "47253540014080"
- },
- {
- "type": "timelapses",
- "id": "47253540013920"
- },
- {
- "type": "timelapses",
- "id": "47253540013760"
- },
- {
- "type": "timelapses",
- "id": "47253540013600"
- }
- ]
- }
- }
- }],
- "included": [{
- "id": "47253540017560",
- "type": "timelapses",
- "attributes": {
- "id": 47253540017560,
- "src": "/api/v3p/timelapse/5cb588e083825a669055cf98/2021-07-28%2012:30:50%20+0100/thumbnail"
- }
- },
- {
- "id": "47253540017240",
- "type": "timelapses",
- "attributes": {
- "id": 47253540017240,
- "src": "/api/v3p/timelapse/5cb588e083825a669055cf98/2021-07-28%2012:30:55%20+0100/thumbnail"
- }
- },
- {
- "id": "47253540017020",
- "type": "timelapses",
- "attributes": {
- "id": 47253540017020,
- "src": "/api/v3p/timelapse/5cb588e083825a669055cf98/2021-07-28%2012:31:00%20+0100/thumbnail"
- }
- },
- {
- "id": "47253540016780",
- "type": "timelapses",
- "attributes": {
- "id": 47253540016780,
- "src": "/api/v3p/timelapse/5cb588e083825a669055cf98/2021-07-28%2012:31:05%20+0100/thumbnail"
- }
- },
- {
- "id": "47253540016520",
- "type": "timelapses",
- "attributes": {
- "id": 47253540016520,
- "src": "/api/v3p/timelapse/5cb588e083825a669055cf98/2021-07-28%2012:31:10%20+0100/thumbnail"
- }
- },
- {
- "id": "47253540016220",
- "type": "timelapses",
- "attributes": {
- "id": 47253540016220,
- "src": "/api/v3p/timelapse/5cb588e083825a669055cf98/2021-07-28%2012:31:15%20+0100/thumbnail"
- }
- },
- {
- "id": "47253540015960",
- "type": "timelapses",
- "attributes": {
- "id": 47253540015960,
- "src": "/api/v3p/timelapse/5cb588e083825a669055cf98/2021-07-28%2012:31:20%20+0100/thumbnail"
- }
- },
- {
- "id": "47253540015740",
- "type": "timelapses",
- "attributes": {
- "id": 47253540015740,
- "src": "/api/v3p/timelapse/5cb588e083825a669055cf98/2021-07-28%2012:31:25%20+0100/thumbnail"
- }
- },
- {
- "id": "47253540015440",
- "type": "timelapses",
- "attributes": {
- "id": 47253540015440,
- "src": "/api/v3p/timelapse/5cb588e083825a669055cf98/2021-07-28%2012:31:30%20+0100/thumbnail"
- }
- },
- {
- "id": "47253540015200",
- "type": "timelapses",
- "attributes": {
- "id": 47253540015200,
- "src": "/api/v3p/timelapse/5cb588e083825a669055cf98/2021-07-28%2012:31:35%20+0100/thumbnail"
- }
- },
- {
- "id": "47253540015020",
- "type": "timelapses",
- "attributes": {
- "id": 47253540015020,
- "src": "/api/v3p/timelapse/5cb588e083825a669055cf98/2021-07-28%2012:31:40%20+0100/thumbnail"
- }
- },
- {
- "id": "47253540014820",
- "type": "timelapses",
- "attributes": {
- "id": 47253540014820,
- "src": "/api/v3p/timelapse/5cb588e083825a669055cf98/2021-07-28%2012:31:45%20+0100/thumbnail"
- }
- },
- {
- "id": "47253540014600",
- "type": "timelapses",
- "attributes": {
- "id": 47253540014600,
- "src": "/api/v3p/timelapse/5cb588e083825a669055cf98/2021-07-28%2012:31:50%20+0100/thumbnail"
- }
- },
- {
- "id": "47253540014420",
- "type": "timelapses",
- "attributes": {
- "id": 47253540014420,
- "src": "/api/v3p/timelapse/5cb588e083825a669055cf98/2021-07-28%2012:31:55%20+0100/thumbnail"
- }
- },
- {
- "id": "47253540014240",
- "type": "timelapses",
- "attributes": {
- "id": 47253540014240,
- "src": "/api/v3p/timelapse/5cb588e083825a669055cf98/2021-07-28%2012:32:00%20+0100/thumbnail"
- }
- },
- {
- "id": "47253540014080",
- "type": "timelapses",
- "attributes": {
- "id": 47253540014080,
- "src": "/api/v3p/timelapse/5cb588e083825a669055cf98/2021-07-28%2012:32:05%20+0100/thumbnail"
- }
- },
- {
- "id": "47253540013920",
- "type": "timelapses",
- "attributes": {
- "id": 47253540013920,
- "src": "/api/v3p/timelapse/5cb588e083825a669055cf98/2021-07-28%2012:32:10%20+0100/thumbnail"
- }
- },
- {
- "id": "47253540013760",
- "type": "timelapses",
- "attributes": {
- "id": 47253540013760,
- "src": "/api/v3p/timelapse/5cb588e083825a669055cf98/2021-07-28%2012:32:15%20+0100/thumbnail"
- }
- },
- {
- "id": "47253540013600",
- "type": "timelapses",
- "attributes": {
- "id": 47253540013600,
- "src": "/api/v3p/timelapse/5cb588e083825a669055cf98/2021-07-28%2012:32:20%20+0100/thumbnail"
- }
+ "prev_recording_id": "5d1f0c0a41092775efbddfee",
+ "next_recording_id": "5d1f0c0a41092775efbddfe6",
+ "timelapses": [
+ "0": {
+ "id": 2021760,
+ "src": "/api/v3p/timelapse/5d1f0bf541092775efbddd32/2019-03-02%2016:01:10%20+0000/thumbnail"
+ },
+ "1": {
+ "id": 2021780,
+ "src": "/api/v3p/timelapse/5d1f0bf541092775efbddd32/2019-03-02%2016:01:15%20+0000/thumbnail"
+ },
+ "2": {
+ "id": 2021800,
+ "src": "/api/v3p/timelapse/5d1f0bf541092775efbddd32/2019-03-02%2016:01:20%20+0000/thumbnail"
+ },
+ "3": {
+ "id": 2021820,
+ "src": "/api/v3p/timelapse/5d1f0bf541092775efbddd32/2019-03-02%2016:01:25%20+0000/thumbnail"
+ },
+ "4": {
+ "id": 2021840,
+ "src": "/api/v3p/timelapse/5d1f0bf541092775efbddd32/2019-03-02%2016:01:30%20+0000/thumbnail"
+ },
+ "5": {
+ "id": 2021860,
+ "src": "/api/v3p/timelapse/5d1f0bf541092775efbddd32/2019-03-02%2016:01:35%20+0000/thumbnail"
+ },
+ "6": {
+ "id": 2021880,
+ "src": "/api/v3p/timelapse/5d1f0bf541092775efbddd32/2019-03-02%2016:01:40%20+0000/thumbnail"
+ },
+ "7": {
+ "id": 2021900,
+ "src": "/api/v3p/timelapse/5d1f0bf541092775efbddd32/2019-03-02%2016:01:45%20+0000/thumbnail"
+ },
+ "8": {
+ "id": 2021920,
+ "src": "/api/v3p/timelapse/5d1f0bf541092775efbddd32/2019-03-02%2016:01:50%20+0000/thumbnail"
+ },
+ "9": {
+ "id": 2021940,
+ "src": "/api/v3p/timelapse/5d1f0bf541092775efbddd32/2019-03-02%2016:01:55%20+0000/thumbnail"
+ },
+ "10": {
+ "id": 2021960,
+ "src": "/api/v3p/timelapse/5d1f0bf541092775efbddd32/2019-03-02%2016:02:00%20+0000/thumbnail"
+ },
+ "11": {
+ "id": 2021980,
+ "src": "/api/v3p/timelapse/5d1f0bf541092775efbddd32/2019-03-02%2016:02:05%20+0000/thumbnail"
+ },
+ "12": {
+ "id": 2022000,
+ "src": "/api/v3p/timelapse/5d1f0bf541092775efbddd32/2019-03-02%2016:02:10%20+0000/thumbnail"
+ },
+ "13": {
+ "id": 2022020,
+ "src": "/api/v3p/timelapse/5d1f0bf541092775efbddd32/2019-03-02%2016:02:15%20+0000/thumbnail"
+ },
+ "14": {
+ "id": 2022040,
+ "src": "/api/v3p/timelapse/5d1f0bf541092775efbddd32/2019-03-02%2016:02:20%20+0000/thumbnail"
+ },
+ "15": {
+ "id": 2022060,
+ "src": "/api/v3p/timelapse/5d1f0bf541092775efbddd32/2019-03-02%2016:02:25%20+0000/thumbnail"
+ },
+ "16": {
+ "id": 2022080,
+ "src": "/api/v3p/timelapse/5d1f0bf541092775efbddd32/2019-03-02%2016:02:30%20+0000/thumbnail"
+ },
+ "17": {
+ "id": 2022100,
+ "src": "/api/v3p/timelapse/5d1f0bf541092775efbddd32/2019-03-02%2016:02:35%20+0000/thumbnail"
+ },
+ "18": {
+ "id": 2022120,
+ "src": "/api/v3p/timelapse/5d1f0bf541092775efbddd32/2019-03-02%2016:02:40%20+0000/thumbnail"
+ }
+ ]
}
- ]
+ }]
}
```
@@ -1787,94 +1699,137 @@ curl "https://my.timeline.is/api/v3p/recordings/5f06e5f241092794fc255ded" -H "Au
```json
{
"data": {
- "id": "5f06e5f241092794fc255ded",
+ "id": "5d1f0c0a41092775efbddfe7",
"type": "recordings",
"attributes": {
"agent_image": true,
"agent_video": true,
"checksum": null,
"cloud_path": null,
- "cloud_snapshot": false,
- "cloud_thumbnail": false,
- "cloud_timelapse": false,
+ "cloud_snapshot": true,
+ "cloud_thumbnail": true,
+ "cloud_timelapse": true,
"cloud_timelapse_error": null,
"cloud_timelapse_interval": null,
- "cloud_video": false,
+ "cloud_video": true,
"cloud_waveform": false,
- "created_at": "2020-07-09T10:40:02.469+01:00",
- "ends_at": "2020-07-04T15:37:02.467+01:00",
- "ends_at_seconds_since_midnight": 56222,
+ "created_at": "2019-07-05T09:36:26.584+01:00",
+ "ends_at": "2019-03-02T16:02:26.577+00:00",
+ "ends_at_seconds_since_midnight": 57746,
"filesize": 0,
"flagged": false,
"motion": 0,
"object_count": 0,
- "path": "/recordings/officiis1",
+ "path": "/recordings/et406",
"skip_notify": false,
- "starts_at": "2020-07-04T15:36:02.467+01:00",
- "starts_at_seconds_since_midnight": 56162,
- "updated_at": "2020-07-09T10:40:02.469+01:00",
+ "starts_at": "2019-03-02T16:01:26.577+00:00",
+ "starts_at_seconds_since_midnight": 57686,
+ "updated_at": "2019-07-05T09:36:26.584+01:00",
"seek_to_event": 0,
- "epoch_time": "04072020-0336PM-0337PM",
- "agent_id": "5f06e5f241092794fc255dee",
- "camera_id": "5f06e5f241092794fc255df2",
+ "epoch_time": "02032019-0401PM-0402PM",
+ "agent_id": "5d1f0be841092775efbddb7e",
+ "camera_id": "5d1f0bf541092775efbddd33",
"device_id": null,
- "event_id": "5f06e5f241092794fc255deb",
+ "event_id": "5d1f0c0a41092775efbddfe2",
"flagged_by_id": null,
- "location_id": "5f06e5f241092794fc255de9",
- "timeline_id": "5f06e5f141092794fc255ddb",
+ "location_id": "5d1f0be741092775efbddb71",
+ "timeline_id": "5d1f0be641092775efbddb62",
"unflagged_by_id": null,
- "zone_id": "5f06e5f241092794fc255de8",
+ "zone_id": "5d1f0bf541092775efbddd32",
"urls": {
- "proxy": "/recordings/5f06e5f241092794fc255ded/view?token=U-Gxk1fXchjRIp2D5GDCcw",
- "proxy_download": "/recordings/5f06e5f241092794fc255ded/download",
- "proxy_snapshot": "/recordings/5f06e5f241092794fc255ded/snapshot",
- "local": "lan-facilis1.timeline.is/api/v2/recordings/download.mp4?recording%5Bpath%5D=%2Frecordings%2Fofficiis1",
- "local_snapshot": "lan-facilis1.timeline.is/api/v2/recordings/snapshot?recording%5Bpath%5D=%2Frecordings%2Fofficiis1.jpg",
- "external": "external-facilis1.timeline.is/api/v2/recordings/download.mp4?recording%5Bpath%5D=%2Frecordings%2Fofficiis1",
- "external_snapshot": "external-facilis1.timeline.is/api/v2/recordings/snapshot?recording%5Bpath%5D=%2Frecordings%2Fofficiis1.jpg"
+ "proxy": "https://s3.eu-west-2.amazonaws.com/xancloud.com/customer-timeline/porro13/recordings/et406",
+ "proxy_download": "https://s3.eu-west-2.amazonaws.com/xancloud.com/customer-timeline/porro13/recordings/et406",
+ "proxy_snapshot": "https://s3.eu-west-2.amazonaws.com/xancloud.com/customer-timeline/porro13/recordings/et406.jpg",
+ "local": "127.0.0.1:2999/api/v3/recordings/download.mp4?recording%5Bpath%5D=%2Frecordings%2Fet406&token=tc49Xv1q84dWYPmuhpBLFw",
+ "local_snapshot": "127.0.0.1:2999/api/v3/recordings/snapshot?recording%5Bpath%5D=%2Frecordings%2Fet406.jpg&token=tc49Xv1q84dWYPmuhpBLFw",
+ "external": "external-porro13.xancloud.com/api/v3/recordings/download.mp4?recording%5Bpath%5D=%2Frecordings%2Fet406&token=tc49Xv1q84dWYPmuhpBLFw",
+ "external_snapshot": "external-porro13.xancloud.com/api/v3/recordings/snapshot?recording%5Bpath%5D=%2Frecordings%2Fet406.jpg&token=tc49Xv1q84dWYPmuhpBLFw"
},
- "prev_recording_id": null,
- "next_recording_id": null
- },
- "relationships": {
- "timelapses": {
- "data": [
- {
- "type": "timelapses",
- "id": "70240479762520"
- },
- {
- "type": "timelapses",
- "id": "70240479762360"
- }
- ]
- }
- }
- },
- "included": [
- {
- "id": "70240479762520",
- "type": "timelapses",
- "attributes": {
- "id": 70240479762520,
- "src": "/api/v3p/timelapse/5f06e5f241092794fc255de8/2020-07-04%2015:35:45%20+0100/thumbnail"
- }
- },
- {
- "id": "70240479762360",
- "type": "timelapses",
- "attributes": {
- "id": 70240479762360,
- "src": "/api/v3p/timelapse/5f06e5f241092794fc255de8/2020-07-04%2015:35:50%20+0100/thumbnail"
- }
+ "prev_recording_id": "5d1f0c0a41092775efbddfee",
+ "next_recording_id": "5d1f0c0a41092775efbddfe6",
+ "timelapses": [
+ "0": {
+ "id": 2021760,
+ "src": "/api/v3p/timelapse/5d1f0bf541092775efbddd32/2019-03-02%2016:01:10%20+0000/thumbnail"
+ },
+ "1": {
+ "id": 2021780,
+ "src": "/api/v3p/timelapse/5d1f0bf541092775efbddd32/2019-03-02%2016:01:15%20+0000/thumbnail"
+ },
+ "2": {
+ "id": 2021800,
+ "src": "/api/v3p/timelapse/5d1f0bf541092775efbddd32/2019-03-02%2016:01:20%20+0000/thumbnail"
+ },
+ "3": {
+ "id": 2021820,
+ "src": "/api/v3p/timelapse/5d1f0bf541092775efbddd32/2019-03-02%2016:01:25%20+0000/thumbnail"
+ },
+ "4": {
+ "id": 2021840,
+ "src": "/api/v3p/timelapse/5d1f0bf541092775efbddd32/2019-03-02%2016:01:30%20+0000/thumbnail"
+ },
+ "5": {
+ "id": 2021860,
+ "src": "/api/v3p/timelapse/5d1f0bf541092775efbddd32/2019-03-02%2016:01:35%20+0000/thumbnail"
+ },
+ "6": {
+ "id": 2021880,
+ "src": "/api/v3p/timelapse/5d1f0bf541092775efbddd32/2019-03-02%2016:01:40%20+0000/thumbnail"
+ },
+ "7": {
+ "id": 2021900,
+ "src": "/api/v3p/timelapse/5d1f0bf541092775efbddd32/2019-03-02%2016:01:45%20+0000/thumbnail"
+ },
+ "8": {
+ "id": 2021920,
+ "src": "/api/v3p/timelapse/5d1f0bf541092775efbddd32/2019-03-02%2016:01:50%20+0000/thumbnail"
+ },
+ "9": {
+ "id": 2021940,
+ "src": "/api/v3p/timelapse/5d1f0bf541092775efbddd32/2019-03-02%2016:01:55%20+0000/thumbnail"
+ },
+ "10": {
+ "id": 2021960,
+ "src": "/api/v3p/timelapse/5d1f0bf541092775efbddd32/2019-03-02%2016:02:00%20+0000/thumbnail"
+ },
+ "11": {
+ "id": 2021980,
+ "src": "/api/v3p/timelapse/5d1f0bf541092775efbddd32/2019-03-02%2016:02:05%20+0000/thumbnail"
+ },
+ "12": {
+ "id": 2022000,
+ "src": "/api/v3p/timelapse/5d1f0bf541092775efbddd32/2019-03-02%2016:02:10%20+0000/thumbnail"
+ },
+ "13": {
+ "id": 2022020,
+ "src": "/api/v3p/timelapse/5d1f0bf541092775efbddd32/2019-03-02%2016:02:15%20+0000/thumbnail"
+ },
+ "14": {
+ "id": 2022040,
+ "src": "/api/v3p/timelapse/5d1f0bf541092775efbddd32/2019-03-02%2016:02:20%20+0000/thumbnail"
+ },
+ "15": {
+ "id": 2022060,
+ "src": "/api/v3p/timelapse/5d1f0bf541092775efbddd32/2019-03-02%2016:02:25%20+0000/thumbnail"
+ },
+ "16": {
+ "id": 2022080,
+ "src": "/api/v3p/timelapse/5d1f0bf541092775efbddd32/2019-03-02%2016:02:30%20+0000/thumbnail"
+ },
+ "17": {
+ "id": 2022100,
+ "src": "/api/v3p/timelapse/5d1f0bf541092775efbddd32/2019-03-02%2016:02:35%20+0000/thumbnail"
+ },
+ "18": {
+ "id": 2022120,
+ "src": "/api/v3p/timelapse/5d1f0bf541092775efbddd32/2019-03-02%2016:02:40%20+0000/thumbnail"
+ }
+ ]
}
- ]
+ }
}
```
-
-
-
## Recording on Web site
You can generate correct url to our site to display recording at a certain point in time and pass `return_url`. We display banner at the top of site with link to your `redirect_url`.
@@ -1923,3 +1878,31 @@ curl "https://my.timelline.is/api/v3/alarms/sia_event" \
> The above command returns 200 status without body
+
+# Errors
+We are supporting next errors:
+
+## 401 Unauthorized
+
+Returns `401` status code. Happens when incorrect user token passed.
+
+`{ "data": { "errors": ["Not Authorised!"] } }`
+
+## 404 Not Found
+
+Returns `404` status code. Happens when record not found in DB.
+
+`{ "data": { "errors": ["Not Found"] } }`
+
+## 403 Forbidden
+
+Returns `403` status code. Happens when user does not have access to the record.
+
+`{ "data": { "errors": ["Not Found"] } }`
+
+## 500 Unexpected error
+
+Returns `500` status code. Happens when some unexpected error happened on the server.
+
+`{ "data": { "errors": ["Something went wrong"] } }`
+