Buscar plantillas de invitación: API de admisiones digitales
Devuelve las plantillas de invitación a enviar durante las preadmisiones.
Definiciones de API:
- URL
- Encabezamiento
- Parámetros
- Ejemplo
- Respuestas
URL
CORREO<url_plataforma>/t/senior.com.br/bridge/1.0/rest/hcm/onboardingintegration/queries/invitarModelQuery
Reemplazar<url_plataforma>por la URL correspondiente a su entorno. Si es el entorno de producción, reemplácelo con:https://plataforma.senior.com.br
Encabezamiento
| Autorización | Portador<token_acceso> |
|---|---|
| Tipo de contenido | aplicación/json |
Reemplazar<token_acceso>utilizando la clave de acceso obtenida delAPI de autenticación de plataforma.
Parámetros
| Parámetro | Tipo | Descripción |
|---|---|---|
| tamaño | Entero |
Tamaño de página (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. |
| compensar | 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). |
| filtrar | Cadena |
Filtro a aplicar a la búsqueda, según el nombre del modelo. Este es un filtro estándar de plataforma X senior. Para obtener detalles sobre cómo usarlo, consulte elfiltrar documentación en el Portal API para personas mayores. |
Ejemplo
{ "tamaño": "10", "desplazamiento": "0", "filtro": "cadena" }
|
Respuestas
| Código | Descripción | Campos de respuesta | ||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 200 | DE ACUERDO |
|
||||||||||||||||||||||||
| 401 | Credenciales no válidas | - | ||||||||||||||||||||||||
| por defecto | Respuesta de error |
|
||||||||||||||||||||||||
Respuesta de ejemplo (200):
{ "inviteModelData": [ { "modelId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "nombre": "cadena", "país": "cadena", "fecha límite": "cadena", } ] }
|
Respuesta de ejemplo (predeterminada):
{ "mensaje": "cadena", "motivo": "BAD_REQUEST" }
|
Observación
Por defecto, el punto finalinvitarModelQuery aplica el filtro siguiente, lo que hace que devuelva solo los modelos que sonactivo:
enabled eq ACTIVE and containing(lower(name), lower(''))
English
Español
