Establishment

Download schema

Report download

POST

https://dev.api.radarbov.app

/api/establishments/{id}/report/download

Bearer (JWT)

Report download › path Parameters

id

string · required

Report download › Responses

string

Search

POST

https://dev.api.radarbov.app

/api/establishments/search

Bearer (JWT)

Search › query Parameters

int_current_page

integer

Default: 1

int_max_results

integer

Default: 50

Search › Request Body optional

Search › Responses

Establishment Partial Data[] · required

PaginationMeta · required

POST/api/establishments/search

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

Example Request Body

{}

json

Example Responses

{
  "data": [
    {
      "bl_move_with_tag_reading": true,
      "control_units": [
        {
          "id": "00000000-0000-0000-0000-000000000000",
          "responsible_user": {
            "bl_active": true,
            "bl_admin": true,
            "bl_cancelled": true,
            "bl_org_admin": 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"
            },
            "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"
        }
      ],
      "county_id": "00000000-0000-0000-0000-000000000000",
      "dec_area": {},
      "dec_exploration_area": {},
      "geo_location": {
        "coordinates": [
          0
        ],
        "type": "Point"
      },
      "id": "00000000-0000-0000-0000-000000000000",
      "lst_invite_movimentation_types": {},
      "responsible_user_id": "00000000-0000-0000-0000-000000000000",
      "str_address": "str_address",
      "str_car": "str_car",
      "str_code": "str_code",
      "str_company_code": "str_company_code",
      "str_county_federative_unit": "str_county_federative_unit",
      "str_county_ibge_uf_code": "str_county_ibge_uf_code",
      "str_county_name": "str_county_name",
      "str_document": "str_document",
      "str_name": "str_name",
      "str_neighborhood": "str_neighborhood",
      "str_responsible_document": "str_responsible_document",
      "str_responsible_user_name": "str_responsible_user_name",
      "str_socioenvironmental_status": "str_socioenvironmental_status",
      "str_status": "str_status",
      "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

Report

POST

https://dev.api.radarbov.app

/api/establishments/{id}/report

Bearer (JWT)

Report › path Parameters

id

string · required

Report › Request Body optional

Report › Responses

Inventory

GET

https://dev.api.radarbov.app

/api/establishments/{id}/inventory

Bearer (JWT)

Inventory › path Parameters

id

string · required

Inventory › Responses

Show

GET

https://dev.api.radarbov.app

/api/establishments/{id}

Bearer (JWT)

Show › path Parameters

id

string · required

Show › Responses

Establishment · required

GET/api/establishments/{id}

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

Example Responses

{
  "data": {
    "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": {
      "bl_active": true,
      "bl_admin": true,
      "bl_cancelled": true,
      "bl_org_admin": 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"
      },
      "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"
  }
}

json

application/json

Update

PUT

https://dev.api.radarbov.app

/api/establishments/{id}

Bearer (JWT)

Update › path Parameters

id

string · required

Update › Request Body

Establishment Update

bl_move_with_tag_reading

boolean

county_id

string · uuid

dec_area

number

dec_exploration_area

number

responsible_user_id

string · uuid

str_address

string

str_car

string

str_code

string

str_company_code

string

str_document

string

str_email

string

str_name

string

str_neighborhood

string

str_socioenvironmental_status

string

str_type

string

str_zip_code

string

Update › Responses

Establishment · required

PUT/api/establishments/{id}

curl https://dev.api.radarbov.app/api/establishments/:id \
  --request PUT \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "bl_move_with_tag_reading": true,
  "county_id": "00000000-0000-0000-0000-000000000000",
  "dec_area": 0,
  "dec_exploration_area": 0,
  "responsible_user_id": "00000000-0000-0000-0000-000000000000",
  "str_address": "str_address",
  "str_car": "str_car",
  "str_code": "str_code",
  "str_company_code": "str_company_code",
  "str_document": "str_document",
  "str_email": "str_email",
  "str_name": "str_name",
  "str_neighborhood": "str_neighborhood",
  "str_socioenvironmental_status": "str_socioenvironmental_status",
  "str_type": "str_type",
  "str_zip_code": "str_zip_code"
}'

Example Request Body

{
  "bl_move_with_tag_reading": true,
  "county_id": "00000000-0000-0000-0000-000000000000",
  "dec_area": 0,
  "dec_exploration_area": 0,
  "responsible_user_id": "00000000-0000-0000-0000-000000000000",
  "str_address": "str_address",
  "str_car": "str_car",
  "str_code": "str_code",
  "str_company_code": "str_company_code",
  "str_document": "str_document",
  "str_email": "str_email",
  "str_name": "str_name",
  "str_neighborhood": "str_neighborhood",
  "str_socioenvironmental_status": "str_socioenvironmental_status",
  "str_type": "str_type",
  "str_zip_code": "str_zip_code"
}

json

Example Responses

{
  "data": {
    "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": {
      "bl_active": true,
      "bl_admin": true,
      "bl_cancelled": true,
      "bl_org_admin": 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"
      },
      "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"
  }
}

json

application/json

Update

PATCH

https://dev.api.radarbov.app

/api/establishments/{id}

Bearer (JWT)

Update › path Parameters

id

string · required

Update › Request Body

Establishment Update

bl_move_with_tag_reading

boolean

county_id

string · uuid

dec_area

number

dec_exploration_area

number

responsible_user_id

string · uuid

str_address

string

str_car

string

str_code

string

str_company_code

string

str_document

string

str_email

string

str_name

string

str_neighborhood

string

str_socioenvironmental_status

string

str_type

string

str_zip_code

string

Update › Responses

Establishment · required

PATCH/api/establishments/{id}

curl https://dev.api.radarbov.app/api/establishments/:id \
  --request PATCH \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "bl_move_with_tag_reading": true,
  "county_id": "00000000-0000-0000-0000-000000000000",
  "dec_area": 0,
  "dec_exploration_area": 0,
  "responsible_user_id": "00000000-0000-0000-0000-000000000000",
  "str_address": "str_address",
  "str_car": "str_car",
  "str_code": "str_code",
  "str_company_code": "str_company_code",
  "str_document": "str_document",
  "str_email": "str_email",
  "str_name": "str_name",
  "str_neighborhood": "str_neighborhood",
  "str_socioenvironmental_status": "str_socioenvironmental_status",
  "str_type": "str_type",
  "str_zip_code": "str_zip_code"
}'

Example Request Body

{
  "bl_move_with_tag_reading": true,
  "county_id": "00000000-0000-0000-0000-000000000000",
  "dec_area": 0,
  "dec_exploration_area": 0,
  "responsible_user_id": "00000000-0000-0000-0000-000000000000",
  "str_address": "str_address",
  "str_car": "str_car",
  "str_code": "str_code",
  "str_company_code": "str_company_code",
  "str_document": "str_document",
  "str_email": "str_email",
  "str_name": "str_name",
  "str_neighborhood": "str_neighborhood",
  "str_socioenvironmental_status": "str_socioenvironmental_status",
  "str_type": "str_type",
  "str_zip_code": "str_zip_code"
}

json

Example Responses

{
  "data": {
    "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": {
      "bl_active": true,
      "bl_admin": true,
      "bl_cancelled": true,
      "bl_org_admin": 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"
      },
      "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"
  }
}

json

application/json

Index

GET

https://dev.api.radarbov.app

/api/establishments

Bearer (JWT)

Index › query Parameters

int_current_page

integer

Default: 1

int_max_results

integer

Default: 50

Index › Responses

Establishment Partial Data[] · required

PaginationMeta · required

GET/api/establishments

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

Example Responses

{
  "data": [
    {
      "bl_move_with_tag_reading": true,
      "control_units": [
        {
          "id": "00000000-0000-0000-0000-000000000000",
          "responsible_user": {
            "bl_active": true,
            "bl_admin": true,
            "bl_cancelled": true,
            "bl_org_admin": 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"
            },
            "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"
        }
      ],
      "county_id": "00000000-0000-0000-0000-000000000000",
      "dec_area": {},
      "dec_exploration_area": {},
      "geo_location": {
        "coordinates": [
          0
        ],
        "type": "Point"
      },
      "id": "00000000-0000-0000-0000-000000000000",
      "lst_invite_movimentation_types": {},
      "responsible_user_id": "00000000-0000-0000-0000-000000000000",
      "str_address": "str_address",
      "str_car": "str_car",
      "str_code": "str_code",
      "str_company_code": "str_company_code",
      "str_county_federative_unit": "str_county_federative_unit",
      "str_county_ibge_uf_code": "str_county_ibge_uf_code",
      "str_county_name": "str_county_name",
      "str_document": "str_document",
      "str_name": "str_name",
      "str_neighborhood": "str_neighborhood",
      "str_responsible_document": "str_responsible_document",
      "str_responsible_user_name": "str_responsible_user_name",
      "str_socioenvironmental_status": "str_socioenvironmental_status",
      "str_status": "str_status",
      "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/establishments

Bearer (JWT)

Create › Request Body

Establishment Create

bl_move_with_tag_reading

boolean

county_id

string · uuid

dec_area

number

dec_exploration_area

number

Establishment Responsible User

responsible_user_id

string · uuid

str_address

string

str_car

string

str_code

string

str_company_code

string

str_document

string

str_email

string

str_ibge_code

string

str_name

string

str_neighborhood

string

str_socioenvironmental_status

string

str_type

string

str_zip_code

string

Create › Responses

Establishment · required

POST/api/establishments

curl https://dev.api.radarbov.app/api/establishments \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "bl_move_with_tag_reading": true,
  "county_id": "00000000-0000-0000-0000-000000000000",
  "dec_area": 0,
  "dec_exploration_area": 0,
  "responsible_user": {
    "str_document": "str_document",
    "str_email": "str_email",
    "str_name": "str_name",
    "str_type": "str_type"
  },
  "responsible_user_id": "00000000-0000-0000-0000-000000000000",
  "str_address": "str_address",
  "str_car": "str_car",
  "str_code": "str_code",
  "str_company_code": "str_company_code",
  "str_document": "str_document",
  "str_email": "str_email",
  "str_ibge_code": "str_ibge_code",
  "str_name": "str_name",
  "str_neighborhood": "str_neighborhood",
  "str_socioenvironmental_status": "str_socioenvironmental_status",
  "str_type": "str_type",
  "str_zip_code": "str_zip_code"
}'

Example Request Body

{
  "bl_move_with_tag_reading": true,
  "county_id": "00000000-0000-0000-0000-000000000000",
  "dec_area": 0,
  "dec_exploration_area": 0,
  "responsible_user": {
    "str_document": "str_document",
    "str_email": "str_email",
    "str_name": "str_name",
    "str_type": "str_type"
  },
  "responsible_user_id": "00000000-0000-0000-0000-000000000000",
  "str_address": "str_address",
  "str_car": "str_car",
  "str_code": "str_code",
  "str_company_code": "str_company_code",
  "str_document": "str_document",
  "str_email": "str_email",
  "str_ibge_code": "str_ibge_code",
  "str_name": "str_name",
  "str_neighborhood": "str_neighborhood",
  "str_socioenvironmental_status": "str_socioenvironmental_status",
  "str_type": "str_type",
  "str_zip_code": "str_zip_code"
}

json

Example Responses

{
  "data": {
    "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": {
      "bl_active": true,
      "bl_admin": true,
      "bl_cancelled": true,
      "bl_org_admin": 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"
      },
      "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"
  }
}

json

application/json

Unrestricted search

POST

https://dev.api.radarbov.app

/api/establishments/unrestricted/search

Bearer (JWT)

Unrestricted search › Request Body optional

Unrestricted search › Responses

Establishment Partial Unrestricted Data[] · required

PaginationMeta · required

POST/api/establishments/unrestricted/search

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

Example Request Body

{}

json

Example Responses

{
  "data": [
    {
      "bl_move_with_tag_reading": true,
      "control_units": {},
      "county_id": "00000000-0000-0000-0000-000000000000",
      "dec_area": {},
      "dec_exploration_area": {},
      "geo_location": {
        "coordinates": [
          0
        ],
        "type": "Point"
      },
      "id": "00000000-0000-0000-0000-000000000000",
      "lst_invite_movimentation_types": {},
      "responsible_user_id": "00000000-0000-0000-0000-000000000000",
      "str_address": "str_address",
      "str_car": "str_car",
      "str_code": "str_code",
      "str_company_code": "str_company_code",
      "str_county_federative_unit": "str_county_federative_unit",
      "str_county_ibge_uf_code": "str_county_ibge_uf_code",
      "str_county_name": "str_county_name",
      "str_document": "str_document",
      "str_name": "str_name",
      "str_neighborhood": "str_neighborhood",
      "str_responsible_document": "str_responsible_document",
      "str_responsible_user_name": "str_responsible_user_name",
      "str_socioenvironmental_status": "str_socioenvironmental_status",
      "str_status": "str_status",
      "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

County Establishment History