Recursos

A API de Recursos permite criar, listar e obter detalhes dos recursos da habilitar.me.

Propriedades

Name
id
Type
integer
Description
ID do recurso na habilitar.me.
Name
user_id
Type
integer
Description
ID do condutor na habilitar.me.
Name
legal_instance
Type
object
Description
Instância (dp, jari, cetran)
Name
status
Type
string
Description
Status do recurso (accepted, pending, rejected).
Name
submitted_at
Type
datetime
Description
Data de protocolamento no órgão.
Name
created_at
Type
datetime
Description
Data de criação
Name
updated_at
Type
datetime
Description
Data de atualização
Name
reference_object_id
Type
integer
Description
ID do objeto (infração, processo).
Name
reference_object_type
Type
string
Description
Tipo do objeto (traffic_ticket, procedure).

GET/v1/appeals

Listar Recursos

Este endpoint permite lista os recursos da organização.

Parâmetros opcionais

Name
page
Type
integer
Description
Página a ser exibida. Default: 1.
Name
page_size
Type
integer
Description
Quantidade de itens por página. Default: 10.
Name
status
Type
string
Description
Filtre por status do recurso. Default: all.

Request

GET

/v1/appeals

curl -G https://api.habilitar.me/v1/appeals \
  -H "api-x-token: {token}" \
  -d page=1 \
  -d page_size=10

Response

{
  "page": 1,
  "page_size": 10,
  "total": 2,
  "total_pages": 1,
  "data": [
    {
      "id": 1,
      "user_id": 1,
      "legal_instance": "dp",
      "status": "deferred",
      "created_at": "2021-01-01",
      "updated_at": "2021-01-01",
    },
    {
      "id": 2,
      "user_id": 2,
      "legal_instance": "jari",
      "status": "pending",
      "created_at": "2021-01-01",
      "updated_at": "2021-01-01",
    }
  ]
}

GET/v1/appeals/(:id)

Detalhes do Recurso

Este endpoint permite obter os detalhes de um recurso.

Request

GET

/v1/appeals/1

curl https://api.habilitar.me/v1/appeals/1 \
  -H "api-x-token: {token}"

Response

{
  "id": 1,
  "user_id": 1,
  "legal_instance": "dp",
  "status": "deferred",
  "created_at": "2021-01-01",
  "updated_at": "2021-01-01",
}

POST/v1/appeals

Criar Recurso

Este endpoint permite lista os recursos da organização.

Parâmetros obrigatórios

Name
user_id
Type
integer
Description
ID do condutor.
Name
reference_object_id
Type
integer
Description
ID do objeto (infração, processo).
Name
reference_object_type
Type
string
Description
Tipo do objeto (traffic_ticket, procedure).

Request

POST

/v1/appeals

curl https://api.habilitar.me/v1/appeals \
  -H "api-x-token: {token}" \
  -d user_id=1 \
  -d object_id=1 \
  -d object_type=traffic_ticket

Response

{
  "id": 1,
  "user_id": 1,
  "status": "pending",
  "created_at": "2021-01-01",
  "updated_at": "2021-01-01",
}