Gestión del Capital Humano - senior X - Manual del Usuario > Admisión Digital > Integraciones > Integración a través de API > Buscar preadmisiones por estado (preAdmissionListQuery)

Buscar preadmisiones por estado: API Admissão Digital

Busca todas las preadmisiones completadas que tienen un estado específico y de un período específico, listando la información completa de cada una.

La lista de preadmisiones está paginada, lo que significa que solo se muestran unos pocos registros en cada página.

Se aplican algunas reglas al buscar preadmisiones:

El número de registros por página no puede exceder los 30 registros (la cantidad predeterminada es 10).
El plazo de admisión no puede exceder los 31 días.
La ordenación de preadmisiones se realizará por fecha de admisión. Si hay más de un preingreso con la misma fecha de ingreso, el orden será por el nombre del nuevo empleado.

URL

POST <url_plataforma> /t/senior.com.br/bridge/1.0/rest/hcm/onboardingintegration/queries/ preAdmissionListQuery

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
fecha de inicio *	Fecha	Fecha de inicio de búsqueda por fecha de admisión. Formato esperado: `AAAA-MM-DD`
fecha de finalización *	Fecha	Fecha de finalización de la búsqueda por fecha de admisión. Formato esperado: `AAAA-MM-DD`
estado *	Cadena	Estado actual de preadmisión. Valores permitidos: `UNREAD` = No leído `READ` = Leer `EXPIRED` = Vencido `IN_VALIDATION` = En validación `FINISHED` = Terminado `PENDING_ADMISSION` = Pendiente de admisión `STARTED_ADMISSION` = Admisión iniciada `FINISHED_ADMISSION` = Admisión completada
tamaño	Entero	Número de registros que deben presentarse en cada página. Cuando no se especifica, el tamaño de página predeterminado es 10 registros. El límite de registros por página es 30.
página	Entero	Número de página actual. La primera página comienza en 0 (cero). Cuando no se informa, la página predeterminada es 0 (cero).

Ejemplo

  { "startDate": "2019-05-01", "endDate": "2019-05-15", "status": "IN_VALIDATION", "size": 10, "page": 0 }

Respuestas

Código

Descripción

Campos de respuesta

200

DE ACUERDO

Campo		Tipo	Descripción
resultado { }			Solicitar resultados.
	elementos totales	Entero	Total de preingresos encontrados.
	totalPáginas	Entero	Total de páginas encontradas.
	contenido { }		Listado de preadmisiones relacionadas con la página.

Contenido del contenido:

Campo	Tipo	Descripción
ID de preadmisión	Cadena	Identificador único de preadmisión.
admisiónFecha	Cadena	Fecha en la que se contratará al nuevo empleado.
contrato { }		Información del contrato con la empresa.
datos personales { }		Información personal del nuevo empleado.
documento { }		Nuevos documentos de empleado.
dependientes { }		Relación de dependientes del nuevo empleado.

Contenido del contrato:

Campo	Tipo	Descripción
tipo de empleado	Cadena	Tipo de empleado.
empleadocontrato	Cadena	Tipo de contrato.
eSocialCategoría	Cadena	Categoría eSocial.
sefipCategoría	Cadena	Categoría SEFIP.
desempleoSeguro	Cadena	Tipo de seguro de desempleo.
tipo rais	Cadena	Enlace RAIS.
campos personalizados { }		Campos personalizados.

Contenido de datos personales:

Campo		Tipo	Descripción
básico { }			Información básica sobre el nuevo empleado.
	empleadoNombreCompleto	Cadena	Nombre completo.
	género	Cadena	Género.
	fecha de nacimiento	Cadena	Fecha de nacimiento.
	nombrepreferido	Cadena	Nombre con el que prefieres que te llamen.
	madresNombre	Cadena	Nombre de la madre.
	padresNombre	Cadena	Nombre del padre.
	campos personalizados { }		Campos personalizados.
complementario { }			Información adicional sobre el nuevo empleado.
	Estado civil	Cadena	Estado civil.
	gradodeeducación	Cadena	Nivel educativo.
	nacionalidad	Cadena	Nacionalidad.
	religión	Cadena	Religión.
	carrera	Cadena	Raza/Color.
	nombresocial	Cadena	Nombre social.
	campos personalizados { }		Campos personalizados.
lugar de nacimiento { }			Información sobre el lugar de nacimiento del nuevo empleado.
	país	Cadena	País de nacimiento.
	estado	Cadena	Estado del lugar de nacimiento.
	ciudad	Cadena	Ciudad de nacimiento.
	campos personalizados { }		Campos personalizados.
DIRECCIÓN { }			Información de dirección del nuevo empleado.
	país	Cadena	País.
	estado	Cadena	Unidad estatal/federativa.
	ciudad	Cadena	Ciudad.
	código postal	Cadena	Código postal.
	vecindario	Cadena	Vecindario.
	tipo de dirección	Cadena	Lugar público.
	DIRECCIÓN	Cadena	DIRECCIÓN.
	número	Cadena	Número de dirección.
	adicional	Cadena	Información adicional sobre la dirección.
	campos personalizados { }		Campos personalizados.
correo electrónico { }			Correos electrónicos de contacto del nuevo empleado.
	primer tipo	Cadena	Tipo de correo electrónico principal.
	primer correo electrónico	Cadena	Correo electrónico principal del nuevo empleado.
	segundo tipo	Cadena	Tipo de correo electrónico secundario.
	segundocorreo electrónico	Cadena	Correo electrónico secundario del nuevo colaborador.
	campos personalizados { }		Campos personalizados.
teléfono { }			Teléfonos de contacto del nuevo empleado.
	primer tipo	Cadena	Tipo de teléfono principal.
	primer teléfono	Cadena	Número de teléfono principal del nuevo empleado.
	segundo tipo	Cadena	Tipo de teléfono secundario.
	segundo teléfono	Cadena	Número de teléfono secundario del nuevo empleado.
	campos personalizados { }		Campos personalizados.

Contenido del documento:

Campo		Tipo	Descripción
cpf { }			Información del Registro Individual del Contribuyente (CPF) del nuevo empleado.
	número	Cadena	Número de documento.
	campos personalizados { }		Campos personalizados.
pis { }			Información sobre el Programa de Integración Social (PIS) del nuevo empleado.
	número	Cadena	Número de documento.
	fecha de asunto	Cadena	Fecha de emisión del documento.
	campos personalizados { }		Campos personalizados.
ctps { }			Información de la Tarjeta de Trabajo y Seguridad Social (CTPS) del nuevo empleado.
	número	Cadena	Número de documento.
	serie	Cadena	Número de serie del documento.
	dígito	Cadena	Dígito del número de documento.
	Estado emisor	Cadena	Estado de emisión del documento.
	fecha de asunto	Cadena	Fecha de emisión del documento.
	campos personalizados { }		Campos personalizados.
rg { }			Información del Registro General (RG) del nuevo empleado.
	número	Cadena	Número de documento.
	editor	Cadena	Organismo que expide el documento.
	Estado emisor	Cadena	Estado de expedición del documento.
	fecha de asunto	Cadena	Fecha de emisión del documento.
	campos personalizados { }		Campos personalizados.
pasaporte { }			Información del pasaporte del nuevo empleado.
	número	Cadena	Número de documento.
	editor	Cadena	Organismo que expide el documento.
	fecha de asunto	Cadena	Fecha de emisión del documento.
	fecha de vencimiento	Cadena	Fecha de vencimiento del documento.
	emisorPaís	Cadena	País de emisión del documento.
	Estado emisor	Cadena	Estado de expedición del documento.
	campos personalizados { }		Campos personalizados.
rico { }			Información del Registro de Identidad Civil (RIC) del nuevo empleado.
	número	Cadena	Número de documento.
	editor	Cadena	Organismo que expide el documento.
	emisorCiudad	Cadena	Ciudad de emisión del documento.
	Estado emisor	Cadena	Estado de expedición del documento.
	fecha de asunto	Cadena	Fecha de emisión del documento.
	fecha de vencimiento	Cadena	Fecha de vencimiento del documento.
	campos personalizados { }		Campos personalizados.
votante { }			Información de identificación de votante del nuevo empleado.
	número	Cadena	Número de documento.
	votaciónDistrito	Cadena	Zona electoral del documento.
	votaciónSección	Cadena	Sección de votación del documento.
	fecha de asunto	Cadena	Fecha de emisión del documento.
	emisorCiudad	Cadena	Ciudad de expedición del documento.
	Estado emisor	Cadena	Estado de expedición del documento.
	campos personalizados { }		Campos personalizados.
cnh {}			Información sobre la Licencia Nacional de Conducir (CNH) del nuevo empleado.
	número	Cadena	Número de documento.
	categoría	Cadena	Categoría de licencia.
	editor	Cadena	Organismo que expide el documento.
	Estado emisor	Cadena	Estado de emisión del documento.
	fecha de asunto	Cadena	Fecha de emisión del documento.
	fecha de vencimiento	Cadena	Fecha de vencimiento del documento.
	primera fecha de licencia de conducir	Cadena	Fecha de la primera licencia.
	campos personalizados { }		Campos personalizados.
reservar { }			Información del Certificado de Reservista del nuevo empleado.
	número	Cadena	Número de documento.
	serie	Cadena	Número de serie del documento.
	rana	Cadena	Número de registro de alistamiento (RA).
	fecha de exención	Cadena	Fecha de despido.
	tiene certificado	Booleano	Indica si la persona tiene certificado de reservista.
	campos personalizados { }		Campos personalizados.
certificado civil { }			Información del Certificado Civil del nuevo empleado.
	tipo	Cadena	Tipo de certificado.
	fecha de asunto	Cadena	Fecha de emisión del documento.
	registro	Cadena	Registro de certificado.
	término	Cadena	Plazo del certificado.
	libro	Cadena	Libro de certificados.
	hoja	Cadena	Hoja de certificado.
	notario	Cadena	Oficina de certificación.
	emisorCiudad	Cadena	Ciudad de expedición del documento.
	Estado emisor	Cadena	Estado de expedición del documento.
	campos personalizados { }		Campos personalizados.
cns { }			Información de la Tarjeta Sanitaria Nacional (CNS) del nuevo empleado.
	número	Cadena	Número de documento.
	campos personalizados { }		Campos personalizados.
dnv { }			Información de la Declaración de Nacido Vivo (DNV) del nuevo empleado.
	número	Cadena	Número de documento.
	campos personalizados { }		Campos personalizados.
cuenta bancaria { }
	banco	Cadena	Identificador del banco.
	rama	Cadena	Número de sucursal bancaria.
	tipo de cuenta	Cadena	Tipo de cuenta.
	cuenta bancaria	Cadena	Cuenta bancaria.
	dígito	Cadena	Dígito de cuenta.
	campos personalizados { }		Campos personalizados.
recibirSalarioAdelanto		Cadena	Indica si el nuevo empleado desea recibir un anticipo de salario.

Contenido dependiente:

Campo		Tipo	Descripción
nombre completo		Cadena	Nombre completo del dependiente.
grado de parentesco		Cadena	Grado de parentesco con el dependiente.
género		Cadena	Género del dependiente.
fecha de nacimiento		Cadena	Fecha de nacimiento del dependiente.
madresNombre		Cadena	Nombre de la madre del dependiente.
Estado civil		Cadena	Estado civil del dependiente.
declararImpuesto sobre la Renta		Cadena	Indica si el dependiente declara Impuesto a la Renta.
cpf { }			Información del Registro Individual del Contribuyente (CPF) del dependiente.
	número	Cadena	Número de documento.
	campos personalizados { }		Campos personalizados.
rg { }			Información del Registro General (RG) del dependiente.
	número	Cadena	Número de documento.
	editor	Cadena	Organismo que expide el documento.
	Estado emisor	Cadena	Estado de expedición del documento.
	fecha de asunto	Cadena	Fecha de emisión del documento.
	campos personalizados { }		Campos personalizados.
rico { }			Información del Registro de Identidad Civil (RIC) del dependiente.
	número	Cadena	Número de documento.
	editor	Cadena	Organismo que expide el documento.
	emisorCiudad	Cadena	Ciudad de emisión del documento.
	Estado emisor	Cadena	Estado de expedición del documento.
	fecha de asunto	Cadena	Fecha de emisión del documento.
	fecha de vencimiento	Cadena	Fecha de vencimiento del documento.
	campos personalizados { }		Campos personalizados.
sus {}			Información de la Tarjeta del Sistema Único de Salud (SUS).
	número	Cadena	Número de documento.
	campos personalizados { }		Campos personalizados.
folleto de vacunación { }			Información de la Cartilla de Vacunación.
	campos personalizados { }		Campos personalizados.
prueba de inscripción { }			Información del comprobante de registro.
	campos personalizados { }		Campos personalizados.
certificado de nacimiento { }			Información del Acta de Nacimiento del dependiente.
	tipo	Cadena	Tipo de certificado.
	fecha de asunto	Cadena	Fecha de emisión del documento.
	registro	Cadena	Registro de certificado.
	término	Cadena	Plazo del certificado.
	libro	Cadena	Libro de certificados.
	hoja	Cadena	Hoja de certificado.
	notario	Cadena	Oficina de certificación.
	emisorCiudad	Cadena	Ciudad de expedición del documento.
	Estado emisor	Cadena	Estado de emisión del documento.
	campos personalizados { }		Campos personalizados.
certificado de defunción { }			Información del Acta de Defunción del dependiente.
	tipo	Cadena	Tipo de certificado.
	fecha de asunto	Cadena	Fecha de emisión del documento.
	registro	Cadena	Registro de certificado.
	término	Cadena	Plazo del certificado.
	libro	Cadena	Libro de certificados.
	hoja	Cadena	Hoja de certificado.
	notario	Cadena	Oficina de certificación.
	emisorCiudad	Cadena	Ciudad de emisión del documento.
	Estado emisor	Cadena	Estado de expedición del documento.
	campos personalizados { }		Campos personalizados.
campos personalizados { }			Campos personalizados.

Contenido de campos personalizados:

Campo	Tipo	Descripción
campo	Cadena	Nombre de campo personalizado.
valor	Cadena	Valor de campo personalizado.

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.

Respuesta de ejemplo (200):

  { "result": { "totalElements": 0, "totalPages": 0, "contents": [ { "preAdmissionId": "string", "admissionDate": "2022-02-08", "contract": { "employeeType": "string", "employeeContract": "string", "eSocialCategory": "string", "sefipCategory": "string", "unemploymentInsurance": "string", "raisType": "string", "company": { "id": "string", "companyName": "string", "code": "string", "customFields": [ { "field": "string", "value": "string", "valueList": [ "string" ] } ] }, "branchOffice": { "id": "string", "branchOfficeName": "string", "tradingName": "string", "code": "string", "customFields": [ { "field": "string", "value": "string", "valueList": [ "string" ] } ] }, "jobPosition": { "id": "string", "name": "string", "code": "string", "customFields": [ { "field": "string", "value": "string", "valueList": [ "string" ] } ] }, "customFields": [ { "field": "string", "value": "string", "valueList": [ "string" ] } ] }, "personalData": { "basic": { "employeeFullName": "string", "gender": "string", "birthDate": "2022-02-08", "preferredName": "string", "mothersName": "string", "fathersName": "string", "customFields": [ { "field": "string", "value": "string", "valueList": [ "string" ] } ] }, "complementary": { "maritalStatus": "string", "degreeOfEducation": 0, "nationality": "string", "religion": "string", "race": "string", "socialName": "string", "customFields": [ { "field": "string", "value": "string", "valueList": [ "string" ] } ] }, "birthPlace": { "country": "string", "state": "string", "city": "string", "customFields": [ { "field": "string", "value": "string", "valueList": [ "string" ] } ] }, "address": { "country": "string", "state": "string", "city": "string", "cep": "string", "neighborhood": "string", "addressType": "string", "address": "string", "number": "string", "additional": "string", "customFields": [ { "field": "string", "value": "string", "valueList": [ "string" ] } ] }, "email": { "emailPersonal": "string", "emailBusiness": "string", "firstType": "string", "firstEmail": "string", "secondType": "string", "secondEmail": "string", "customFields": [ { "field": "string", "value": "string", "valueList": [ "string" ] } ] }, "phone": { "firstType": "string", "firstPhone": "string", "secondType": "string", "secondPhone": "string", "customFields": [ { "field": "string", "value": "string", "valueList": [ "string" ] } ] } }, "document": { "cpf": { "number": "string", "customFields": [ { "field": "string", "value": "string", "valueList": [ "string" ] } ] }, "pis": { "number": "string", "issueDate": "2022-02-08", "customFields": [ { "field": "string", "value": "string", "valueList": [ "string" ] } ] }, "ctps": { "number": "string", "serie": "string", "digit": "string", "issuerState": "string", "issueDate": "2022-02-08", "customFields": [ { "field": "string", "value": "string", "valueList": [ "string" ] } ] }, "rg": { "number": "string", "issuer": "string", "issuerState": "string", "issueDate": "2022-02-08", "customFields": [ { "field": "string", "value": "string", "valueList": [ "string" ] } ] }, "passport": { "number": "string", "issuer": "string", "issueDate": "2022-02-08", "expiryDate": "2022-02-08", "issuerCountry": "string", "issuerState": "string", "customFields": [ { "field": "string", "value": "string", "valueList": [ "string" ] } ] }, "ric": { "number": "string", "issuer": "string", "issuerCity": "string", "issuerState": "string", "issueDate": "2022-02-08", "expiryDate": "2022-02-08", "customFields": [ { "field": "string", "value": "string", "valueList": [ "string" ] } ] }, "voter": { "number": "string", "votingDistrict": "string", "votingSection": "string", "issueDate": "2022-02-08", "issuerCity": "string", "issuerState": "string", "customFields": [ { "field": "string", "value": "string", "valueList": [ "string" ] } ] }, "cnh": { "number": "string", "category": "string", "issuer": "string", "issuerState": "string", "issueDate": "2022-02-08", "expiryDate": "2022-02-08", "firstDriverLicenseDate": "2022-02-08", "customFields": [ { "field": "string", "value": "string", "valueList": [ "string" ] } ] }, "reservist": { "number": "string", "serie": "string", "ra": "string", "exemptionDate": "2022-02-08", "hasCertificate": true, "customFields": [ { "field": "string", "value": "string", "valueList": [ "string" ] } ] }, "civilCertificate": { "type": "string", "issueDate": "2022-02-08", "registry": "string", "term": "string", "book": "string", "sheet": "string", "notaryOffice": "string", "issuerCity": "string", "issuerState": "string", "customFields": [ { "field": "string", "value": "string", "valueList": [ "string" ] } ] }, "cns": { "number": "string", "customFields": [ { "field": "string", "value": "string", "valueList": [ "string" ] } ] }, "dnv": { "number": "string", "customFields": [ { "field": "string", "value": "string", "valueList": [ "string" ] } ] }, "bankAccount": { "bank": "string", "branch": 0, "accountType": "string", "bankAccount": "string", "digit": "string", "customFields": [ { "field": "string", "value": "string", "valueList": [ "string" ] } ] }, "receiveSalaryAdvance": "string" }, "dependents": [ { "fullName": "string", "degreeOfKinship": "string", "gender": "string", "birthDate": "2022-02-08", "mothersName": "string", "maritalStatus": "string", "declareIncomeTax": "string", "cpf": { "number": "string", "customFields": [ { "field": "string", "value": "string", "valueList": [ "string" ] } ] }, "rg": { "number": "string", "issuer": "string", "issuerState": "string", "issueDate": "2022-02-08", "customFields": [ { "field": "string", "value": "string", "valueList": [ "string" ] } ] }, "ric": { "number": "string", "issuer": "string", "issuerCity": "string", "issuerState": "string", "issueDate": "2022-02-08", "expiryDate": "2022-02-08", "customFields": [ { "field": "string", "value": "string", "valueList": [ "string" ] } ] }, "sus": { "number": "string", "customFields": [ { "field": "string", "value": "string", "valueList": [ "string" ] } ] }, "vaccinationBooklet": { "customFields": [ { "field": "string", "value": "string", "valueList": [ "string" ] } ] }, "proofOfEnrollment": { "customFields": [ { "field": "string", "value": "string", "valueList": [ "string" ] } ] }, "deathCertificate": { "type": "string", "issueDate": "2022-02-08", "registry": "string", "term": "string", "book": "string", "sheet": "string", "notaryOffice": "string", "issuerCity": "string", "issuerState": "string", "customFields": [ { "field": "string", "value": "string", "valueList": [ "string" ] } ] }, "birthCertificate": { "type": "string", "issueDate": "2022-02-08", "registry": "string", "term": "string", "book": "string", "sheet": "string", "notaryOffice": "string", "issuerCity": "string", "issuerState": "string", "customFields": [ { "field": "string", "value": "string", "valueList": [ "string" ] } ] }, "customFields": [ { "field": "string", "value": "string", "valueList": [ "string" ] } ] } ] } ] } }