Occurrence

Download schema

Update

PUT

https://dev.api.radarbov.app

/api/v1/occurrences/{id}

Bearer (JWT)

Update › path Parameters

id

string · required

Update › Request Body

Occurrence Update

bl_is_regular

boolean

regularization_by_user_id

string · uuid

str_regularization_motive

string

ts_regularization_at

string · date-time

Update › Responses

Occurrence · required

PUT/api/v1/occurrences/{id}

curl https://dev.api.radarbov.app/api/v1/occurrences/:id \
  --request PUT \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "bl_is_regular": true,
  "regularization_by_user_id": "00000000-0000-0000-0000-000000000000",
  "str_regularization_motive": "str_regularization_motive",
  "ts_regularization_at": "2024-08-25T15:00:00Z"
}'

Example Request Body

{
  "bl_is_regular": true,
  "regularization_by_user_id": "00000000-0000-0000-0000-000000000000",
  "str_regularization_motive": "str_regularization_motive",
  "ts_regularization_at": "2024-08-25T15:00:00Z"
}

json

Example Responses

{
  "data": {
    "bl_allow_regularization": true,
    "bl_is_regular": true,
    "generated_by_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"
    },
    "id": "00000000-0000-0000-0000-000000000000",
    "json_generated_from": {},
    "json_types": {},
    "regularization_by_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_regularization_motive": "str_regularization_motive",
    "ts_created_at": "2024-08-25T15:00:00Z",
    "ts_regularization_at": "2024-08-25T15:00:00Z",
    "ts_updated_at": "2024-08-25T15:00:00Z"
  }
}