Ver sitio web completo

Observación: Esta página fue traducida utilizando recursos de automatización con el propósito de entregar contenido en su idioma de manera más rápida. Consecuentemente, ella puede tener errores gramaticales y situaciones similares. Si el contenido no es útil en este estado, en el pié de página usted puede acceder al material original en Portugués Brasileño y también dar opiniones sobre esta traducción.
Gestión del Capital Humano - senior X - Manual del Usuario > Admisión Digital > Integraciones > Integración a través de API > Búsqueda de detalles de varios registros (Consultas)

Búsqueda de detalles de varios registros (Consultas): API Admissão Digital

Las consultas devuelven datos básicos de diferentes tipos de registros y registros en la base de datos, tales como: empresas, países, estados y ciudades.

Esta documentación enumera las consultas que están disponibles en las API de Admissão Digital .

URL

POST <url_plataforma> /t/senior.com.br/bridge/1.0/rest/hcm/onboarding/actions/ <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

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 .

consulta de lista de países

Devuelve la información básica del registro del país.

Parámetros (opcional):

Nombre Tipo Descripción
tamaño Entero Tamaño de página.
compensar Entero Indicador de la página actual.
filtrar Cadena Filtro a aplicar en la búsqueda, según el nombre del modelo.

Respuestas:

Código Descripción Campos de respuesta
200 DE ACUERDO
Campo Tipo Descripción
elementos totales Entero Total de registros encontrados.
totalPáginas Entero Total de páginas encontradas.
contenido { } Lista de países.
  identificación Cadena Identificador de país.
  nombre Cadena Nombre del país.
  abreviatura Cadena Abreviatura del nombre del país.
  creado por Cadena  
  fecha de creación Cadena  
  último modificado por Cadena  
  última fecha de modificación Cadena  
401 Credenciales no válidas   -
por defecto Respuesta de error
Campo Tipo Descripción
mensaje Cadena Mensaje que describe el error.
razón Cadena Un código que representa la categoría de la causa del error.
ClosedRespuesta de ejemplo (200): 
  { "totalElements": 0, "totalPages": 0, "contents": [ { "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "nombre: "cadena", "abreviatura": "cadena", "createdBy": "string", "createdDate": "2022-02-07T17:04:25.021Z", "lastModifiedBy": "string", "lastModifiedDate": "2022-02-07T17:04:25.021Z" } ] }
ClosedRespuesta de ejemplo (predeterminada): 
  { "mensaje": "cadena", "motivo": "BAD_REQUEST" }

consulta de lista de estados

Devuelve información básica del registro de estados/unidades federativas.

Parámetros (opcional):

Nombre Tipo Descripción
tamaño Entero Tamaño de página.
compensar Entero Indicador de la página actual.
filtrar Cadena Filtro a aplicar en la búsqueda, según el nombre del modelo.

Respuestas:

Código Descripción Campos de respuesta
200 DE ACUERDO
Campo Tipo Descripción
elementos totales Entero Total de registros encontrados.
totalPáginas Entero Total de páginas encontradas.
contenido { } Lista de estados/unidades federativas.
  identificación Cadena Identificador de estado.
  nombre Cadena Nombre del estado.
  abreviatura Cadena Abreviatura del nombre del estado.
  país Cadena País al que pertenece el estado.
  creado por Cadena  
  fecha de creación Cadena  
  último modificado por Cadena  
  última fecha de modificación Cadena  
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.
ClosedRespuesta de ejemplo (200): 
  { "totalElements": 0, "totalPages": 0, "contents": [ { "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "nombre: "cadena", "abreviatura": "cadena", "country": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "createdBy": "string", "createdDate": "2022-02-07T17:04:25.021Z", "lastModifiedBy": "string", " lastModifiedDate": "2022-02-07T17:04:25.021Z" } ] }
ClosedRespuesta de ejemplo (predeterminada): 
  { "mensaje": "cadena", "motivo": "BAD_REQUEST" }

ciudadListQuery

Devuelve información básica del registro de la ciudad.

Parámetros (opcional):

Nombre Tipo Descripción
tamaño Entero Tamaño de página.
compensar Entero Indicador de la página actual.
filtrar Cadena Filtro a aplicar en la búsqueda, según el nombre del modelo.

Respuestas:

Código Descripción Campos de respuesta
200 DE ACUERDO
Campo Tipo Descripción
elementos totales Entero Total de registros encontrados.
totalPáginas Entero Total de páginas encontradas.
contenido { } Lista de ciudades.
  identificación Cadena Identificador de ciudad.
  nombre Cadena Nombre de la ciudad.
  estado Cadena Estado al que pertenece la ciudad.
  creado por Cadena  
  fecha de creación Cadena  
  último modificado por Cadena  
  última fecha de modificación Cadena  
401 Credenciales no válidas   -
por defecto Respuesta de error
Campo Tipo Descripción
mensaje Cadena Mensaje que describe el error.
razón Cadena Un código que representa la categoría de la causa del error.
ClosedRespuesta de ejemplo (200): 
  { "totalElements": 0, "totalPages": 0, "contents": [ { "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "nombre: "cadena", "estado": "3fa85f64-5717 -4562-b3fc-2c963f66afa6", "createdBy": "string", "createdDate": "2022-02-07T17:04:25.021Z", "lastModifiedBy": "string", "lastModifiedDate": "2022-02- 07T17:04:25.021Z" } ] }
ClosedRespuesta de ejemplo (predeterminada): 
  { "mensaje": "cadena", "motivo": "BAD_REQUEST" }

nacionalidadListQuery

Devuelve la información básica del registro de nacionalidad.

Parámetros (opcional):

Nombre Tipo Descripción
tamaño Entero Tamaño de página.
compensar Entero Indicador de la página actual.
filtrar Cadena Filtro a aplicar en la búsqueda, según el nombre del modelo.

Respuestas:

Código Descripción Campos de respuesta
200 DE ACUERDO
Campo Tipo Descripción
elementos totales Entero Total de registros encontrados.
totalPáginas Entero Total de páginas encontradas.
contenido { } Lista de nacionalidades.
  identificación Cadena Identificador de nacionalidad.
  código Entero Código de nacionalidad.
  nombre Cadena Nombre de la nacionalidad.
  tipo Cadena

Tipo de nacionalidad.

ClosedValores posibles:
  • BRAZILIAN = brasileño
  • OTHER = Otro
  creado por Cadena  
  fecha de creación Cadena  
  último modificado por Cadena  
  última fecha de modificación Cadena  
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.
ClosedRespuesta de ejemplo (200): 
  { "totalElements": 0, "totalPages": 0, "contents": [ { "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "code": 0, "name: "string", "type ": "BRASILEÑO", "createdBy": "string", "createdDate": "2022-02-07T17:04:25.021Z", "lastModifiedBy": "string", "lastModifiedDate": "2022-02-07T17: 04:25.021Z" } ] }
ClosedRespuesta de ejemplo (predeterminada): 
  { "mensaje": "cadena", "motivo": "BAD_REQUEST" }

religiónListaConsulta

Devuelve la información básica del registro de religión.

Parámetros (opcional):

Nombre Tipo Descripción
tamaño Entero Tamaño de página.
compensar Entero Indicador de la página actual.
filtrar Cadena Filtro a aplicar a la búsqueda, según el nombre del modelo.

Respuestas:

Código Descripción Campos de respuesta
200 DE ACUERDO
Campo Tipo Descripción
elementos totales Entero Total de registros encontrados.
totalPáginas Entero Total de páginas encontradas.
contenido { } Relación de religiones.
  identificación Cadena Identificador de religión.
  código Entero Código de religión.
  nombre Cadena Descripción de la religión.
  creado por Cadena  
  fecha de creación Cadena  
  último modificado por Cadena  
  última fecha de modificación Cadena  
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.
ClosedRespuesta de ejemplo (200): 
  { "totalElements": 0, "totalPages": 0, "contents": [ { "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "code": 0, "name: "string", "createdBy ": "cadena", "createdDate": "2022-02-07T17:04:25.021Z", "lastModifiedBy": "cadena", "lastModifiedDate": "2022-02-07T17:04:25.021Z" } ] }
ClosedRespuesta de ejemplo (predeterminada): 
  { "mensaje": "cadena", "motivo": "BAD_REQUEST" }

consulta de lista de bancos

Devuelve información básica de registro bancario.

Parámetros (opcional):

Nombre Tipo Descripción
tamaño Entero Tamaño de página.
compensar Entero Indicador de la página actual.
filtrar Cadena Filtro a aplicar en la búsqueda, según el nombre del modelo.

Respuestas:

Código Descripción Campos de respuesta
200 DE ACUERDO
Campo Tipo Descripción
elementos totales Entero Total de registros encontrados.
totalPáginas Entero Total de páginas encontradas.
contenido { } Relación de bancos.
  identificación Cadena Identificador del banco.
  código Entero Número de banco.
  nombre Cadena Descripción del banco.
  creado por Cadena  
  fecha de creación Cadena  
  último modificado por Cadena  
  última fecha de modificación Cadena  
401 Credenciales no válidas   -
por defecto Respuesta de error
Campo Tipo Descripción
mensaje Cadena Mensaje que describe el error.
razón Cadena Un código que representa la categoría de la causa del error.
ClosedRespuesta de ejemplo (200): 
  { "totalElements": 0, "totalPages": 0, "contents": [ { "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "code": 0, "name: "string", "createdBy ": "cadena", "createdDate": "2022-02-07T17:04:25.021Z", "lastModifiedBy": "cadena", "lastModifiedDate": "2022-02-07T17:04:25.021Z" } ] }
ClosedRespuesta de ejemplo (predeterminada): 
  { "mensaje": "cadena", "motivo": "BAD_REQUEST" }

gradoDeEducaciónListQuery

Devuelve la información básica del registro del nivel educativo.

Parámetros (opcional):

Nombre Tipo Descripción
tamaño Entero Tamaño de página.
compensar Entero Indicador de la página actual.
filtrar Cadena Filtro a aplicar a la búsqueda, según el nombre del modelo.

Respuestas:

Código Descripción Campos de respuesta
200 DE ACUERDO
Campo Tipo Descripción
elementos totales Entero Total de registros encontrados.
totalPáginas Entero Total de páginas encontradas.
contenido { } Lista de niveles educativos.
  identificación Cadena Identificador único de nivel educativo.
  código Entero Código de nivel educativo.
  nombre Cadena Nombre del nivel educativo.
  tipo Cadena

Tipo de nivel educativo.

ClosedValores posibles:
  • ILLITERATE = 01 - Analfabetos, incluidos aquellos que, a pesar de haber recibido educación, no se alfabetizaron
  • ELEMENTARY_SCHOOL_INCOMPLETE = 02 - Escuela Primaria Incompleta
  • ELEMENTARY_SCHOOL_COMPLETE = 03 - 5to año completo de Primaria
  • MIDDLE_SCHOOL_INCOMPLETE = 04 - Del 6º al 9º año de primaria incompleta (antes del 5º al 8º grado)
  • MIDDLE_SCHOOL_COMPLETED = 05 - Escuela primaria completa
  • HIGH_SCHOOL_INCOMPLETE = 06 - Bachillerato incompleto
  • HIGH_SCHOOL_COMPLETED = 07 - Secundaria completa
  • HIGHER_INCOMPLETE = 08 - Educación Superior Incompleta
  • HIGHER_COMPLETED = 09 - Educación superior completada
  • POST_GRADUATED = 10 - Postgrado completado
  • MASTER = 11 - Máster completo
  • DOCTORAL = 12 - Doctorado completado
  creado por Cadena  
  fecha de creación Cadena  
  último modificado por Cadena  
  última fecha de modificación Cadena  
401 Credenciales no válidas   -
por defecto Respuesta de error
Campo Tipo Descripción
mensaje Cadena Mensaje que describe el error.
razón Cadena Un código que representa la categoría de la causa del error.
ClosedRespuesta de ejemplo (200): 
  { "totalElements": 0, "totalPages": 0, "contents": [ { "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "code": 0, "name: "string", "type ": "ANalfabetos", "createdBy": "string", "createdDate": "2022-02-07T17:04:25.021Z", "lastModifiedBy": "string", "lastModifiedDate": "2022-02-07T17: 04:25.021Z" } ] }
ClosedRespuesta de ejemplo (predeterminada): 
  { "mensaje": "cadena", "motivo": "BAD_REQUEST" }

empresaListQuery

Devuelve la información básica del registro de la empresa.

Parámetros (opcional):

Nombre Tipo Descripción
tamaño Entero Tamaño de página.
compensar Entero Indicador de la página actual.
filtrar Cadena Filtro a aplicar a la búsqueda, según el nombre del modelo.

Respuestas:

Código Descripción Campos de respuesta
200 DE ACUERDO
Campo Tipo Descripción
elementos totales Entero Total de registros encontrados.
totalPáginas Entero Total de páginas encontradas.
contenido { } Relación de empresas.
  identificación Cadena Identificador de la empresa.
  nombre de empresa Cadena Nombre de empresa.
  código Cadena Código de empresa externo.
  activado Cadena

Indicativo de si la empresa está activa o no.

ClosedValores posibles:
  • ACTIVE = Activo
  • INACTIVE = Inactivo
  sucursal { } Sucursales de la empresa.
    identificación Cadena Identificador de registro único.
    compañía { } - Establecimiento principal.
    sucursalNombreOficina Cadena Razón social.
    nombre comercial Cadena Nombre comercial.
    activado Cadena

Indica si la sucursal está activa o no.

ClosedValores posibles:
  • ACTIVE = Activo
  • INACTIVE = Inactivo
    código Cadena Código del sistema externo.
    creado por Cadena  
    fecha de creación Cadena  
    último modificado por Cadena  
    última fecha de modificación Cadena  
  creado por Cadena  
  fecha de creación Cadena  
  último modificado por Cadena  
  última fecha de modificación Cadena  
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.
ClosedRespuesta de ejemplo (200): 
  { "totalElements": 0, "totalPages": 0, "contents": [ { "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "companyName": "string", "code: "string", "enabled": "ACTIVE", "branchOffice": [ { "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "company": {}, "branchOfficeName": "string", "tradingName": " string", "enabled": "ACTIVE", "code": "string", "createdBy": "string", "createdDate": "2022-02-07T17:04:25.021Z", "lastModifiedBy": "string ", "lastModifiedDate": "2022-02-07T17:04:25.021Z" } ], "createdBy: "string", "createdDate: "2022-02-07T17:04:25.021Z", "lastModifiedBy: "string" , "lastModifiedDate: "2022-02-07T17:04:25.021Z", } ] }
ClosedRespuesta de ejemplo (predeterminada): 
  { "mensaje": "cadena", "motivo": "BAD_REQUEST" }

empresaConsulta

Devuelve una lista de empresas existentes.

Parámetros:

* Obligatorio

Nombre Tipo Descripción
tamaño * Entero Tamaño de página.
compensar * Entero Indicador de la página actual.
filtro * Cadena Filtro a aplicar en la búsqueda, según el nombre del modelo.

Respuestas:

Código Descripción Campos de respuesta
200 DE ACUERDO
Campo Tipo Descripción
resultado { } Relación de empresas.
  identificación Cadena Identificador único de la empresa.
  nombre de empresa Cadena Nombre de empresa.
  código Cadena Código del sistema externo.
401 Credenciales no válidas   -
por defecto Respuesta de error
Campo Tipo Descripción
mensaje Cadena Mensaje que describe el error.
razón Cadena Un código que representa la categoría de la causa del error.
ClosedRespuesta de ejemplo (200): 
  { "resultado": [ { "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "nombreempresa": "SISTEMAS SUPERIORES", "código": "1234" } ] }
ClosedRespuesta de ejemplo (predeterminada): 
  { "mensaje": "cadena", "motivo": "BAD_REQUEST" }

ramaOficinaListQuery

Devuelve información básica de registro de sucursales.

Parámetros (opcional):

Nombre Tipo Descripción
tamaño Entero Tamaño de página.
compensar Entero Indicador de la página actual.
filtrar Cadena Filtro a aplicar a la búsqueda, según el nombre del modelo.

Respuestas:

Código Descripción Campos de respuesta
200 DE ACUERDO
Campo Tipo Descripción
elementos totales Entero Total de registros encontrados.
totalPáginas Entero Total de páginas encontradas.
contenido { } Relación de empresas.
  identificación Cadena Identificador de registro único.
  compañía { } Establecimiento principal.
    identificación Cadena Identificador de la empresa.
    nombre de empresa Cadena Nombre de empresa.
    código Cadena Código de empresa externo.
    activado Cadena

Indicativo de si la empresa está activa o no.

ClosedValores posibles:
  • ACTIVE = Activo
  • INACTIVE = Inactivo
    sucursal { } - Sucursales.
    creado por Cadena  
    fecha de creación Cadena  
    último modificado por Cadena  
    última fecha de modificación Cadena  
  sucursalNombreOficina Cadena Razón social.
  nombre comercial Cadena Nombre comercial.
  activado Cadena

Indica si la sucursal está activa o no.

ClosedValores posibles:
  • ACTIVE = Activo
  • INACTIVE = Inactivo
  código Cadena Código del sistema externo.
  creado por Cadena  
  fecha de creación Cadena  
  último modificado por Cadena  
  última fecha de modificación Cadena  
401 Credenciales no válidas   -
por defecto Respuesta de error
Campo Tipo Descripción
mensaje Cadena Mensaje que describe el error.
razón Cadena Un código que representa la categoría de la causa del error.
ClosedRespuesta de ejemplo (200): 
  { "totalElements": 0, "totalPages": 0, "contents": [ { "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "company": { "id": "3fa85f64-5717-4562 -b3fc-2c963f66afa6", "companyName": "string", "code": "string", "enabled": "ACTIVE", "branchOffice": [ {} ], "createdBy": "string", "createdDate" : "2022-02-07T17:04:25.021Z", "lastModifiedBy": "string", "lastModifiedDate": "2022-02-07T17:04:25.021Z" }, "branchOfficeName": "string", "tradingName" ": "cadena", "enabled": "ACTIVO", "código" : "cadena", "createdBy: "cadena", "createdDate: "2022-02-07T17:04:25.021Z", "lastModifiedBy: "cadena ", "lastModifiedDate: "2022-02-07T17:04:25.021Z", } ] }
ClosedRespuesta de ejemplo (predeterminada): 
  { "mensaje": "cadena", "motivo": "BAD_REQUEST" }

sucursalOficinaConsulta

Devuelve una lista de sucursales existentes.

Parámetros:

* Obligatorio

Nombre Tipo Descripción
tamaño * Entero Tamaño de página.
compensar * Entero Indicador de la página actual.
filtro * Cadena Filtro a aplicar a la búsqueda, según el nombre del modelo.
compañía * Cadena

Identificador (ID) de la empresa vinculada a las sucursales.

Para obtener identificadores de empresa, puede realizar una solicitud al punto final companyListQuery .

Respuestas:

Código Descripción Campos de respuesta
200 DE ACUERDO
Campo Tipo Descripción
resultado { } Lista de sucursales.
  identificación Cadena Identificador único de sucursal.
  sucursalNombreOficina Cadena Razón social.
  nombre comercial Cadena Nombre comercial.
  código Cadena Código del sistema externo.
401 Credenciales no válidas   -
por defecto Respuesta de error
Campo Tipo Descripción
mensaje Cadena Mensaje que describe el error.
razón Cadena Un código que representa la categoría de la causa del error.
ClosedRespuesta de ejemplo (200): 
  { "resultado": [ { "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "branchOfficeName": "SENIOR SISTEMAS S/A", "tradingName": "SENIOR SISTEMAS", "code" : "1234 " } ] }
ClosedRespuesta de ejemplo (predeterminada):

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

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

consulta de lista de posiciones de trabajo

Devuelve la información básica del registro de empleo.

Parámetros (opcional):

Nombre Tipo Descripción
tamaño Entero Tamaño de página.
compensar Entero Indicador de la página actual.
filtrar Cadena Filtro a aplicar a la búsqueda, según el nombre del modelo.

Respuestas:

Código Descripción Campos de respuesta
200 DE ACUERDO
Campo Tipo Descripción
elementos totales Entero Total de registros encontrados.
totalPáginas Entero Total de páginas encontradas.
contenido { } Lista de puestos.
  identificación Cadena Identificador de registro único.
  nombre Cadena Nombre del puesto.
  activado Cadena

Indica si la posición está activa o no.

ClosedValores posibles:
  • ACTIVE = Activo
  • INACTIVE = Inactivo
  código Cadena Código externo.
  creado por Cadena  
  fecha de creación Cadena  
  último modificado por Cadena  
  última fecha de modificación Cadena  
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.
ClosedRespuesta de ejemplo (200): 
  { "totalElements": 0, "totalPages": 0, "contents": [ { "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "name: "string", "enabled": "ACTIVE", "code": "string", "createdBy": "string", "createdDate": "2022-02-07T17:04:25.021Z", "lastModifiedBy": "string", "lastModifiedDate": "2022-02- 07T17:04:25.021Z" } ] }
ClosedRespuesta de ejemplo (predeterminada): 
  { "mensaje": "cadena", "motivo": "BAD_REQUEST" }

consulta de posición de trabajo

Devuelve una lista de puestos existentes.

Parámetros:

* Obligatorio

Nombre Tipo Descripción
tamaño * Entero Tamaño de página.
compensar * Entero Indicador de la página actual.
filtro * Cadena Filtro a aplicar a la búsqueda, según el nombre del modelo.

Respuestas:

Código Descripción Campos de respuesta
200 DE ACUERDO
Campo Tipo Descripción
resultado { } Lista de posiciones.
  identificación Cadena Identificador de registro único.
  nombre Cadena Nombre del puesto.
  código Cadena Código del sistema externo.
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.
ClosedRespuesta de ejemplo (200): 
  { "resultado": [ { "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "nombre": "ANALISTA DE SISTEMAS II", "código": "1234" } ] }
ClosedRespuesta de ejemplo (predeterminada): 
  { "mensaje": "cadena", "motivo": "BAD_REQUEST" }

áreaListQuery

Devuelve una lista de áreas (ubicaciones) existentes en la empresa.

Parámetros:

* Obligatorio

Nombre Tipo Descripción
tamaño * Entero Tamaño de página.
compensar * Entero Indicador de la página actual.
filtro * Cadena Filtro a aplicar a la búsqueda, según el nombre de la zona (ubicación).
compañía Cadena

Identificador de la empresa (ID).

Para obtener identificadores de empresa, puede realizar una solicitud al punto final companyListQuery .

Respuestas:

Código Descripción Campos de respuesta
200 DE ACUERDO
Campo Tipo Descripción
elementos totales Entero Total de registros encontrados.
totalPáginas Entero Total de páginas encontradas.
contenido { } Listado de áreas de la empresa.
  identificación Cadena Identificador de registro único.
  compañía { } Establecimiento principal.
    identificación Cadena Identificador de la empresa.
    nombre de empresa Cadena Nombre de empresa.
    código Cadena Código del sistema externo (empresa).
    activado Cadena

Indicativo de si la empresa está activa o no.

ClosedValores posibles:
  • ACTIVE = Activo
  • INACTIVE = Inactivo
    creado por Cadena Correo electrónico del usuario que creó el registro.
    fecha de creación Cadena Fecha y hora en que se creó el registro.
    último modificado por Cadena Correo electrónico del usuario que realizó la modificación más reciente al registro.
    última fecha de modificación Cadena Fecha y hora en que se realizó la modificación más reciente al registro.
  nombre Cadena Nombre del área de la empresa.
  activado Cadena

Indica si el área está activa o no.

ClosedValores posibles:
  • ACTIVE = Activo
  • INACTIVE = Inactivo
  código Cadena Código del sistema externo (área).
  creado por Cadena Correo electrónico del usuario que creó el registro.
  fecha de creación Cadena Fecha y hora en que se creó el registro.
  último modificado por Cadena Correo electrónico del usuario que realizó la modificación más reciente al registro.
  última fecha de modificación Cadena Fecha y hora en que se realizó la modificación más reciente al registro.
401 Credenciales no válidas   -
por defecto Respuesta de error
Campo Tipo Descripción
mensaje Cadena Mensaje que describe el error.
razón Cadena Un código que representa la categoría de la causa del error.
ClosedRespuesta de ejemplo (200): 
  { "totalElements": 6, "totalPages": 1, "contents": [ { "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "company": { "id": "3fa85f64-5717-4562 -b3fc-2c963f66afa6", "companyName": "EMPRESA EXEMPLO S/A", "code": "1", "enabled": "ACTIVE", "createdBy": "rh@empresa.com.br", "createdDate ": "2023-07-05T15:18:54.1717Z", "lastModifiedBy": "rh@empresa.com.br", "lastModifiedDate": "2023-08-17T12:12:50.407377Z" }, "nombre" : "FINANCIERO", "habilitado": "ACTIVO", "código": "3", "creadoPor": "rh@empresa.com.br", "creadoDate": "2023-07-05T16:41:57.807638Z ", "lastModifiedBy": "rh@empresa.com.br", "lastModifiedDate": "2023-07-05T16:41:57.807638Z" } ] }
ClosedRespuesta 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.

Nombre del filtro tipo esperado Descripción del filtro
tamaño Entero Tamaño de página.
compensar Entero Indicador de la página actual.
filtrar Cadena

Filtro de protocolo de datos abiertos ( OData ) XPlatform que se puede aplicar en la investigación.

Para comprender cómo aplicar este filtro a la solicitud, consulte la documentación del filtro en Senior API Portal .

Ejemplo:

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

Este artigo ajudou você?

Base de Conhecimento

Portal de Exigências Legais

Portal de Documentação

English

Español

Senior Store

Universidade Corporativa

Fórum de Produtos

Trabalhe conosco

Blog

Todos os direitos de cópias reservadas para Senior Sistemas S.A.

A reprodução não autorizada desta publicação, no todo ou em parte, constitui violação dos direitos autorais (Lei 9.610/98).