Invite Request

Download schema

Notify

POST

https://dev.hub.radarbov.app

/api/invite_requests/notify

Bearer (JWT)

Notify › Responses

No Content

No data returned

Decline

PUT

https://dev.hub.radarbov.app

/api/invite_requests/{id}/decline

Bearer (JWT)

Decline › path Parameters

id

string · required

Decline › Responses

No Content

No data returned

Index

GET

https://dev.hub.radarbov.app

/api/invite_requests

Bearer (JWT)

Index › query Parameters

int_current_page

integer

Default: 1

int_max_results

integer

Default: 50

Index › Responses

Invite Request Index Data[] · required

PaginationMeta · required

GET/api/invite_requests

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

Example Responses

{
  "data": [
    {
      "control_unit": {
        "dec_control_unit_area": {},
        "id": "00000000-0000-0000-0000-000000000000",
        "int_producers_count": 0,
        "lst_invite_movimentation_types": {},
        "lst_producer_emails": {},
        "lst_producer_names": {},
        "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",
          "lst_states": [
            "string"
          ],
          "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_production_phase": "str_production_phase",
        "str_production_system": "str_production_system",
        "str_purpose": "str_purpose",
        "str_species": "str_species",
        "str_status": "str_status",
        "str_type": "str_type",
        "ts_created_at": "2024-08-25T15:00:00Z",
        "ts_updated_at": "2024-08-25T15:00:00Z"
      },
      "establishment": {
        "id": "00000000-0000-0000-0000-000000000000",
        "str_code": "str_code",
        "str_name": "str_name",
        "str_type": "str_type"
      },
      "id": "00000000-0000-0000-0000-000000000000",
      "requester": {
        "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",
        "lst_states": [
          "string"
        ],
        "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_status": "str_status",
      "str_type": "str_type",
      "ts_created_at": "2024-08-25T15:00:00Z",
      "ts_granted_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.hub.radarbov.app

/api/invite_requests

Bearer (JWT)

Create › Request Body

Invite Request Create

requester_id

string · uuid · required

str_type

string · required

control_unit_id

string · uuid

establishment_id

string · uuid

grantor_id

string · uuid

gta_id

string · uuid

str_status

string

ts_granted_at

string

Create › Responses

Created

POST/api/invite_requests

curl https://dev.hub.radarbov.app/api/invite_requests \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "control_unit_id": "00000000-0000-0000-0000-000000000000",
  "establishment_id": "00000000-0000-0000-0000-000000000000",
  "grantor_id": "00000000-0000-0000-0000-000000000000",
  "gta_id": "00000000-0000-0000-0000-000000000000",
  "requester_id": "00000000-0000-0000-0000-000000000000",
  "str_status": "str_status",
  "str_type": "str_type",
  "ts_granted_at": "ts_granted_at"
}'

Example Request Body

{
  "control_unit_id": "00000000-0000-0000-0000-000000000000",
  "establishment_id": "00000000-0000-0000-0000-000000000000",
  "grantor_id": "00000000-0000-0000-0000-000000000000",
  "gta_id": "00000000-0000-0000-0000-000000000000",
  "requester_id": "00000000-0000-0000-0000-000000000000",
  "str_status": "str_status",
  "str_type": "str_type",
  "ts_granted_at": "ts_granted_at"
}

json

Example Responses

{}

json

application/json

Approve

PUT

https://dev.hub.radarbov.app

/api/invite_requests/{id}/approve

Bearer (JWT)

Approve › path Parameters

id

string · required

Approve › Responses

No Content

No data returned

Search

POST

https://dev.hub.radarbov.app

/api/invite_requests/search

Bearer (JWT)

Search › query Parameters

int_current_page

integer

Default: 1

int_max_results

integer

Default: 50

Search › Request Body optional

Search › Responses

Invite Request Index Data[] · required

PaginationMeta · required

POST/api/invite_requests/search

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

Example Request Body

{}

json

Example Responses

{
  "data": [
    {
      "control_unit": {
        "dec_control_unit_area": {},
        "id": "00000000-0000-0000-0000-000000000000",
        "int_producers_count": 0,
        "lst_invite_movimentation_types": {},
        "lst_producer_emails": {},
        "lst_producer_names": {},
        "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",
          "lst_states": [
            "string"
          ],
          "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_production_phase": "str_production_phase",
        "str_production_system": "str_production_system",
        "str_purpose": "str_purpose",
        "str_species": "str_species",
        "str_status": "str_status",
        "str_type": "str_type",
        "ts_created_at": "2024-08-25T15:00:00Z",
        "ts_updated_at": "2024-08-25T15:00:00Z"
      },
      "establishment": {
        "id": "00000000-0000-0000-0000-000000000000",
        "str_code": "str_code",
        "str_name": "str_name",
        "str_type": "str_type"
      },
      "id": "00000000-0000-0000-0000-000000000000",
      "requester": {
        "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",
        "lst_states": [
          "string"
        ],
        "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_status": "str_status",
      "str_type": "str_type",
      "ts_created_at": "2024-08-25T15:00:00Z",
      "ts_granted_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

Invite Occurrence

Create

POST

https://dev.hub.radarbov.app

/api/invite_requests

Bearer (JWT)

Create › Request Body

Invite Request Create

requester_id

string · uuid · required

str_type

string · required

control_unit_id

string · uuid

establishment_id

string · uuid

grantor_id

string · uuid

gta_id

string · uuid

str_status

string

ts_granted_at

string

Create › Responses

Created

POST

https://dev.hub.radarbov.app

/api/invite_requests/search

Bearer (JWT)

Search › query Parameters

int_current_page

integer

Default: 1

int_max_results

integer

Default: 50

Search › Request Body optional

Search › Responses

Invite Request Index Data[] · required

PaginationMeta · required