Listar registros

GET 
/ocorrencia

Lista somente ocorrências com origem P da INTFOL_OCORRENCIAS, 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.

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.

codEmpresa string
matricula int64

filtroJson

Filtros no body (compatibilidade)

{
  "codEmpresa": "1000",
  "matricula": 900001
}

Responses

200

Sucesso

application/json

Schema

Schema

success booleanrequired
message stringnullable

data

object[]

Array [

id integer

matricula integer

dataInicial string

dataFinal stringnullable

tipoOcorrencia integer

obsOcorrencia stringnullable

seqOcorrencia integernullable

dataRegistro stringnullable

observacao stringnullable

dataAtualizacao stringnullable

origem string

situacao string

usuario string

horaInicial stringnullable

horaFinal stringnullable

]

Example (from schema)

{
  "success": true,
  "message": "string",
  "total": 0,
  "data": [
    {
      "id": 0,
      "operacao": "string",
      "codEmpresa": "string",
      "matricula": 0,
      "dataInicial": "string",
      "dataFinal": "string",
      "tipoOcorrencia": 0,
      "obsOcorrencia": "string",
      "seqOcorrencia": 0,
      "dataRegistro": "string",
      "observacao": "string",
      "dataAtualizacao": "string",
      "origem": "string",
      "situacao": "string",
      "usuario": "string",
      "horaInicial": "string",
      "horaFinal": "string"
    }
  ]
}

semRegistros

Nenhum registro pendente

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

comRegistros

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

{
  "success": true,
  "total": 5,
  "data": [
    {
      "id": 307910,
      "codEmpresa": "1000",
      "dataAtualizacao": "",
      "dataFinal": "2019-06-24",
      "dataInicial": "2019-06-24",
      "dataRegistro": "2019-06-25T06:06:46",
      "horaFinal": "",
      "horaInicial": "",
      "matricula": 900001,
      "obsOcorrencia": "GERADA AUTOMATICAMENTE",
      "operacao": "I",
      "origem": "P",
      "seqOcorrencia": 13879960,
      "situacao": "1",
      "tipoOcorrencia": 350,
      "usuario": "USUARIO_EXEMPLO"
    },
    {
      "id": 15613,
      "codEmpresa": "1000",
      "dataAtualizacao": "",
      "dataFinal": "2018-01-02",
      "dataInicial": "2018-01-02",
      "dataRegistro": "2018-01-03T08:51:56",
      "horaFinal": "",
      "horaInicial": "",
      "matricula": 900001,
      "obsOcorrencia": "GERADA AUTOMATICAMENTE",
      "operacao": "I",
      "origem": "P",
      "seqOcorrencia": 12857312,
      "situacao": "1",
      "tipoOcorrencia": 350,
      "usuario": "USUARIO_EXEMPLO"
    },
    {
      "id": 2184,
      "codEmpresa": "1000",
      "dataAtualizacao": "",
      "dataFinal": "2017-12-28",
      "dataInicial": "2017-12-28",
      "dataRegistro": "2017-12-29T04:02:22",
      "horaFinal": "",
      "horaInicial": "",
      "matricula": 900001,
      "obsOcorrencia": "GERADA AUTOMATICAMENTE",
      "operacao": "I",
      "origem": "P",
      "seqOcorrencia": 12842294,
      "situacao": "1",
      "tipoOcorrencia": 350,
      "usuario": "USUARIO_EXEMPLO"
    },
    {
      "id": 5947,
      "codEmpresa": "1000",
      "dataAtualizacao": "",
      "dataFinal": "2017-12-29",
      "dataInicial": "2017-12-29",
      "dataRegistro": "2017-12-30T04:01:45",
      "horaFinal": "",
      "horaInicial": "",
      "matricula": 900001,
      "obsOcorrencia": "GERADA AUTOMATICAMENTE",
      "operacao": "I",
      "origem": "P",
      "seqOcorrencia": 12850453,
      "situacao": "1",
      "tipoOcorrencia": 350,
      "usuario": "USUARIO_EXEMPLO"
    },
    {
      "id": 308202,
      "codEmpresa": "1000",
      "dataAtualizacao": "",
      "dataFinal": "2019-06-25",
      "dataInicial": "2019-06-25",
      "dataRegistro": "2019-06-26T06:10:49",
      "horaFinal": "",
      "horaInicial": "",
      "matricula": 900001,
      "obsOcorrencia": "GERADA AUTOMATICAMENTE",
      "operacao": "I",
      "origem": "P",
      "seqOcorrencia": 13881246,
      "situacao": "1",
      "tipoOcorrencia": 350,
      "usuario": "USUARIO_EXEMPLO"
    }
  ],
  "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...