Control Unit

Download schema

Show

GET

https://dev.api.radarbov.app

/api/v1/control-units/{id}

Bearer (JWT)

Show › path Parameters

id

string · required

Show › Responses

Control Unit · required

GET/api/v1/control-units/{id}

curl https://dev.api.radarbov.app/api/v1/control-units/:id \
  --header 'Authorization: Bearer <token>'

Example Responses

{
  "data": {
    "establishment": {
      "bl_move_with_tag_reading": true,
      "county": {
        "id": "00000000-0000-0000-0000-000000000000",
        "str_federative_unit": "str_federative_unit",
        "str_ibge_code": "str_ibge_code",
        "str_name": "str_name",
        "ts_created_at": "2024-08-25T15:00:00Z",
        "ts_updated_at": "2024-08-25T15:00:00Z"
      },
      "dec_area": {},
      "dec_exploration_area": {},
      "geo_location": {
        "coordinates": [
          0
        ],
        "type": "Point"
      },
      "id": "00000000-0000-0000-0000-000000000000",
      "responsible_user": {
        "county": {
          "id": "00000000-0000-0000-0000-000000000000",
          "str_federative_unit": "str_federative_unit",
          "str_ibge_code": "str_ibge_code",
          "str_name": "str_name",
          "ts_created_at": "2024-08-25T15:00:00Z",
          "ts_updated_at": "2024-08-25T15:00:00Z"
        },
        "id": "00000000-0000-0000-0000-000000000000",
        "organization_id": "00000000-0000-0000-0000-000000000000",
        "str_document": "str_document",
        "str_email": "str_email",
        "str_name": "str_name",
        "str_phone": "str_phone",
        "str_status": "str_status",
        "str_type": "str_type",
        "ts_created_at": "2024-08-25T15:00:00Z",
        "ts_updated_at": "2024-08-25T15:00:00Z"
      },
      "str_car": "str_car",
      "str_code": "str_code",
      "str_company_code": "str_company_code",
      "str_name": "str_name",
      "str_socioenvironmental_status": "str_socioenvironmental_status",
      "str_type": "str_type",
      "ts_created_at": "2024-08-25T15:00:00Z",
      "ts_updated_at": "2024-08-25T15:00:00Z"
    },
    "id": "00000000-0000-0000-0000-000000000000",
    "responsible_user": {
      "county": {
        "id": "00000000-0000-0000-0000-000000000000",
        "str_federative_unit": "str_federative_unit",
        "str_ibge_code": "str_ibge_code",
        "str_name": "str_name",
        "ts_created_at": "2024-08-25T15:00:00Z",
        "ts_updated_at": "2024-08-25T15:00:00Z"
      },
      "id": "00000000-0000-0000-0000-000000000000",
      "organization_id": "00000000-0000-0000-0000-000000000000",
      "str_document": "str_document",
      "str_email": "str_email",
      "str_name": "str_name",
      "str_phone": "str_phone",
      "str_status": "str_status",
      "str_type": "str_type",
      "ts_created_at": "2024-08-25T15:00:00Z",
      "ts_updated_at": "2024-08-25T15:00:00Z"
    },
    "str_code": "str_code",
    "str_name": "str_name",
    "str_predominant_phase": "str_predominant_phase",
    "str_predominant_system": "str_predominant_system",
    "str_type": "str_type",
    "ts_created_at": "2024-08-25T15:00:00Z",
    "ts_updated_at": "2024-08-25T15:00:00Z"
  }
}

json

application/json

Update

PUT

https://dev.api.radarbov.app

/api/v1/control-units/{id}

Bearer (JWT)

Update › path Parameters

id

string · required

Update › Request Body optional

Update › Responses

Control Unit · required

PUT/api/v1/control-units/{id}

curl https://dev.api.radarbov.app/api/v1/control-units/:id \
  --request PUT \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{}'

Example Request Body

{}

json

Example Responses

{
  "data": {
    "establishment": {
      "bl_move_with_tag_reading": true,
      "county": {
        "id": "00000000-0000-0000-0000-000000000000",
        "str_federative_unit": "str_federative_unit",
        "str_ibge_code": "str_ibge_code",
        "str_name": "str_name",
        "ts_created_at": "2024-08-25T15:00:00Z",
        "ts_updated_at": "2024-08-25T15:00:00Z"
      },
      "dec_area": {},
      "dec_exploration_area": {},
      "geo_location": {
        "coordinates": [
          0
        ],
        "type": "Point"
      },
      "id": "00000000-0000-0000-0000-000000000000",
      "responsible_user": {
        "county": {
          "id": "00000000-0000-0000-0000-000000000000",
          "str_federative_unit": "str_federative_unit",
          "str_ibge_code": "str_ibge_code",
          "str_name": "str_name",
          "ts_created_at": "2024-08-25T15:00:00Z",
          "ts_updated_at": "2024-08-25T15:00:00Z"
        },
        "id": "00000000-0000-0000-0000-000000000000",
        "organization_id": "00000000-0000-0000-0000-000000000000",
        "str_document": "str_document",
        "str_email": "str_email",
        "str_name": "str_name",
        "str_phone": "str_phone",
        "str_status": "str_status",
        "str_type": "str_type",
        "ts_created_at": "2024-08-25T15:00:00Z",
        "ts_updated_at": "2024-08-25T15:00:00Z"
      },
      "str_car": "str_car",
      "str_code": "str_code",
      "str_company_code": "str_company_code",
      "str_name": "str_name",
      "str_socioenvironmental_status": "str_socioenvironmental_status",
      "str_type": "str_type",
      "ts_created_at": "2024-08-25T15:00:00Z",
      "ts_updated_at": "2024-08-25T15:00:00Z"
    },
    "id": "00000000-0000-0000-0000-000000000000",
    "responsible_user": {
      "county": {
        "id": "00000000-0000-0000-0000-000000000000",
        "str_federative_unit": "str_federative_unit",
        "str_ibge_code": "str_ibge_code",
        "str_name": "str_name",
        "ts_created_at": "2024-08-25T15:00:00Z",
        "ts_updated_at": "2024-08-25T15:00:00Z"
      },
      "id": "00000000-0000-0000-0000-000000000000",
      "organization_id": "00000000-0000-0000-0000-000000000000",
      "str_document": "str_document",
      "str_email": "str_email",
      "str_name": "str_name",
      "str_phone": "str_phone",
      "str_status": "str_status",
      "str_type": "str_type",
      "ts_created_at": "2024-08-25T15:00:00Z",
      "ts_updated_at": "2024-08-25T15:00:00Z"
    },
    "str_code": "str_code",
    "str_name": "str_name",
    "str_predominant_phase": "str_predominant_phase",
    "str_predominant_system": "str_predominant_system",
    "str_type": "str_type",
    "ts_created_at": "2024-08-25T15:00:00Z",
    "ts_updated_at": "2024-08-25T15:00:00Z"
  }
}

json

application/json

Update

PATCH

https://dev.api.radarbov.app

/api/v1/control-units/{id}

Bearer (JWT)

Update › path Parameters

id

string · required

Update › Request Body optional

Update › Responses

Control Unit · required

PATCH/api/v1/control-units/{id}

curl https://dev.api.radarbov.app/api/v1/control-units/:id \
  --request PATCH \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{}'

Example Request Body

{}

json

Example Responses

{
  "data": {
    "establishment": {
      "bl_move_with_tag_reading": true,
      "county": {
        "id": "00000000-0000-0000-0000-000000000000",
        "str_federative_unit": "str_federative_unit",
        "str_ibge_code": "str_ibge_code",
        "str_name": "str_name",
        "ts_created_at": "2024-08-25T15:00:00Z",
        "ts_updated_at": "2024-08-25T15:00:00Z"
      },
      "dec_area": {},
      "dec_exploration_area": {},
      "geo_location": {
        "coordinates": [
          0
        ],
        "type": "Point"
      },
      "id": "00000000-0000-0000-0000-000000000000",
      "responsible_user": {
        "county": {
          "id": "00000000-0000-0000-0000-000000000000",
          "str_federative_unit": "str_federative_unit",
          "str_ibge_code": "str_ibge_code",
          "str_name": "str_name",
          "ts_created_at": "2024-08-25T15:00:00Z",
          "ts_updated_at": "2024-08-25T15:00:00Z"
        },
        "id": "00000000-0000-0000-0000-000000000000",
        "organization_id": "00000000-0000-0000-0000-000000000000",
        "str_document": "str_document",
        "str_email": "str_email",
        "str_name": "str_name",
        "str_phone": "str_phone",
        "str_status": "str_status",
        "str_type": "str_type",
        "ts_created_at": "2024-08-25T15:00:00Z",
        "ts_updated_at": "2024-08-25T15:00:00Z"
      },
      "str_car": "str_car",
      "str_code": "str_code",
      "str_company_code": "str_company_code",
      "str_name": "str_name",
      "str_socioenvironmental_status": "str_socioenvironmental_status",
      "str_type": "str_type",
      "ts_created_at": "2024-08-25T15:00:00Z",
      "ts_updated_at": "2024-08-25T15:00:00Z"
    },
    "id": "00000000-0000-0000-0000-000000000000",
    "responsible_user": {
      "county": {
        "id": "00000000-0000-0000-0000-000000000000",
        "str_federative_unit": "str_federative_unit",
        "str_ibge_code": "str_ibge_code",
        "str_name": "str_name",
        "ts_created_at": "2024-08-25T15:00:00Z",
        "ts_updated_at": "2024-08-25T15:00:00Z"
      },
      "id": "00000000-0000-0000-0000-000000000000",
      "organization_id": "00000000-0000-0000-0000-000000000000",
      "str_document": "str_document",
      "str_email": "str_email",
      "str_name": "str_name",
      "str_phone": "str_phone",
      "str_status": "str_status",
      "str_type": "str_type",
      "ts_created_at": "2024-08-25T15:00:00Z",
      "ts_updated_at": "2024-08-25T15:00:00Z"
    },
    "str_code": "str_code",
    "str_name": "str_name",
    "str_predominant_phase": "str_predominant_phase",
    "str_predominant_system": "str_predominant_system",
    "str_type": "str_type",
    "ts_created_at": "2024-08-25T15:00:00Z",
    "ts_updated_at": "2024-08-25T15:00:00Z"
  }
}

json

application/json

Unrestricted search

POST

https://dev.api.radarbov.app

/api/v1/control-units/unrestricted/search

Bearer (JWT)

Unrestricted search › Request Body optional

Unrestricted search › Responses

Control Unit Partial Data[] · required

PaginationMeta · required

POST/api/v1/control-units/unrestricted/search

curl https://dev.api.radarbov.app/api/v1/control-units/unrestricted/search \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{}'

Example Request Body

{}

json

Example Responses

{
  "data": [
    {
      "establishment_id": "00000000-0000-0000-0000-000000000000",
      "id": "00000000-0000-0000-0000-000000000000",
      "responsible_user": {
        "county": {
          "id": "00000000-0000-0000-0000-000000000000",
          "str_federative_unit": "str_federative_unit",
          "str_ibge_code": "str_ibge_code",
          "str_name": "str_name",
          "ts_created_at": "2024-08-25T15:00:00Z",
          "ts_updated_at": "2024-08-25T15:00:00Z"
        },
        "id": "00000000-0000-0000-0000-000000000000",
        "organization_id": "00000000-0000-0000-0000-000000000000",
        "str_document": "str_document",
        "str_email": "str_email",
        "str_name": "str_name",
        "str_phone": "str_phone",
        "str_status": "str_status",
        "str_type": "str_type",
        "ts_created_at": "2024-08-25T15:00:00Z",
        "ts_updated_at": "2024-08-25T15:00:00Z"
      },
      "responsible_user_id": "00000000-0000-0000-0000-000000000000",
      "str_code": "str_code",
      "str_name": "str_name",
      "str_predominant_phase": "str_predominant_phase",
      "str_predominant_system": "str_predominant_system",
      "str_type": "str_type",
      "ts_created_at": "2024-08-25T15:00:00Z",
      "ts_updated_at": "2024-08-25T15:00:00Z"
    }
  ],
  "meta": {
    "int_current_page": 0,
    "int_max_results": 0,
    "int_total_pages": 0,
    "int_total_results": 0
  }
}

json

application/json

Index

GET

https://dev.api.radarbov.app

/api/v1/control-units

Bearer (JWT)

Index › query Parameters

int_current_page

integer

Default: 1

int_max_results

integer

Default: 50

Index › Responses

Control Unit Partial Data[] · required

PaginationMeta · required

GET/api/v1/control-units

curl https://dev.api.radarbov.app/api/v1/control-units \
  --header 'Authorization: Bearer <token>'

Example Responses

{
  "data": [
    {
      "establishment_id": "00000000-0000-0000-0000-000000000000",
      "id": "00000000-0000-0000-0000-000000000000",
      "responsible_user": {
        "county": {
          "id": "00000000-0000-0000-0000-000000000000",
          "str_federative_unit": "str_federative_unit",
          "str_ibge_code": "str_ibge_code",
          "str_name": "str_name",
          "ts_created_at": "2024-08-25T15:00:00Z",
          "ts_updated_at": "2024-08-25T15:00:00Z"
        },
        "id": "00000000-0000-0000-0000-000000000000",
        "organization_id": "00000000-0000-0000-0000-000000000000",
        "str_document": "str_document",
        "str_email": "str_email",
        "str_name": "str_name",
        "str_phone": "str_phone",
        "str_status": "str_status",
        "str_type": "str_type",
        "ts_created_at": "2024-08-25T15:00:00Z",
        "ts_updated_at": "2024-08-25T15:00:00Z"
      },
      "responsible_user_id": "00000000-0000-0000-0000-000000000000",
      "str_code": "str_code",
      "str_name": "str_name",
      "str_predominant_phase": "str_predominant_phase",
      "str_predominant_system": "str_predominant_system",
      "str_type": "str_type",
      "ts_created_at": "2024-08-25T15:00:00Z",
      "ts_updated_at": "2024-08-25T15:00:00Z"
    }
  ],
  "meta": {
    "int_current_page": 0,
    "int_max_results": 0,
    "int_total_pages": 0,
    "int_total_results": 0
  }
}

json

application/json

Create

POST

https://dev.api.radarbov.app

/api/v1/control-units

Bearer (JWT)

Create › Request Body optional

Create › Responses

Control Unit · required

POST/api/v1/control-units

curl https://dev.api.radarbov.app/api/v1/control-units \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{}'

Example Request Body

{}

json

Example Responses

{
  "data": {
    "establishment": {
      "bl_move_with_tag_reading": true,
      "county": {
        "id": "00000000-0000-0000-0000-000000000000",
        "str_federative_unit": "str_federative_unit",
        "str_ibge_code": "str_ibge_code",
        "str_name": "str_name",
        "ts_created_at": "2024-08-25T15:00:00Z",
        "ts_updated_at": "2024-08-25T15:00:00Z"
      },
      "dec_area": {},
      "dec_exploration_area": {},
      "geo_location": {
        "coordinates": [
          0
        ],
        "type": "Point"
      },
      "id": "00000000-0000-0000-0000-000000000000",
      "responsible_user": {
        "county": {
          "id": "00000000-0000-0000-0000-000000000000",
          "str_federative_unit": "str_federative_unit",
          "str_ibge_code": "str_ibge_code",
          "str_name": "str_name",
          "ts_created_at": "2024-08-25T15:00:00Z",
          "ts_updated_at": "2024-08-25T15:00:00Z"
        },
        "id": "00000000-0000-0000-0000-000000000000",
        "organization_id": "00000000-0000-0000-0000-000000000000",
        "str_document": "str_document",
        "str_email": "str_email",
        "str_name": "str_name",
        "str_phone": "str_phone",
        "str_status": "str_status",
        "str_type": "str_type",
        "ts_created_at": "2024-08-25T15:00:00Z",
        "ts_updated_at": "2024-08-25T15:00:00Z"
      },
      "str_car": "str_car",
      "str_code": "str_code",
      "str_company_code": "str_company_code",
      "str_name": "str_name",
      "str_socioenvironmental_status": "str_socioenvironmental_status",
      "str_type": "str_type",
      "ts_created_at": "2024-08-25T15:00:00Z",
      "ts_updated_at": "2024-08-25T15:00:00Z"
    },
    "id": "00000000-0000-0000-0000-000000000000",
    "responsible_user": {
      "county": {
        "id": "00000000-0000-0000-0000-000000000000",
        "str_federative_unit": "str_federative_unit",
        "str_ibge_code": "str_ibge_code",
        "str_name": "str_name",
        "ts_created_at": "2024-08-25T15:00:00Z",
        "ts_updated_at": "2024-08-25T15:00:00Z"
      },
      "id": "00000000-0000-0000-0000-000000000000",
      "organization_id": "00000000-0000-0000-0000-000000000000",
      "str_document": "str_document",
      "str_email": "str_email",
      "str_name": "str_name",
      "str_phone": "str_phone",
      "str_status": "str_status",
      "str_type": "str_type",
      "ts_created_at": "2024-08-25T15:00:00Z",
      "ts_updated_at": "2024-08-25T15:00:00Z"
    },
    "str_code": "str_code",
    "str_name": "str_name",
    "str_predominant_phase": "str_predominant_phase",
    "str_predominant_system": "str_predominant_system",
    "str_type": "str_type",
    "ts_created_at": "2024-08-25T15:00:00Z",
    "ts_updated_at": "2024-08-25T15:00:00Z"
  }
}

json

application/json

Search

POST

https://dev.api.radarbov.app

/api/v1/control-units/search

Bearer (JWT)

Search › query Parameters

int_current_page

integer

Default: 1

int_max_results

integer

Default: 50

Search › Request Body optional

Search › Responses

Control Unit Partial Data[] · required

PaginationMeta · required

POST/api/v1/control-units/search

curl https://dev.api.radarbov.app/api/v1/control-units/search \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{}'

Example Request Body

{}

json

Example Responses

{
  "data": [
    {
      "establishment_id": "00000000-0000-0000-0000-000000000000",
      "id": "00000000-0000-0000-0000-000000000000",
      "responsible_user": {
        "county": {
          "id": "00000000-0000-0000-0000-000000000000",
          "str_federative_unit": "str_federative_unit",
          "str_ibge_code": "str_ibge_code",
          "str_name": "str_name",
          "ts_created_at": "2024-08-25T15:00:00Z",
          "ts_updated_at": "2024-08-25T15:00:00Z"
        },
        "id": "00000000-0000-0000-0000-000000000000",
        "organization_id": "00000000-0000-0000-0000-000000000000",
        "str_document": "str_document",
        "str_email": "str_email",
        "str_name": "str_name",
        "str_phone": "str_phone",
        "str_status": "str_status",
        "str_type": "str_type",
        "ts_created_at": "2024-08-25T15:00:00Z",
        "ts_updated_at": "2024-08-25T15:00:00Z"
      },
      "responsible_user_id": "00000000-0000-0000-0000-000000000000",
      "str_code": "str_code",
      "str_name": "str_name",
      "str_predominant_phase": "str_predominant_phase",
      "str_predominant_system": "str_predominant_system",
      "str_type": "str_type",
      "ts_created_at": "2024-08-25T15:00:00Z",
      "ts_updated_at": "2024-08-25T15:00:00Z"
    }
  ],
  "meta": {
    "int_current_page": 0,
    "int_max_results": 0,
    "int_total_pages": 0,
    "int_total_results": 0
  }
}

json

application/json

Auth County

POST

https://dev.api.radarbov.app

/api/v1/control-units/search

Bearer (JWT)

Search › query Parameters

int_current_page

integer

Default: 1

int_max_results

integer

Default: 50

Search › Request Body optional

Search › Responses

Control Unit Partial Data[] · required

PaginationMeta · required