Gestión del Capital Humano - senior X - Manual del Usuario > Admisión Digital > Integraciones > Integración a través de API > Editar datos de preadmisiones (preAdmissionUpdate)

Editar datos previos a la admisión: API Admissão Digital

Edita una preadmisión existente. La API valida la información de la solicitud y reemplaza la información previa a la admisión con los datos que se enviaron en la solicitud.

URL

POST <url_plataforma> /t/senior.com.br/bridge/1.0/rest/hcm/onboardingintegration/actions/ preAdmissionUpdate

Reemplace <url_plataforma> con la URL correspondiente a su entorno. Si es el entorno de producción, reemplácelo por: https://platform.senior.com.br

Encabezamiento

Autorización	Portador <access_token>
Tipo de contenido	aplicación/json

Reemplace <access_token> con la clave de acceso obtenida de la API de autenticación de la plataforma .

Parámetros

* Obligatorio

Parámetro	Tipo	Descripción
ID de preadmisión *	Cadena	Identificador único de preadmisión.
nombre del empleado	Cadena	Nombre a actualizar en el registro del empleado.
admisiónFecha	Fecha	Fecha de admisión a actualizar en el registro del empleado.
compañía { }	-	Información de la empresa. Puede obtener esta información devolviendo la API companyQuery .
sucursal { }	-	Información de sucursales. Puede obtener esta información devolviendo la API BranchOfficeQuery .
área { }	-	Información del área (ubicación). Puede obtener esta información devolviendo la API areaListQuery .
posición de trabajo { }	-	Información de posición. Puede obtener esta información devolviendo la API jobPositionQuery .
campos personalizados { }	-	Campos personalizados creados en la plantilla de invitación previa a la admisión.

compañía:

Campo	Tipo	Descripción
identificación	Cadena	Identificador único de la empresa.
nombre de empresa	Cadena	Nombre de empresa.
código	Cadena	Código del sistema externo.

Nota

Puede obtener esta información devolviendo la API companyQuery .

Sucursal:

Campo	Tipo	Descripción
identificación	Cadena	Identificador único de sucursal.
sucursalNombreOficina	Cadena	Razón social de la sucursal.
nombre comercial	Cadena	Nombre comercial de la sucursal.
código	Cadena	Código del sistema externo.

Nota

Puede obtener esta información devolviendo la API BranchOfficeQuery .

área:

Campo	Tipo	Descripción
identificación	Cadena	Identificador único de la zona (ubicación).
nombre	Cadena	Nombre de la zona (ubicación).
código	Cadena	Código del sistema externo.

Nota

Puede obtener esta información devolviendo la API areaListQuery .

Puesto de trabajo:

Campo	Tipo	Descripción
identificación	Cadena	Identificador de trabajo único.
nombre	Cadena	Nombre del puesto.
código	Cadena	Código del sistema externo.

Nota

Puede obtener esta información devolviendo la API jobPositionQuery .

campos personalizados:

Parámetro	Tipo	Descripción
campo	Cadena	Identificador del campo personalizado creado en XPlatform .
valor	-	Recibe el valor completado en el campo. El tipo de campo `value` será el mismo tipo que se definió al crear el campo personalizado en XPlatform .

Ejemplo

  { "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 " }, { "campo": "usu_custom1", "valor": "Valor 2" }, { "campo": "usu_custom2", "valor": "Valor 3" } ] }

Respuestas

Código

Descripción

Campos de respuesta

200

Ok (indica que la preadmisión ha sido actualizada)

Campo	Tipo	Descripción
resultado	Booleano	Indicativo de si la actualización de datos fue exitosa o no.

401

Credenciales no válidas

por defecto

Respuesta de error

Campo	Tipo	Descripción
mensaje	Cadena	Mensaje descriptivo de error.
razón	Cadena	Un código que representa la categoría de la causa del error.