Tags Egress

Download schema

Show

GET

https://dev.api.radarbov.app

/api/tags-egresses/{id}

Bearer (JWT)

Show › path Parameters

id

string · required

Show › Responses

Tags Egress · required

Index

GET

https://dev.api.radarbov.app

/api/tags-egresses

Bearer (JWT)

Index › query Parameters

int_current_page

integer

Default: 1

int_max_results

integer

Default: 50

Index › Responses

Tags Egress Partial Data[] · required

PaginationMeta · required

GET/api/tags-egresses

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

Example Responses

{
  "data": [
    {
      "from_control_unit_id": "00000000-0000-0000-0000-000000000000",
      "id": "00000000-0000-0000-0000-000000000000",
      "str_from_control_unit_code": "str_from_control_unit_code",
      "str_from_establishment_name": "str_from_establishment_name",
      "str_status": "str_status",
      "str_to_control_unit_code": "str_to_control_unit_code",
      "str_to_establishment_name": "str_to_establishment_name",
      "str_type": "str_type",
      "tags_boxes": {},
      "to_control_unit_id": "00000000-0000-0000-0000-000000000000",
      "ts_created_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/tags-egresses

Bearer (JWT)

Create › Request Body

Tags Egress Create

from_control_unit_id

string · uuid

id

string · uuid

operator_user_id

string · uuid

str_type

string

Tags Egress Create Tags Boxes[]

to_control_unit_id

string · uuid

ts_unsafe_client_created_at

string · date-time

Create › Responses

Created

Tags Egress · required

POST/api/tags-egresses

curl https://dev.api.radarbov.app/api/tags-egresses \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "from_control_unit_id": "00000000-0000-0000-0000-000000000000",
  "id": "00000000-0000-0000-0000-000000000000",
  "operator_user_id": "00000000-0000-0000-0000-000000000000",
  "str_type": "str_type",
  "tags_boxes": [
    {
      "int_quantity": 0,
      "str_begin": "str_begin",
      "str_code": "str_code",
      "str_type": "str_type"
    }
  ],
  "to_control_unit_id": "00000000-0000-0000-0000-000000000000",
  "ts_unsafe_client_created_at": "2024-08-25T15:00:00Z"
}'

Example Request Body

{
  "from_control_unit_id": "00000000-0000-0000-0000-000000000000",
  "id": "00000000-0000-0000-0000-000000000000",
  "operator_user_id": "00000000-0000-0000-0000-000000000000",
  "str_type": "str_type",
  "tags_boxes": [
    {
      "int_quantity": 0,
      "str_begin": "str_begin",
      "str_code": "str_code",
      "str_type": "str_type"
    }
  ],
  "to_control_unit_id": "00000000-0000-0000-0000-000000000000",
  "ts_unsafe_client_created_at": "2024-08-25T15:00:00Z"
}

json

Example Responses

{
  "data": {
    "from_control_unit": {},
    "from_control_unit_id": "00000000-0000-0000-0000-000000000000",
    "id": "00000000-0000-0000-0000-000000000000",
    "str_status": "str_status",
    "str_type": "str_type",
    "tags_boxes": {},
    "to_control_unit": {},
    "to_control_unit_id": "00000000-0000-0000-0000-000000000000",
    "ts_created_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/tags-egresses/search

Bearer (JWT)

Search › query Parameters

int_current_page

integer

Default: 1

int_max_results

integer

Default: 50

Search › Request Body optional

Search › Responses

Tags Egress Partial Data[] · required

PaginationMeta · required

POST/api/tags-egresses/search

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

Example Request Body

{}

json

Example Responses

{
  "data": [
    {
      "from_control_unit_id": "00000000-0000-0000-0000-000000000000",
      "id": "00000000-0000-0000-0000-000000000000",
      "str_from_control_unit_code": "str_from_control_unit_code",
      "str_from_establishment_name": "str_from_establishment_name",
      "str_status": "str_status",
      "str_to_control_unit_code": "str_to_control_unit_code",
      "str_to_establishment_name": "str_to_establishment_name",
      "str_type": "str_type",
      "tags_boxes": {},
      "to_control_unit_id": "00000000-0000-0000-0000-000000000000",
      "ts_created_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

Search destinations

POST

https://dev.api.radarbov.app

/api/tags-egresses/destinations/search

Bearer (JWT)

Search destinations › Request Body optional

Search destinations › Responses

Control Unit Partial Data[] · required

PaginationMeta · required

POST/api/tags-egresses/destinations/search

curl https://dev.api.radarbov.app/api/tags-egresses/destinations/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": {
        "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"
      },
      "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

Tags Box Tags Identification

Create

POST

https://dev.api.radarbov.app

/api/tags-egresses

Bearer (JWT)

Create › Request Body

Tags Egress Create

from_control_unit_id

string · uuid

id

string · uuid

operator_user_id

string · uuid

str_type

string

Tags Egress Create Tags Boxes[]

to_control_unit_id

string · uuid

ts_unsafe_client_created_at

string · date-time

Create › Responses

Created

Tags Egress · required

POST

https://dev.api.radarbov.app

/api/tags-egresses/search

Bearer (JWT)

Search › query Parameters

int_current_page

integer

Default: 1

int_max_results

integer

Default: 50

Search › Request Body optional

Search › Responses

Tags Egress Partial Data[] · required

PaginationMeta · required