Распознавание автомобильных номеров API 1.7.0

Методы API для работы с разделом «Распознавание автомобильных номеров».

Базовый путь: https://{IP_контроллера}/api/v1. Версия описания API: 1.7.0.

Примеры используют placeholder-значения для паролей, token, UUID, адресов и секретов. Перед выполнением запроса замените их на значения вашего контроллера.

Методы раздела

Метод	Путь
`GET`	`/license_plate_recognition`
`POST`	`/license_plate_recognition`
`GET`	`/license_plate_recognition/status/{uuid}`
`GET`	`/license_plate_recognition/{id}`
`PUT`	`/license_plate_recognition/{id}`
`DELETE`	`/license_plate_recognition/{id}`

`GET /license_plate_recognition`

Раздел: Распознавание автомобильных номеров.

Возвращает настройки распознавания автомобильных номеров.

Параметры и ответы по OpenAPI

{
  "description": "got license plate recognition of application",
  "responses": {
    "200": {
      "description": "Successfully got license plate recognition",
      "content": {
        "application/json": {
          "schema": {
            "type": "array",
            "items": {
              "type": "object",
              "required": [
                "uuid",
                "onvif_url",
                "type"
              ],
              "properties": {
                "uuid": {
                  "type": "string",
                  "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[089abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
                },
                "name": {
                  "type": "string"
                },
                "onvif_url": {
                  "type": "string"
                },
                "type": {
                  "type": "string",
                  "enum": [
                    "RVI",
                    "ONVIF"
                  ]
                },
                "link_to_access_point_uuid": {
                  "type": "string",
                  "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[089abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
                },
                "login": {
                  "type": "string"
                },
                "password": {
                  "type": "string"
                }
              }
            }
          }
        }
      }
    },
    "500": {
      "description": "Something went wrong. It seems there is a bug on server",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "required": [
              "success"
            ],
            "properties": {
              "success": {
                "type": "boolean",
                "example": false
              },
              "message": {
                "type": "string"
              },
              "data": {
                "type": "object"
              }
            }
          }
        }
      }
    }
  }
}

Примеры по OpenAPI

Сформированы по схеме контроллера; значения полей необходимо заменить.

Пример запроса

curl -k -X GET "https://{IP_контроллера}/api/v1/license_plate_recognition" \
  -H "Authorization: Bearer <token>"

Пример ответа

[
  {
    "uuid": "string",
    "name": "string",
    "onvif_url": "string",
    "type": "RVI",
    "link_to_access_point_uuid": "string",
    "login": "string",
    "password": "string"
  }
]

`POST /license_plate_recognition`

Раздел: Распознавание автомобильных номеров.

Создает интеграцию распознавания автомобильных номеров.

Параметры и ответы по OpenAPI

{
  "description": "post license plate recognition",
  "requestBody": {
    "required": true,
    "content": {
      "application/json": {
        "schema": {
          "type": "object",
          "required": [
            "uuid",
            "onvif_url",
            "type"
          ],
          "properties": {
            "uuid": {
              "type": "string",
              "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[089abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
            },
            "name": {
              "type": "string"
            },
            "onvif_url": {
              "type": "string"
            },
            "type": {
              "type": "string",
              "enum": [
                "RVI",
                "ONVIF"
              ]
            },
            "link_to_access_point_uuid": {
              "type": "string",
              "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[089abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
            },
            "login": {
              "type": "string"
            },
            "password": {
              "type": "string"
            }
          }
        }
      }
    }
  },
  "responses": {
    "200": {
      "description": "Successfully post license plate recognition",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "required": [
              "success"
            ],
            "properties": {
              "success": {
                "type": "boolean",
                "example": false
              },
              "message": {
                "type": "string"
              },
              "data": {
                "type": "object"
              }
            }
          }
        }
      }
    },
    "500": {
      "description": "Something went wrong. It seems there is a bug on server",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "required": [
              "success"
            ],
            "properties": {
              "success": {
                "type": "boolean",
                "example": false
              },
              "message": {
                "type": "string"
              },
              "data": {
                "type": "object"
              }
            }
          }
        }
      }
    }
  }
}

Примеры по OpenAPI

Сформированы по схеме контроллера; значения полей необходимо заменить.

Пример запроса

curl -k -X POST "https://{IP_контроллера}/api/v1/license_plate_recognition" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  --data-raw '{
  "uuid": "string",
  "name": "string",
  "onvif_url": "string",
  "type": "RVI",
  "link_to_access_point_uuid": "string",
  "login": "string",
  "password": "string"
}'

Пример тела запроса

{
  "uuid": "string",
  "name": "string",
  "onvif_url": "string",
  "type": "RVI",
  "link_to_access_point_uuid": "string",
  "login": "string",
  "password": "string"
}

Пример ответа

{
  "success": false,
  "message": "string",
  "data": {}
}

`GET /license_plate_recognition/status/{uuid}`

Раздел: Распознавание автомобильных номеров.

Возвращает состояние камеры распознавания номеров.

Параметры и ответы по OpenAPI

{
  "summary": "Get camera status",
  "description": "Get camera status",
  "parameters": [
    {
      "in": "path",
      "name": "uuid",
      "required": true,
      "schema": {
        "type": "string"
      },
      "description": "Camera UUID"
    }
  ],
  "responses": {
    "200": {
      "description": "Successfully got license plate recognition status"
    },
    "404": {
      "description": "Specified license plate recognition does not exist",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "required": [
              "success"
            ],
            "properties": {
              "success": {
                "type": "boolean",
                "example": false
              },
              "message": {
                "type": "string"
              },
              "data": {
                "type": "object"
              }
            }
          }
        }
      }
    },
    "500": {
      "description": "Something went wrong. It seems there is a bug on server",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "required": [
              "success"
            ],
            "properties": {
              "success": {
                "type": "boolean",
                "example": false
              },
              "message": {
                "type": "string"
              },
              "data": {
                "type": "object"
              }
            }
          }
        }
      }
    }
  }
}

Примеры по OpenAPI

Сформированы по схеме контроллера; значения полей необходимо заменить.

Пример запроса

curl -k -X GET "https://{IP_контроллера}/api/v1/license_plate_recognition/status/{uuid}" \
  -H "Authorization: Bearer <token>"

`GET /license_plate_recognition/{id}`

Раздел: Распознавание автомобильных номеров.

Возвращает интеграцию распознавания автомобильных номеров по идентификатору.

Параметры и ответы по OpenAPI

{
  "description": "Get license plate recognition by id",
  "parameters": [
    {
      "in": "path",
      "name": "id",
      "required": true,
      "schema": {
        "type": "string"
      }
    }
  ],
  "responses": {
    "200": {
      "description": "Successfully got license plate recognition by name",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "required": [
              "uuid",
              "onvif_url",
              "type"
            ],
            "properties": {
              "uuid": {
                "type": "string",
                "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[089abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
              },
              "name": {
                "type": "string"
              },
              "onvif_url": {
                "type": "string"
              },
              "type": {
                "type": "string",
                "enum": [
                  "RVI",
                  "ONVIF"
                ]
              },
              "link_to_access_point_uuid": {
                "type": "string",
                "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[089abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
              },
              "login": {
                "type": "string"
              },
              "password": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "400": {
      "description": "Bad request",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "required": [
              "success"
            ],
            "properties": {
              "success": {
                "type": "boolean",
                "example": false
              },
              "message": {
                "type": "string"
              },
              "data": {
                "type": "object"
              }
            }
          }
        }
      }
    },
    "404": {
      "description": "Specified license plate recognition does not exist",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "required": [
              "success"
            ],
            "properties": {
              "success": {
                "type": "boolean",
                "example": false
              },
              "message": {
                "type": "string"
              },
              "data": {
                "type": "object"
              }
            }
          }
        }
      }
    },
    "500": {
      "description": "Something went wrong. It seems there is a bug on server",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "required": [
              "success"
            ],
            "properties": {
              "success": {
                "type": "boolean",
                "example": false
              },
              "message": {
                "type": "string"
              },
              "data": {
                "type": "object"
              }
            }
          }
        }
      }
    }
  }
}

Примеры по OpenAPI

Сформированы по схеме контроллера; значения полей необходимо заменить.

Пример запроса

curl -k -X GET "https://{IP_контроллера}/api/v1/license_plate_recognition/{id}" \
  -H "Authorization: Bearer <token>"

Пример ответа

{
  "uuid": "string",
  "name": "string",
  "onvif_url": "string",
  "type": "RVI",
  "link_to_access_point_uuid": "string",
  "login": "string",
  "password": "string"
}

`PUT /license_plate_recognition/{id}`

Раздел: Распознавание автомобильных номеров.

Обновляет интеграцию распознавания автомобильных номеров.

Параметры и ответы по OpenAPI

{
  "description": "Update license plate recognition",
  "parameters": [
    {
      "in": "path",
      "name": "id",
      "required": true,
      "schema": {
        "type": "string"
      }
    }
  ],
  "requestBody": {
    "required": true,
    "content": {
      "application/json": {
        "schema": {
          "type": "object",
          "required": [
            "uuid",
            "onvif_url",
            "type"
          ],
          "properties": {
            "uuid": {
              "type": "string",
              "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[089abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
            },
            "name": {
              "type": "string"
            },
            "onvif_url": {
              "type": "string"
            },
            "type": {
              "type": "string",
              "enum": [
                "RVI",
                "ONVIF"
              ]
            },
            "link_to_access_point_uuid": {
              "type": "string",
              "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[089abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
            },
            "login": {
              "type": "string"
            },
            "password": {
              "type": "string"
            }
          }
        }
      }
    }
  },
  "responses": {
    "200": {
      "description": "Successfully updated license plate recognition with specified name",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "required": [
              "success"
            ],
            "properties": {
              "success": {
                "type": "boolean",
                "example": false
              },
              "message": {
                "type": "string"
              },
              "data": {
                "type": "object"
              }
            }
          }
        }
      }
    },
    "400": {
      "description": "Bad request",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "required": [
              "success"
            ],
            "properties": {
              "success": {
                "type": "boolean",
                "example": false
              },
              "message": {
                "type": "string"
              },
              "data": {
                "type": "object"
              }
            }
          }
        }
      }
    },
    "404": {
      "description": "Specified license plate recognition does not exist",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "required": [
              "success"
            ],
            "properties": {
              "success": {
                "type": "boolean",
                "example": false
              },
              "message": {
                "type": "string"
              },
              "data": {
                "type": "object"
              }
            }
          }
        }
      }
    },
    "500": {
      "description": "Something went wrong. It seems there is a bug on server",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "required": [
              "success"
            ],
            "properties": {
              "success": {
                "type": "boolean",
                "example": false
              },
              "message": {
                "type": "string"
              },
              "data": {
                "type": "object"
              }
            }
          }
        }
      }
    }
  }
}

Примеры по OpenAPI

Сформированы по схеме контроллера; значения полей необходимо заменить.

Пример запроса

curl -k -X PUT "https://{IP_контроллера}/api/v1/license_plate_recognition/{id}" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  --data-raw '{
  "uuid": "string",
  "name": "string",
  "onvif_url": "string",
  "type": "RVI",
  "link_to_access_point_uuid": "string",
  "login": "string",
  "password": "string"
}'

Пример тела запроса

{
  "uuid": "string",
  "name": "string",
  "onvif_url": "string",
  "type": "RVI",
  "link_to_access_point_uuid": "string",
  "login": "string",
  "password": "string"
}

Пример ответа

{
  "success": false,
  "message": "string",
  "data": {}
}

`DELETE /license_plate_recognition/{id}`

Раздел: Распознавание автомобильных номеров.

Удаляет интеграцию распознавания автомобильных номеров.

Параметры и ответы по OpenAPI

{
  "description": "Delete license plate recognition",
  "parameters": [
    {
      "in": "path",
      "name": "id",
      "required": true,
      "schema": {
        "type": "string"
      }
    }
  ],
  "responses": {
    "200": {
      "description": "Successfully deleted license plate recognition",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "required": [
              "success"
            ],
            "properties": {
              "success": {
                "type": "boolean",
                "example": false
              },
              "message": {
                "type": "string"
              },
              "data": {
                "type": "object"
              }
            }
          }
        }
      }
    },
    "400": {
      "description": "Bad request",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "required": [
              "success"
            ],
            "properties": {
              "success": {
                "type": "boolean",
                "example": false
              },
              "message": {
                "type": "string"
              },
              "data": {
                "type": "object"
              }
            }
          }
        }
      }
    },
    "404": {
      "description": "License plate recognition does not exist",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "required": [
              "success"
            ],
            "properties": {
              "success": {
                "type": "boolean",
                "example": false
              },
              "message": {
                "type": "string"
              },
              "data": {
                "type": "object"
              }
            }
          }
        }
      }
    },
    "500": {
      "description": "Something went wrong. It seems there is a bug on server",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "required": [
              "success"
            ],
            "properties": {
              "success": {
                "type": "boolean",
                "example": false
              },
              "message": {
                "type": "string"
              },
              "data": {
                "type": "object"
              }
            }
          }
        }
      }
    }
  }
}

Примеры по OpenAPI

Сформированы по схеме контроллера; значения полей необходимо заменить.

Пример запроса

curl -k -X DELETE "https://{IP_контроллера}/api/v1/license_plate_recognition/{id}" \
  -H "Authorization: Bearer <token>"

Пример ответа

{
  "success": false,
  "message": "string",
  "data": {}
}

Методы раздела​

GET /license_plate_recognition​

Примеры по OpenAPI​

Пример запроса​

Пример ответа​

POST /license_plate_recognition​

Примеры по OpenAPI​

Пример запроса​

Пример тела запроса​

Пример ответа​

GET /license_plate_recognition/status/{uuid}​

Примеры по OpenAPI​

Пример запроса​

GET /license_plate_recognition/{id}​

Примеры по OpenAPI​

Пример запроса​

Пример ответа​

PUT /license_plate_recognition/{id}​

Примеры по OpenAPI​

Пример запроса​

Пример тела запроса​

Пример ответа​

DELETE /license_plate_recognition/{id}​

Примеры по OpenAPI​

Пример запроса​

Пример ответа​

Методы раздела

`GET /license_plate_recognition`

Примеры по OpenAPI

Пример запроса

Пример ответа

`POST /license_plate_recognition`

Примеры по OpenAPI

Пример запроса

Пример тела запроса

Пример ответа

`GET /license_plate_recognition/status/{uuid}`

Примеры по OpenAPI

Пример запроса

`GET /license_plate_recognition/{id}`

Примеры по OpenAPI

Пример запроса

Пример ответа

`PUT /license_plate_recognition/{id}`

Примеры по OpenAPI

Пример запроса

Пример тела запроса

Пример ответа

`DELETE /license_plate_recognition/{id}`

Примеры по OpenAPI

Пример запроса

Пример ответа