From 5fb536bec0cc4e91fdf1a2a40cb8b3b0234b3407 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E4=BD=B3=E9=A9=B9=20=E4=B8=87?= Date: Wed, 31 Jan 2024 17:58:22 +0800 Subject: [PATCH] =?UTF-8?q?=E5=A2=9E=E5=8A=A0=E4=BA=91=E7=AB=AF=E5=BD=95?= =?UTF-8?q?=E5=83=8F=E6=8E=A5=E5=8F=A3=E6=96=87=E6=A1=A3?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- cdvr.md | 279 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 279 insertions(+) create mode 100644 cdvr.md diff --git a/cdvr.md b/cdvr.md new file mode 100644 index 0000000..91a49e2 --- /dev/null +++ b/cdvr.md @@ -0,0 +1,279 @@ + +# CDVR + +Base URLs: + +* address : http://server_ip:30889 + + +# Record + +## GET /Record/Start + +GET /Record/Start + +### Params + +|Name|Location|Type|Required|Description| +|---|---|---|---|---| +|Sim|query|string| no |none| +|Channel|query|string| no |none| +|Protocol|query|integer| no |none| + +> Response Examples + +> 200 Response + +```json +{ + "result": 0, + "resultNote": "string", + "detail": "string" +} +``` + +### Responses + +|HTTP Status Code |Meaning|Description|Data schema| +|---|---|---|---| +|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Success|[RecordRet](#schemarecordret)| + +## GET /Record/Stop + +GET /Record/Stop + +### Params + +|Name|Location|Type|Required|Description| +|---|---|---|---|---| +|Sim|query|string| no |none| +|Channel|query|string| no |none| +|Protocol|query|integer| no |none| + +> Response Examples + +> 200 Response + +```json +{ + "result": 0, + "resultNote": "string", + "detail": "string" +} +``` + +### Responses + +|HTTP Status Code |Meaning|Description|Data schema| +|---|---|---|---| +|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Success|[RecordRet](#schemarecordret)| + +## POST /Record/Open + +POST /Record/Open + +> Body Parameters + +```json +[ + { + "sim": "string", + "channel": [ + "string" + ], + "protocol": 0 + } +] +``` + +### Params + +|Name|Location|Type|Required|Description| +|---|---|---|---|---| +|body|body|[DeviceInfo](#schemadeviceinfo)| no |none| + +> Response Examples + +> 200 Response + +```json +{ + "result": 0, + "resultNote": "string", + "detail": "string" +} +``` + +### Responses + +|HTTP Status Code |Meaning|Description|Data schema| +|---|---|---|---| +|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Success|[RecordRet](#schemarecordret)| + +## POST /Record/BatchStart + +POST /Record/BatchStart + +> Body Parameters + +```json +[ + { + "sim": "string", + "channel": [ + "string" + ], + "protocol": 0 + } +] +``` + +### Params + +|Name|Location|Type|Required|Description| +|---|---|---|---|---| +|body|body|[DeviceInfo](#schemadeviceinfo)| no |none| + +> Response Examples + +> 200 Response + +```json +{ + "result": 0, + "resultNote": "string", + "detail": "string" +} +``` + +### Responses + +|HTTP Status Code |Meaning|Description|Data schema| +|---|---|---|---| +|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Success|[RecordRet](#schemarecordret)| + +## POST /Record/BatchStop + +POST /Record/BatchStop + +> Body Parameters + +```json +[ + { + "sim": "string", + "channel": [ + "string" + ], + "protocol": 0 + } +] +``` + +### Params + +|Name|Location|Type|Required|Description| +|---|---|---|---|---| +|body|body|[DeviceInfo](#schemadeviceinfo)| no |none| + +> Response Examples + +> 200 Response + +```json +{ + "result": 0, + "resultNote": "string", + "detail": "string" +} +``` + +### Responses + +|HTTP Status Code |Meaning|Description|Data schema| +|---|---|---|---| +|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Success|[RecordRet](#schemarecordret)| + +## POST /Record/Close + +POST /Record/Close + +> Body Parameters + +```json +[ + { + "sim": "string", + "channel": [ + "string" + ], + "protocol": 0 + } +] +``` + +### Params + +|Name|Location|Type|Required|Description| +|---|---|---|---|---| +|body|body|[DeviceInfo](#schemadeviceinfo)| no |none| + +> Response Examples + +> 200 Response + +```json +{ + "result": 0, + "resultNote": "string", + "detail": "string" +} +``` + +### Responses + +|HTTP Status Code |Meaning|Description|Data schema| +|---|---|---|---| +|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Success|[RecordRet](#schemarecordret)| + +## POST /Record/QueryVideoFiles + +POST /Record/QueryVideoFiles + +> Body Parameters + +```json +{ + "timeStart": "string", + "timeEnd": "string", + "devices": [ + { + "sim": "string", + "channel": [ + "string" + ], + "protocol": 0 + } + ] +} +``` + +### Params + +|Name|Location|Type|Required|Description| +|---|---|---|---|---| +|body|body|[QueryDevicesVideoFiles](#schemaquerydevicesvideofiles)| no |none| + +> Response Examples + +> 200 Response + +```json +"string" +``` + +### Responses + +|HTTP Status Code |Meaning|Description|Data schema| +|---|---|---|---| +|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Success|string|