User

Download schema

Index

GET

https://dev.api.radarbov.app

/api/users

Bearer (JWT)

Index › query Parameters

int_current_page

integer

Default: 1

int_max_results

integer

Default: 50

Index › Responses

User Partial Data[] · required

PaginationMeta · required

GET/api/users

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

Example Responses

{
  "data": [
    {
      "bl_active": true,
      "bl_admin": true,
      "bl_cancelled": true,
      "county_id": "00000000-0000-0000-0000-000000000000",
      "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"
    }
  ],
  "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/users

Bearer (JWT)

Create › Request Body

User Create

str_document

string · required

str_email

string · required

str_name

string · required

bl_admin

boolean

str_phone

string

str_type

string

Create › Responses

Created

User · required

POST/api/users

curl https://dev.api.radarbov.app/api/users \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "bl_admin": true,
  "str_document": "str_document",
  "str_email": "str_email",
  "str_name": "str_name",
  "str_phone": "str_phone",
  "str_type": "str_type"
}'

Example Request Body

{
  "bl_admin": true,
  "str_document": "str_document",
  "str_email": "str_email",
  "str_name": "str_name",
  "str_phone": "str_phone",
  "str_type": "str_type"
}

json

Example Responses

{
  "data": {
    "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"
  }
}

json

application/json

Resend activation

PUT

https://dev.api.radarbov.app

/api/users/{id}/resend-activation

Bearer (JWT)

Resend activation › path Parameters

id

string · required

Resend activation › Request Body optional

Resend activation › Responses

User · required

PUT/api/users/{id}/resend-activation

curl https://dev.api.radarbov.app/api/users/:id/resend-activation \
  --request PUT \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{}'

Example Request Body

{}

json

Example Responses

{
  "data": {
    "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"
  }
}

json

application/json

Toggle admin

PUT

https://dev.api.radarbov.app

/api/users/{id}/toggle-admin

Bearer (JWT)

Toggle admin › path Parameters

id

string · required

Toggle admin › Request Body optional

Toggle admin › Responses

User · required

PUT/api/users/{id}/toggle-admin

curl https://dev.api.radarbov.app/api/users/:id/toggle-admin \
  --request PUT \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{}'

Example Request Body

{}

json

Example Responses

{
  "data": {
    "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"
  }
}

json

application/json

Search

POST

https://dev.api.radarbov.app

/api/users/search

Bearer (JWT)

Search › query Parameters

int_current_page

integer

Default: 1

int_max_results

integer

Default: 50

Search › Request Body optional

Search › Responses

User Partial Data[] · required

PaginationMeta · required

POST/api/users/search

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

Example Request Body

{}

json

Example Responses

{
  "data": [
    {
      "bl_active": true,
      "bl_admin": true,
      "bl_cancelled": true,
      "county_id": "00000000-0000-0000-0000-000000000000",
      "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"
    }
  ],
  "meta": {
    "int_current_page": 0,
    "int_max_results": 0,
    "int_total_pages": 0,
    "int_total_results": 0
  }
}

json

application/json

Deactivate

PUT

https://dev.api.radarbov.app

/api/users/{id}/deactivate

Bearer (JWT)

Deactivate › path Parameters

id

string · required

Deactivate › Request Body optional

Deactivate › Responses

User · required

PUT/api/users/{id}/deactivate

curl https://dev.api.radarbov.app/api/users/:id/deactivate \
  --request PUT \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{}'

Example Request Body

{}

json

Example Responses

{
  "data": {
    "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"
  }
}

json

application/json

Cancel activation

PUT

https://dev.api.radarbov.app

/api/users/{id}/cancel-activation

Bearer (JWT)

Cancel activation › path Parameters

id

string · required

Cancel activation › Request Body optional

Cancel activation › Responses

User · required

PUT/api/users/{id}/cancel-activation

curl https://dev.api.radarbov.app/api/users/:id/cancel-activation \
  --request PUT \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{}'

Example Request Body

{}

json

Example Responses

{
  "data": {
    "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"
  }
}

json

application/json

Show

GET

https://dev.api.radarbov.app

/api/users/{id}

Bearer (JWT)

Show › path Parameters

id

string · required

Show › Responses

User · required

GET/api/users/{id}

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

Example Responses

{
  "data": {
    "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"
  }
}

json

application/json

Update

PUT

https://dev.api.radarbov.app

/api/users/{id}

Bearer (JWT)

Update › path Parameters

id

string · required

Update › Request Body

User Update

county_id

string · uuid

org_id

string · uuid

organization_id

string · uuid

str_document

string

str_email

string

str_name

string

str_phone

string

str_type

string

Update › Responses

User · required

PUT/api/users/{id}

curl https://dev.api.radarbov.app/api/users/:id \
  --request PUT \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "county_id": "00000000-0000-0000-0000-000000000000",
  "org_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_type": "str_type"
}'

Example Request Body

{
  "county_id": "00000000-0000-0000-0000-000000000000",
  "org_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_type": "str_type"
}

json

Example Responses

{
  "data": {
    "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"
  }
}

json

application/json

Update

PATCH

https://dev.api.radarbov.app

/api/users/{id}

Bearer (JWT)

Update › path Parameters

id

string · required

Update › Request Body

User Update

county_id

string · uuid

org_id

string · uuid

organization_id

string · uuid

str_document

string

str_email

string

str_name

string

str_phone

string

str_type

string

Update › Responses

User · required

PATCH/api/users/{id}

curl https://dev.api.radarbov.app/api/users/:id \
  --request PATCH \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "county_id": "00000000-0000-0000-0000-000000000000",
  "org_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_type": "str_type"
}'

Example Request Body

{
  "county_id": "00000000-0000-0000-0000-000000000000",
  "org_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_type": "str_type"
}

json

Example Responses

{
  "data": {
    "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"
  }
}

json

application/json

Restore activation

PUT

https://dev.api.radarbov.app

/api/users/{id}/restore-activation

Bearer (JWT)

Restore activation › path Parameters

id

string · required

Restore activation › Request Body optional

Restore activation › Responses

User · required

PUT/api/users/{id}/restore-activation

curl https://dev.api.radarbov.app/api/users/:id/restore-activation \
  --request PUT \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{}'

Example Request Body

{}

json

Example Responses

{
  "data": {
    "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"
  }
}

json

application/json

Activate

PUT

https://dev.api.radarbov.app

/api/users/{id}/activate

Bearer (JWT)

Activate › path Parameters

id

string · required

Activate › Request Body optional

Activate › Responses

User · required

PUT/api/users/{id}/activate

curl https://dev.api.radarbov.app/api/users/:id/activate \
  --request PUT \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{}'

Example Request Body

{}

json

Example Responses

{
  "data": {
    "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"
  }
}

json

application/json

Register

POST

https://dev.api.radarbov.app

/api/users/register

Bearer (JWT)

Register › Request Body optional

Register › Responses

Created

User · required

POST/api/users/register

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

Example Request Body

{}

json

Example Responses

{
  "data": {
    "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"
  }
}

json

application/json

Travel User Features