Invite

Download schema

Show

GET

https://dev.api.radarbov.app

/api/invites/{id}

Bearer (JWT)

Show › path Parameters

id

string · required

Show › Responses

Invite · required

GET/api/invites/{id}

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

Example Responses

{
  "data": {
    "bl_accepted": true,
    "bl_restricted": true,
    "control_unit": {
      "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"
      },
      "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"
    },
    "gta": {
      "destination_establishment": {},
      "id": "00000000-0000-0000-0000-000000000000",
      "int_animal_quantity": 0,
      "int_female_animal_quantity": 0,
      "int_male_animal_quantity": 0,
      "json_gta_animal_quantity_category_fields": {},
      "lst_invite_movimentation_types": {},
      "source_establishment": {},
      "str_code": "str_code",
      "str_federative_unit": "str_federative_unit",
      "str_origin": "str_origin",
      "str_purpose": "str_purpose",
      "str_series": "str_series",
      "str_species": "str_species",
      "str_status": "str_status",
      "ts_created_at": "2024-08-25T15:00:00Z",
      "ts_expires_at": "2024-08-25T15:00:00Z",
      "ts_updated_at": "2024-08-25T15:00:00Z"
    },
    "id": "00000000-0000-0000-0000-000000000000",
    "str_movimentation_type": "str_movimentation_type",
    "str_type": "str_type",
    "ts_created_at": "2024-08-25T15:00:00Z",
    "ts_expires_at": "2024-08-25T15:00:00Z",
    "ts_updated_at": "2024-08-25T15:00:00Z",
    "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"
    }
  }
}

json

application/json

Update

PUT

https://dev.api.radarbov.app

/api/invites/{id}

Bearer (JWT)

Update › path Parameters

id

string · required

Update › Request Body

Invite Update

bl_accepted

boolean

bl_restricted

boolean

gta_id

string · uuid

str_movimentation_type

string

ts_expires_at

string

user_id

string · uuid

Update › Responses

Invite · required

PUT/api/invites/{id}

curl https://dev.api.radarbov.app/api/invites/:id \
  --request PUT \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "bl_accepted": true,
  "bl_restricted": true,
  "gta_id": "00000000-0000-0000-0000-000000000000",
  "str_movimentation_type": "str_movimentation_type",
  "ts_expires_at": "ts_expires_at",
  "user_id": "00000000-0000-0000-0000-000000000000"
}'

Example Request Body

{
  "bl_accepted": true,
  "bl_restricted": true,
  "gta_id": "00000000-0000-0000-0000-000000000000",
  "str_movimentation_type": "str_movimentation_type",
  "ts_expires_at": "ts_expires_at",
  "user_id": "00000000-0000-0000-0000-000000000000"
}

json

Example Responses

{
  "data": {
    "bl_accepted": true,
    "bl_restricted": true,
    "control_unit": {
      "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"
      },
      "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"
    },
    "gta": {
      "destination_establishment": {},
      "id": "00000000-0000-0000-0000-000000000000",
      "int_animal_quantity": 0,
      "int_female_animal_quantity": 0,
      "int_male_animal_quantity": 0,
      "json_gta_animal_quantity_category_fields": {},
      "lst_invite_movimentation_types": {},
      "source_establishment": {},
      "str_code": "str_code",
      "str_federative_unit": "str_federative_unit",
      "str_origin": "str_origin",
      "str_purpose": "str_purpose",
      "str_series": "str_series",
      "str_species": "str_species",
      "str_status": "str_status",
      "ts_created_at": "2024-08-25T15:00:00Z",
      "ts_expires_at": "2024-08-25T15:00:00Z",
      "ts_updated_at": "2024-08-25T15:00:00Z"
    },
    "id": "00000000-0000-0000-0000-000000000000",
    "str_movimentation_type": "str_movimentation_type",
    "str_type": "str_type",
    "ts_created_at": "2024-08-25T15:00:00Z",
    "ts_expires_at": "2024-08-25T15:00:00Z",
    "ts_updated_at": "2024-08-25T15:00:00Z",
    "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"
    }
  }
}

json

application/json

Delete

DELETE

https://dev.api.radarbov.app

/api/invites/{id}

Bearer (JWT)

Delete › path Parameters

id

string · required

Delete › Responses

No Content

No data returned

Update

PATCH

https://dev.api.radarbov.app

/api/invites/{id}

Bearer (JWT)

Update › path Parameters

id

string · required

Update › Request Body

Invite Update

bl_accepted

boolean

bl_restricted

boolean

gta_id

string · uuid

str_movimentation_type

string

ts_expires_at

string

user_id

string · uuid

Update › Responses

Invite · required

PATCH/api/invites/{id}

curl https://dev.api.radarbov.app/api/invites/:id \
  --request PATCH \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "bl_accepted": true,
  "bl_restricted": true,
  "gta_id": "00000000-0000-0000-0000-000000000000",
  "str_movimentation_type": "str_movimentation_type",
  "ts_expires_at": "ts_expires_at",
  "user_id": "00000000-0000-0000-0000-000000000000"
}'

Example Request Body

{
  "bl_accepted": true,
  "bl_restricted": true,
  "gta_id": "00000000-0000-0000-0000-000000000000",
  "str_movimentation_type": "str_movimentation_type",
  "ts_expires_at": "ts_expires_at",
  "user_id": "00000000-0000-0000-0000-000000000000"
}

json

Example Responses

{
  "data": {
    "bl_accepted": true,
    "bl_restricted": true,
    "control_unit": {
      "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"
      },
      "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"
    },
    "gta": {
      "destination_establishment": {},
      "id": "00000000-0000-0000-0000-000000000000",
      "int_animal_quantity": 0,
      "int_female_animal_quantity": 0,
      "int_male_animal_quantity": 0,
      "json_gta_animal_quantity_category_fields": {},
      "lst_invite_movimentation_types": {},
      "source_establishment": {},
      "str_code": "str_code",
      "str_federative_unit": "str_federative_unit",
      "str_origin": "str_origin",
      "str_purpose": "str_purpose",
      "str_series": "str_series",
      "str_species": "str_species",
      "str_status": "str_status",
      "ts_created_at": "2024-08-25T15:00:00Z",
      "ts_expires_at": "2024-08-25T15:00:00Z",
      "ts_updated_at": "2024-08-25T15:00:00Z"
    },
    "id": "00000000-0000-0000-0000-000000000000",
    "str_movimentation_type": "str_movimentation_type",
    "str_type": "str_type",
    "ts_created_at": "2024-08-25T15:00:00Z",
    "ts_expires_at": "2024-08-25T15:00:00Z",
    "ts_updated_at": "2024-08-25T15:00:00Z",
    "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"
    }
  }
}

json

application/json

Search

POST

https://dev.api.radarbov.app

/api/invites/search

Bearer (JWT)

Search › query Parameters

int_current_page

integer

Default: 1

int_max_results

integer

Default: 50

Search › Request Body optional

Search › Responses

Create from token

POST

https://dev.api.radarbov.app

/api/invites/from_token

Bearer (JWT)

Create from token › Request Body optional

Create from token › Responses

Created

Notify

POST

https://dev.api.radarbov.app

/api/invites/{id}/notify

Bearer (JWT)

Notify › path Parameters

id

string · required

Notify › Responses

No Content

No data returned

Create

POST

https://dev.api.radarbov.app

/api/invites

Bearer (JWT)

Create › Request Body

Invite Create

control_unit_id

string · uuid

establishment_id

string · uuid

gta_id

string · uuid

str_movimentation_type

string

Invite To User

ts_expires_at

string

user_id

string · uuid

Create › Responses

Created

Invite · required

POST/api/invites

curl https://dev.api.radarbov.app/api/invites \
  --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",
  "gta_id": "00000000-0000-0000-0000-000000000000",
  "str_movimentation_type": "str_movimentation_type",
  "to_user": {
    "str_document": "str_document",
    "str_email": "str_email",
    "str_name": "str_name"
  },
  "ts_expires_at": "ts_expires_at",
  "user_id": "00000000-0000-0000-0000-000000000000"
}'

Example Request Body

{
  "control_unit_id": "00000000-0000-0000-0000-000000000000",
  "establishment_id": "00000000-0000-0000-0000-000000000000",
  "gta_id": "00000000-0000-0000-0000-000000000000",
  "str_movimentation_type": "str_movimentation_type",
  "to_user": {
    "str_document": "str_document",
    "str_email": "str_email",
    "str_name": "str_name"
  },
  "ts_expires_at": "ts_expires_at",
  "user_id": "00000000-0000-0000-0000-000000000000"
}

json

Example Responses

{
  "data": {
    "bl_accepted": true,
    "bl_restricted": true,
    "control_unit": {
      "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"
      },
      "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"
    },
    "gta": {
      "destination_establishment": {},
      "id": "00000000-0000-0000-0000-000000000000",
      "int_animal_quantity": 0,
      "int_female_animal_quantity": 0,
      "int_male_animal_quantity": 0,
      "json_gta_animal_quantity_category_fields": {},
      "lst_invite_movimentation_types": {},
      "source_establishment": {},
      "str_code": "str_code",
      "str_federative_unit": "str_federative_unit",
      "str_origin": "str_origin",
      "str_purpose": "str_purpose",
      "str_series": "str_series",
      "str_species": "str_species",
      "str_status": "str_status",
      "ts_created_at": "2024-08-25T15:00:00Z",
      "ts_expires_at": "2024-08-25T15:00:00Z",
      "ts_updated_at": "2024-08-25T15:00:00Z"
    },
    "id": "00000000-0000-0000-0000-000000000000",
    "str_movimentation_type": "str_movimentation_type",
    "str_type": "str_type",
    "ts_created_at": "2024-08-25T15:00:00Z",
    "ts_expires_at": "2024-08-25T15:00:00Z",
    "ts_updated_at": "2024-08-25T15:00:00Z",
    "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"
    }
  }
}

json

application/json

Home Invite Request

Update

PUT

https://dev.api.radarbov.app

/api/invites/{id}

Bearer (JWT)

Update › path Parameters

id

string · required

Update › Request Body

Invite Update

bl_accepted

boolean

bl_restricted

boolean

gta_id

string · uuid

str_movimentation_type

string

ts_expires_at

string

user_id

string · uuid

Update › Responses

Invite · required

Update

PATCH

https://dev.api.radarbov.app

/api/invites/{id}

Bearer (JWT)

Update › path Parameters

id

string · required

Update › Request Body

Invite Update

bl_accepted

boolean

bl_restricted

boolean

gta_id

string · uuid

str_movimentation_type

string

ts_expires_at

string

user_id

string · uuid

Update › Responses

Invite · required

Create

POST

https://dev.api.radarbov.app

/api/invites

Bearer (JWT)

Create › Request Body

Invite Create

control_unit_id

string · uuid

establishment_id

string · uuid

gta_id

string · uuid

str_movimentation_type

string

Invite To User

ts_expires_at

string

user_id

string · uuid

Create › Responses

Created

Invite · required