Listar registros

GET 
/evento

Lista somente eventos liberados da INTFOL_EVENTOS, de acordo com os parâmetros de filtro informados.

Prefira filtros na URL. Todos são opcionais no binding atual. Quando informado, o body JSON substitui a query string. Não há paginação implementada. Informe ano e mes para uma consulta útil: ambos são aplicados incondicionalmente; não há validação explícita de ausência.

Request

Query Parameters

application/json

Body

Body

Alternativa legada à query string. Um body preenchido tem prioridade integral sobre a URL. Alguns clientes/proxies não suportam body em GET.

ano string
mes string
codEmpresa string
matricula int64

filtroJson

Filtros no body (compatibilidade)

{
  "ano": "2026",
  "mes": "01",
  "codEmpresa": "1000",
  "matricula": 900001
}

Responses

200

Sucesso

application/json

Schema

Schema

success booleanrequired
message stringnullable

data

object[]

Array [

matricula integer

conteudo number

dataRegistro string

observacao stringnullable

dataAtualizacao stringnullable

situacao string

usuario string

dataMovimento string

id int64

]

Example (from schema)

{
  "success": true,
  "message": "string",
  "total": 0,
  "data": [
    {
      "operacao": "string",
      "codEmpresa": "string",
      "matricula": 0,
      "ano": "string",
      "mes": "string",
      "verba": "string",
      "tipoConteudo": "string",
      "conteudo": 0,
      "dataRegistro": "string",
      "observacao": "string",
      "dataAtualizacao": "string",
      "situacao": "string",
      "usuario": "string",
      "dataMovimento": "string",
      "id": 0
    }
  ]
}

semRegistros

Nenhum registro pendente

{
  "success": true,
  "message": null,
  "total": 0,
  "data": []
}

comRegistros

Exemplo legado anonimizado; não coletado nesta revisão

{
  "success": true,
  "total": 2,
  "data": [
    {
      "id": 262040,
      "ano": "2021",
      "codEmpresa": "1000",
      "conteudo": 6,
      "dataAtualizacao": "",
      "dataMovimento": "2021-03-01",
      "dataRegistro": "2021-03-23T16:03:26",
      "matricula": 900001,
      "mes": "03",
      "observacao": "OK",
      "operacao": "I",
      "situacao": "1",
      "tipoConteudo": "H",
      "usuario": "USUARIO_EXEMPLO",
      "verba": "1101"
    },
    {
      "id": 262041,
      "ano": "2021",
      "codEmpresa": "1000",
      "conteudo": 19.55,
      "dataAtualizacao": "",
      "dataMovimento": "2021-03-01",
      "dataRegistro": "2021-03-23T16:03:26",
      "matricula": 900001,
      "mes": "03",
      "observacao": "OK",
      "operacao": "I",
      "situacao": "1",
      "tipoConteudo": "H",
      "usuario": "USUARIO_EXEMPLO",
      "verba": "1111"
    }
  ],
  "message": null
}

400

O serviço retornou success false. PUT sem IDs existentes, dependentes sem sucesso, ou falha tratada na consulta de ocorrências. Não representa todas as falhas de validação.

application/json

Schema

Schema

success booleanrequired
message stringnullable
data object[]nullable

Example (from schema)

{
  "success": true,
  "message": "string",
  "total": 0,
  "data": [
    {}
  ]
}

semProcessamento

Resultado negativo do serviço, ilustrativo

{
  "success": false,
  "message": null,
  "total": 0,
  "data": null
}

401

Nao autorizado

application/json

Schema

Schema

property name* any

Example (from schema)

{}

ilustrativo

Exemplo legado, dependente do serviço de autenticação

{
  "success": false,
  "message": "Authorization expirado ou inexistente."
}

500

Exceção no binding, validação ou processamento. Pode ocorrer ao faltar campo obrigatório. Mensagem/cause dependem da exceção.

application/json

Schema

Schema

message stringnullablerequired

Example (from schema)

{
  "success": false,
  "message": "string"
}

excecao

Exceção ilustrativa; mensagem depende do erro

{
  "success": false,
  "message": "Falha ao processar a requisição."
}

Loading...