Animal

Download schema

Show

GET

https://dev.api.radarbov.app

/api/v1/animals/{id}

Bearer (JWT)

Show › path Parameters

id

string · required

Show › Responses

Animal · required

GET/api/v1/animals/{id}

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

Example Responses

{
  "data": {
    "current_tag": {
      "id": "00000000-0000-0000-0000-000000000000",
      "last_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"
      },
      "str_code": "str_code",
      "str_status": "str_status",
      "ts_created_at": "2024-08-25T15:00:00Z",
      "ts_updated_at": "2024-08-25T15:00:00Z"
    },
    "geo_identification": {
      "coordinates": [
        0
      ],
      "type": "Point"
    },
    "id": "00000000-0000-0000-0000-000000000000",
    "int_age_months_at_identification": 0,
    "int_weight_kilos_at_identification": 0,
    "str_description": "str_description",
    "str_extra_tag": "str_extra_tag",
    "str_gender": "str_gender",
    "str_name": "str_name",
    "str_ranch_code": "str_ranch_code",
    "str_rod_code": "str_rod_code",
    "str_socioenvironmental_status": "str_socioenvironmental_status",
    "str_species": "str_species",
    "str_status": "str_status",
    "ts_born_date": "2024-08-25T15:00:00Z",
    "ts_created_at": "2024-08-25T15:00:00Z",
    "ts_identified_at": "2024-08-25T15:00:00Z",
    "ts_updated_at": "2024-08-25T15:00:00Z"
  }
}

json

application/json

Report

GET

https://dev.api.radarbov.app

/api/v1/animals/{animal_id}/report

Bearer (JWT)

Report › path Parameters

animal_id

string · required

Report › Responses

Index

GET

https://dev.api.radarbov.app

/api/v1/animals

Bearer (JWT)

Index › query Parameters

int_current_page

integer

Default: 1

int_max_results

integer

Default: 50

Index › Responses

Animal Partial Data[] · required

PaginationMeta · required

GET/api/v1/animals

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

Example Responses

{
  "data": [
    {
      "current_tag_id": "00000000-0000-0000-0000-000000000000",
      "geo_identification": {
        "coordinates": [
          0
        ],
        "type": "Point"
      },
      "id": "00000000-0000-0000-0000-000000000000",
      "int_age_months_at_identification": 0,
      "int_weight_kilos_at_identification": 0,
      "str_current_tag_code": "str_current_tag_code",
      "str_description": "str_description",
      "str_establishment_name": "str_establishment_name",
      "str_extra_tag": "str_extra_tag",
      "str_gender": "str_gender",
      "str_last_control_unit_code": "str_last_control_unit_code",
      "str_name": "str_name",
      "str_ranch_code": "str_ranch_code",
      "str_rod_code": "str_rod_code",
      "str_socioenvironmental_status": "str_socioenvironmental_status",
      "str_species": "str_species",
      "str_status": "str_status",
      "ts_born_date": "2024-08-25T15:00:00Z",
      "ts_created_at": "2024-08-25T15:00:00Z",
      "ts_identified_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

Search

POST

https://dev.api.radarbov.app

/api/v1/animals/search

Bearer (JWT)

Search › query Parameters

int_current_page

integer

Default: 1

int_max_results

integer

Default: 50

Search › Request Body optional

Search › Responses

Animal Partial Data[] · required

PaginationMeta · required

POST/api/v1/animals/search

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

Example Request Body

{}

json

Example Responses

{
  "data": [
    {
      "current_tag_id": "00000000-0000-0000-0000-000000000000",
      "geo_identification": {
        "coordinates": [
          0
        ],
        "type": "Point"
      },
      "id": "00000000-0000-0000-0000-000000000000",
      "int_age_months_at_identification": 0,
      "int_weight_kilos_at_identification": 0,
      "str_current_tag_code": "str_current_tag_code",
      "str_description": "str_description",
      "str_establishment_name": "str_establishment_name",
      "str_extra_tag": "str_extra_tag",
      "str_gender": "str_gender",
      "str_last_control_unit_code": "str_last_control_unit_code",
      "str_name": "str_name",
      "str_ranch_code": "str_ranch_code",
      "str_rod_code": "str_rod_code",
      "str_socioenvironmental_status": "str_socioenvironmental_status",
      "str_species": "str_species",
      "str_status": "str_status",
      "ts_born_date": "2024-08-25T15:00:00Z",
      "ts_created_at": "2024-08-25T15:00:00Z",
      "ts_identified_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

Animal History

POST

https://dev.api.radarbov.app

/api/v1/animals/search

Bearer (JWT)

Search › query Parameters

int_current_page

integer

Default: 1

int_max_results

integer

Default: 50

Search › Request Body optional

Search › Responses

Animal Partial Data[] · required

PaginationMeta · required