Editar dados de pré-admissões — APIs da Admissão Digital

Edita uma pré-admissão existente. A API valida as informações da requisição e substitui integralmente as informações de contrato da pré-admissão com os dados enviados na requisição.

Definições da API:

• URL
• Cabeçalho
• Parâmetros
• Exemplo

• Respostas

URL

Substitua<url_plataforma>*pela URL correspondente ao seu ambiente. Se for o ambiente de produção, substitua por:*https://platform.senior.com.br

Cabeçalho (Header)

Substitua<access_token>pela chave de acesso obtida a partir da API de autenticação na plataforma.

Parâmetros

company:

branchOffice:

area:

jobPosition:

customFields:

Exemplo

{
  "preAdmissionId": "1747ffb8-3250-4409-a7ca-2688af714f02",
  "employeeName": "José da Silva",
  "admissionDate": "2022-01-01",
  "company": {
    "id": "88e53115-91a6-4e13-bb58-384e882c6839",
    "companyName": "Senior Sistemas",
    "code": "1"
  },
    "branchOffice": {
      "id": "1c638493-6b55-4882-9dbc-6d60c9aa2c1a",
      "branchOfficeName": "Senior Filial S/A",
      "tradingName": "Senior Filial",
      "code": "4"
    },
    "customFields": [
      {
        "field": "usu_custom",
        "value": "Valor 1"
      },
      {
        "field": "usu_custom1",
        "value": "Valor 2"
      },
      {
        "field": "usu_custom2",
        "value": "Valor 3"
      }
    ]
}	

Comportamento de substituição de dados

A primitiva preAdmissionUpdate substitui integralmente os dados de contrato da pré-admissão. Isso significa que os campos company, branchOffice, area, jobPosition, costCenter e workstationGroup são sempre reescritos com base no que foi enviado na requisição.

Se um desses campos não for informado no payload, ele será apagado (definido como vazio) no cadastro da pré-admissão.

Portanto, ao editar uma pré-admissão, envie todos os dados de contrato que devem ser mantidos, mesmo aqueles que não estão sendo alterados.

{
    "preAdmissionId": "1747ffb8-3250-4409-a7ca-2688af714f02",
    "jobPosition": {
    "id": "002af2d9-19ff-43a9-9e3c-58485190bb2c",
    "name": "Estagiário",
    "code": "1"

    }
}

{
    "preAdmissionId": "1747ffb8-3250-4409-a7ca-2688af714f02",
    "company": {
    "id": "88e53115-91a6-4e13-bb58-384e882c6839",
    "companyName": "Senior Sistemas",
    "code": "1"
        },
    "branchOffice": {
    "id": "1c638493-6b55-4882-9dbc-6d60c9aa2c1a",
    "branchOfficeName": "Senior Filial S/A",
    "tradingName": "Senior Filial",
    "code": "4"
        },
    "jobPosition": {
    "id": "002af2d9-19ff-43a9-9e3c-58485190bb2c",
    "name": "Estagiário",
    "code": "1"
        }
}

Restrição por status da pré-admissão

A edição só é permitida enquanto a pré-admissão estiver em andamento. Pré-admissões que já foram finalizadas, admitidas na folha, estão em processo de assinatura ou expiraram não podem ser alteradas por esta primitiva.

A tabela abaixo indica em quais status a edição é permitida:

Ao tentar editar uma pré-admissão em um status não permitido, a API retornará erro BAD_REQUEST com a mensagem: A pré-admissão está finalizada e não pode ser alterada.

Respostas

{
    "result": true
}

{
    "message": "string",
    "reason": "BAD_REQUEST"
}