Animals Ingress

Download schema

Show

GET

https://dev.api.radarbov.app

/api/v1/animals-ingresses/{id}

Bearer (JWT)

Show › path Parameters

id

string · required

Show › Responses

Animals Ingress · required

GET/api/v1/animals-ingresses/{id}

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

Example Responses

{
  "data": {
    "bl_move_with_tag_reading": true,
    "gtas": {},
    "id": "00000000-0000-0000-0000-000000000000",
    "operator_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_description": "str_description",
    "str_label": "str_label",
    "str_socioenvironmental_status": "str_socioenvironmental_status",
    "str_status": "str_status",
    "tags": {},
    "to_control_unit": {
      "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"
    },
    "ts_created_at": "2024-08-25T15:00:00Z",
    "ts_first_read": "2024-08-25T15:00:00Z",
    "ts_started_at": "2024-08-25T15:00:00Z",
    "ts_unsafe_client_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/v1/animals-ingresses

Bearer (JWT)

Index › query Parameters

int_current_page

integer

Default: 1

int_max_results

integer

Default: 50

Index › Responses

Animals Ingress Partial Data[] · required

PaginationMeta · required

GET/api/v1/animals-ingresses

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

Example Responses

{
  "data": [
    {
      "bl_move_with_tag_reading": true,
      "id": "00000000-0000-0000-0000-000000000000",
      "int_gta_count": 0,
      "operator_user_id": "00000000-0000-0000-0000-000000000000",
      "str_description": "str_description",
      "str_label": "str_label",
      "str_operator_user_name": "str_operator_user_name",
      "str_socioenvironmental_status": "str_socioenvironmental_status",
      "str_status": "str_status",
      "str_to_control_unit_code": "str_to_control_unit_code",
      "str_to_establishment_name": "str_to_establishment_name",
      "tags": {},
      "to_control_unit_id": "00000000-0000-0000-0000-000000000000",
      "ts_created_at": "2024-08-25T15:00:00Z",
      "ts_first_read": "2024-08-25T15:00:00Z",
      "ts_started_at": "2024-08-25T15:00:00Z",
      "ts_unsafe_client_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/animals-ingresses

Bearer (JWT)

Create › Request Body

Animals Ingress Create

bl_force

boolean

Animals Ingress Create Gtas[]

id

string · uuid

operator_user_id

string · uuid

str_force_message

string

Animals Ingress Create Tags[]

ts_first_read

string · date-time

ts_started_at

string · date-time

ts_unsafe_client_created_at

string · date-time

Create › Responses

Created

Animals Ingress · required

POST/api/v1/animals-ingresses

curl https://dev.api.radarbov.app/api/v1/animals-ingresses \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "bl_force": true,
  "gtas": [
    {
      "gta_id": "00000000-0000-0000-0000-000000000000",
      "id": "00000000-0000-0000-0000-000000000000",
      "str_license_plate": "str_license_plate"
    }
  ],
  "id": "00000000-0000-0000-0000-000000000000",
  "operator_user_id": "00000000-0000-0000-0000-000000000000",
  "str_force_message": "str_force_message",
  "tags": [
    {
      "geo_ingress": {},
      "id": "00000000-0000-0000-0000-000000000000",
      "str_rod_code": "str_rod_code",
      "str_tag_code": "str_tag_code",
      "tag_id": "00000000-0000-0000-0000-000000000000",
      "ts_ingress_at": "2024-08-25T15:00:00Z"
    }
  ],
  "ts_first_read": "2024-08-25T15:00:00Z",
  "ts_started_at": "2024-08-25T15:00:00Z",
  "ts_unsafe_client_created_at": "2024-08-25T15:00:00Z"
}'

Example Request Body

{
  "bl_force": true,
  "gtas": [
    {
      "gta_id": "00000000-0000-0000-0000-000000000000",
      "id": "00000000-0000-0000-0000-000000000000",
      "str_license_plate": "str_license_plate"
    }
  ],
  "id": "00000000-0000-0000-0000-000000000000",
  "operator_user_id": "00000000-0000-0000-0000-000000000000",
  "str_force_message": "str_force_message",
  "tags": [
    {
      "geo_ingress": {},
      "id": "00000000-0000-0000-0000-000000000000",
      "str_rod_code": "str_rod_code",
      "str_tag_code": "str_tag_code",
      "tag_id": "00000000-0000-0000-0000-000000000000",
      "ts_ingress_at": "2024-08-25T15:00:00Z"
    }
  ],
  "ts_first_read": "2024-08-25T15:00:00Z",
  "ts_started_at": "2024-08-25T15:00:00Z",
  "ts_unsafe_client_created_at": "2024-08-25T15:00:00Z"
}

json

Example Responses

{
  "data": {
    "bl_move_with_tag_reading": true,
    "gtas": {},
    "id": "00000000-0000-0000-0000-000000000000",
    "operator_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_description": "str_description",
    "str_label": "str_label",
    "str_socioenvironmental_status": "str_socioenvironmental_status",
    "str_status": "str_status",
    "tags": {},
    "to_control_unit": {
      "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"
    },
    "ts_created_at": "2024-08-25T15:00:00Z",
    "ts_first_read": "2024-08-25T15:00:00Z",
    "ts_started_at": "2024-08-25T15:00:00Z",
    "ts_unsafe_client_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/animals-ingresses/search

Bearer (JWT)

Search › query Parameters

int_current_page

integer

Default: 1

int_max_results

integer

Default: 50

Search › Request Body optional

Search › Responses

Animals Ingress Partial Data[] · required

PaginationMeta · required

POST/api/v1/animals-ingresses/search

curl https://dev.api.radarbov.app/api/v1/animals-ingresses/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,
      "id": "00000000-0000-0000-0000-000000000000",
      "int_gta_count": 0,
      "operator_user_id": "00000000-0000-0000-0000-000000000000",
      "str_description": "str_description",
      "str_label": "str_label",
      "str_operator_user_name": "str_operator_user_name",
      "str_socioenvironmental_status": "str_socioenvironmental_status",
      "str_status": "str_status",
      "str_to_control_unit_code": "str_to_control_unit_code",
      "str_to_establishment_name": "str_to_establishment_name",
      "tags": {},
      "to_control_unit_id": "00000000-0000-0000-0000-000000000000",
      "ts_created_at": "2024-08-25T15:00:00Z",
      "ts_first_read": "2024-08-25T15:00:00Z",
      "ts_started_at": "2024-08-25T15:00:00Z",
      "ts_unsafe_client_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

Animals Egress Attachment

Create

POST

https://dev.api.radarbov.app

/api/v1/animals-ingresses

Bearer (JWT)

Create › Request Body

Animals Ingress Create

bl_force

boolean

Animals Ingress Create Gtas[]

id

string · uuid

operator_user_id

string · uuid

str_force_message

string

Animals Ingress Create Tags[]

ts_first_read

string · date-time

ts_started_at

string · date-time

ts_unsafe_client_created_at

string · date-time

Create › Responses

Created

Animals Ingress · required

POST

https://dev.api.radarbov.app

/api/v1/animals-ingresses/search

Bearer (JWT)

Search › query Parameters

int_current_page

integer

Default: 1

int_max_results

integer

Default: 50

Search › Request Body optional

Search › Responses

Animals Ingress Partial Data[] · required

PaginationMeta · required