Editar dados de pré-admissões — APIs da Colabbe
Edita uma pré-admissão existente. A API valida as informações da requisição e substitui as informações da pré-admissão com os dados que foram enviados na requisição.
Definições da API:
URL
POST <url_plataforma>/t/senior.com.br/bridge/1.0/rest/hcm/onboardingintegration/actions/preAdmissionUpdate
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)
| Authorization | Bearer <access_token> |
|---|---|
| Content-Type | application/json |
Substitua<access_token>pela chave de acesso obtida a partir da API de autenticação na plataforma.
Parâmetros
* Obrigatórios
| Parâmetro | Tipo | Descrição |
|---|---|---|
| preAdmissionId * | String | Identificador único da pré-admissão. |
| employeeName | String | Nome a ser atualizado no cadastro do colaborador. |
| admissionDate | Date | Data de admissão a ser atualizada no cadastro do colaborador. |
| company { } | - | Informações da empresa. Você pode obter estas informações pelo retorno da API companyQuery. |
| branchOffice { } | - | Informações da filial. Você pode obter estas informações pelo retorno da API branchOfficeQuery. |
| jobPosition { } | - | Informações do cargo. Você pode obter estas informações pelo retorno da API jobPositionQuery. |
| customFields { } | - | Campos customizados criados no modelo de convite de pré-admissão. |
company:
| Campo | Tipo | Descrição |
|---|---|---|
| id | String | Identificador único da empresa. |
| companyName | String | Nome da empresa. |
| code | String | Código do sistema externo. |
Nota
Você pode obter estas informações pelo retorno da API companyQuery.
branchOffice:
| Campo | Tipo | Descrição |
|---|---|---|
| id | String | Identificador único da filial. |
| branchOfficeName | String | Razão social da filial. |
| tradingName | String | Nome fantasia da filial. |
| code | String | Código do sistema externo. |
Nota
Você pode obter estas informações pelo retorno da API branchOfficeQuery.
jobPosition:
| Campo | Tipo | Descrição |
|---|---|---|
| id | String | Identificador único do cargo. |
| name | String | Nome do cargo. |
| code | String | Código do sistema externo. |
Nota
Você pode obter estas informações pelo retorno da API jobPositionQuery.
customFields:
| Parâmetro | Tipo | Descrição |
|---|---|---|
| field | String | Identificador do campo customizado criado na senior X Platform. |
| value | - | Recebe o valor preenchido no campo. O tipo do campo value será o mesmo tipo que foi definido durante a criação do campo customizado na senior X Platform. |
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" } ] }
|
Respostas
| Código | Descrição | Campos da resposta | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| 200 | Ok (indica que a pré-admissão foi atualizada) |
|
|||||||||
| 401 | Invalid credentials | - | |||||||||
| default | Error response |
|
Exemplo da resposta (200):
{ "result": true }
|
Exemplo da resposta (default):
{ "message": "string", "reason": "BAD_REQUEST" }
|
English
Español
