Incluir/atualizar registro

POST 
/dependentesFuncionario

Envia dependentes de um funcionário existente. O serviço chama proc_integra_dependentes_sap para cada dependente. CPF tem prioridade sobre outroDocumento; envie documentos como strings. CodEmpresa, matricula e uma lista preenchida de dependentes são requisitos operacionais. O bean não é validado pelo serviço; regras e valores aceitos dependem da procedure Oracle instalada. total conta funcionários processados, não dependentes. success true significa que pelo menos um dependente teve sucesso; pode haver erros individuais em data[].dependentes[].

Request

application/json

Body

Body

required

Corpo JSON; os campos não são parâmetros de URL.

data

object[]

required

Lista de registros. Envie ao menos um registro para executar a operação.

Array [

dependentes

object[]

required

Lista de um ou mais dependentes vinculados ao funcionário.

Array [

]

]

minimo

Payload mínimo ilustrativo

{
  "data": [
    {
      "codEmpresa": "1000",
      "matricula": 900001,
      "dependentes": [
        {
          "nome": "DEPENDENTE EXEMPLO",
          "outroDocumento": "DOC-EXEMPLO-001",
          "dataInicial": "2026-01-15"
        }
      ]
    }
  ]
}

completo

Com CPF fictício; substitua por documento válido de teste

{
  "data": [
    {
      "codEmpresa": "1000",
      "matricula": 900001,
      "dependentes": [
        {
          "nome": "DEPENDENTE EXEMPLO",
          "cpf": "00000000000",
          "outroDocumento": null,
          "parentesco": "FILHO",
          "sexo": "M",
          "dataNascimento": "2010-01-15",
          "dataInicial": "2026-01-15",
          "dataFinal": null
        }
      ]
    }
  ]
}

Responses

200

Operação realizada com sucesso.

application/json

Schema

Schema

success booleanrequired
message stringnullable

data

object[]

Array [

codEmpresa string

matricula integer

codFuncionario integer

dependentes

object[]

Array [

cpf stringnullable

outroDocumento stringnullable

nome stringnullable

codPessoa integernullable

success boolean

descrErro stringnullable

]

]

Example (from schema)

{
  "success": true,
  "message": "string",
  "total": 0,
  "data": [
    {
      "codEmpresa": "string",
      "matricula": 0,
      "codFuncionario": 0,
      "dependentes": [
        {
          "cpf": "string",
          "outroDocumento": "string",
          "nome": "string",
          "codPessoa": 0,
          "success": true,
          "descrErro": "string"
        }
      ]
    }
  ]
}

sucesso

Todos os dependentes incluídos

{
  "success": true,
  "message": null,
  "total": 1,
  "data": [
    {
      "codEmpresa": "1000",
      "matricula": 900001,
      "codFuncionario": 1001,
      "dependentes": [
        {
          "cpf": null,
          "outroDocumento": "DOC-EXEMPLO-001",
          "nome": "DEPENDENTE EXEMPLO",
          "codPessoa": 1001,
          "success": true,
          "descrErro": null
        }
      ]
    }
  ]
}

sucessoParcial

Ao menos um sucesso; verificar os resultados individuais

{
  "success": true,
  "message": null,
  "total": 1,
  "data": [
    {
      "codEmpresa": "1000",
      "matricula": 900001,
      "codFuncionario": 1001,
      "dependentes": [
        {
          "cpf": null,
          "outroDocumento": "DOC-EXEMPLO-001",
          "nome": "DEPENDENTE EXEMPLO",
          "codPessoa": 1001,
          "success": true,
          "descrErro": null
        },
        {
          "cpf": null,
          "outroDocumento": "DOC-EXEMPLO-002",
          "nome": "DEPENDENTE EXEMPLO",
          "codPessoa": null,
          "success": false,
          "descrErro": "Mensagem ilustrativa retornada pela procedure."
        }
      ]
    }
  ]
}

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[]

Array [

codEmpresa string

matricula integer

codFuncionario integer

dependentes

object[]

Array [

cpf stringnullable

outroDocumento stringnullable

nome stringnullable

codPessoa integernullable

success boolean

descrErro stringnullable

]

]

Example (from schema)

{
  "success": true,
  "message": "string",
  "total": 0,
  "data": [
    {
      "codEmpresa": "string",
      "matricula": 0,
      "codFuncionario": 0,
      "dependentes": [
        {
          "cpf": "string",
          "outroDocumento": "string",
          "nome": "string",
          "codPessoa": 0,
          "success": true,
          "descrErro": "string"
        }
      ]
    }
  ]
}

semProcessamento

Resultado negativo do serviço, ilustrativo

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

nenhumSucesso

Funcionário processado, todos os dependentes falharam

{
  "success": false,
  "message": null,
  "total": 1,
  "data": [
    {
      "codEmpresa": "1000",
      "matricula": 900001,
      "codFuncionario": 1001,
      "dependentes": [
        {
          "cpf": null,
          "outroDocumento": "DOC-EXEMPLO-001",
          "nome": "DEPENDENTE EXEMPLO",
          "codPessoa": null,
          "success": false,
          "descrErro": "Mensagem ilustrativa retornada pela procedure."
        }
      ]
    }
  ]
}

401

Authorization expirado ou inexistente.

application/json

Schema

Schema

property name* any

Example (from schema)

{}

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."
}

funcionarioNaoEncontrado

Mensagem gerada ao não localizar o funcionário

{
  "success": false,
  "message": "Funcionário não localizado para empresa 1000 e matrícula 900001"
}

Loading...