Búsqueda de listas de varios registros (Consultas - listas) — API de Admissão Digital

Las Consultas descritas en esta documentación devuelven el listado de registros de algunos tipos de registros existentes en la base de datos, tales como: empresas, sucursales y puestos.

Esta documentación explica cómo realizar solicitudes de las consultas que están disponibles en las API de Admissão Digital .

• URL
• Encabezamiento
• Consultas :
  • Empresas (companyQuery)
  • Sucursales (branchOfficeQuery)
  • Puestos de trabajo (jobPositionQuery)
• Filtros

URL

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

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

Reemplace <query> con el nombre de una de las consultas siguientes, en referencia al registro que desea buscar con la API.

Encabezamiento

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

áreaConsulta

Devuelve una lista de áreas existentes.

Parámetros:

* Obligatorio

Respuestas:

Respuesta de ejemplo (200):

{ "resultado": [ { "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "nombre": "Área", "código" : "1234" } ] }

Respuesta de ejemplo (predeterminada):

{ "mensaje": "cadena", "motivo": "BAD_REQUEST" }

empresaConsulta

Devuelve una lista de empresas existentes.

Parámetros:

* Obligatorio

Respuestas:

Respuesta de ejemplo (200):

{ "resultado": [ { "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "nombreempresa": "SISTEMAS SUPERIORES", "código": "1234" } ] }

Respuesta de ejemplo (predeterminada):

{ "mensaje": "cadena", "motivo": "BAD_REQUEST" }

sucursalOficinaConsulta

Devuelve una lista de sucursales existentes.

Parámetros:

* Obligatorio

Respuestas:

Respuesta de ejemplo (200):

{ "resultado": [ { "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "branchOfficeName": "SENIOR SISTEMAS S/A", "tradingName": "SENIOR SISTEMAS", "code" : "1234 " } ] }

Respuesta de ejemplo (predeterminada):

Ejemplo de respuesta si el campo empresa no se proporciona en la solicitud:

{ "mensaje": "se requiere empresa", "motivo": "BAD_REQUEST" }

consulta de posición de trabajo

Devuelve una lista de puestos existentes.

Parámetros:

* Obligatorio

Respuestas:

Respuesta de ejemplo (200):

{ "resultado": [ { "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "nombre": "ANALISTA DE SISTEMAS II", "código": "1234" } ] }

Respuesta de ejemplo (predeterminada):

{ "mensaje": "cadena", "motivo": "BAD_REQUEST" }

Filtros adicionales (opcional)

Los filtros que se enumeran a continuación le permiten restringir los resultados devueltos por las consultas. Para utilizar estos filtros, debe concatenarlos en la URL de solicitud.

Ejemplo:

https://platform.senior.com.br/t/senior.com.br/bridge/1.0/rest/hcm/onboardingintegration/queries/jobPositionQuery ?size=10&offset=1&filter=id gt 2 y id lt 5