Ronda sénior X - Manual de usuario> Integraciones> Integraciones con otros sistemas> Integrar suspensión de papel

Integración de la suspensión de papel utilizando la API

Documentación sobre cómo integrar la suspensión de papel utilizando la API Ronda senior X.

Pré-requisitos generales

Estar autenticado en Ronda X senior;
Tener una persona registrada en Ronda senior X;
Tener un rol registrado en Ronda senior X;
Poseer una persona vinculada a un papel;
Pase el token en el Header.

Consultar suspensión papel

llame al servicioOBTENER /persona/rol/suspensión/{id} consultar las suspensiones de papeles que tenga la persona;
En el postman, el id de vínculo entre la persona y el papel debe ser pasado por parámetro en la URL: https://sam-api.senior.com.br/api/v1/person/role/suspension/{codigoPessoaPapel}

Registrar una suspensión de papel

llame al servicioOBTENER /persona/rol/suspensión/{id} para comprobar las suspensiones de roles de la persona.

Para guardar la suspensión del papel:

llame al servicioPOST /persona/rol/suspensión;
Pase el JSON en el Cuerpo;
Ensamble el JSON con los datos de suspensión. El id del vínculo de la persona/papel y la fecha de inicio son datos obligatorios. La fecha del fin y la justificación son datos opcionales.

Observación

Los datos dataInicio y dataFim deben poseer la siguiente formatación: "2017-03-24T10:09:00-03:00".

Excluir suspensión del papel

llame al servicioBORRAR /persona/rol/suspensión/{id};
En el postman, el id de la suspensión debe ser pasado por parámetro en la URL: https://sam-api.senior.com.br/api/v1/person/role/{codigoSuspensao}

Si el retorno del servicio es exitoso (HTTP 200), no habrá JSON de retorno.

Alterar la suspensión del papel

llame al servicioPUT /persona/rol/suspensión;
Pase el JSON modificado en el cuerpo.

Si el servicio regresa exitosamente (HTTP 200), no se devolverá ningún JSON.

Informaciones de los servicios

GET /person/role/suspension/{id}

Notas de Implementación

Devolver todas las suspensiones para asociaciones entre persona y papel

Response Class (Status 200)

Devolver todas las suspensiones para asociaciones entre persona y papel

[
{
"roleId": 0,
"roleName": "string",
"personRoleSuspensionId": 0,
"startDate": "string",
"endDate": "string",
"justification": "string"
}
]

Parámetros

Parámetros	Descripción	Tipo Parámetro	Tipo Fecha
token	Autenticación token	header	string
id	Id de asociación entre la persona y el papel	path	long

Mensajes de Respuesta

HTTP Código Estado	Razón	Modelo de Respuesta
401	Token es inválido o expirado
404	Persona y papel asociado no encontrado
500	Error de Servidor	{ "code": 0, "message": "string" }

POST /person/role/suspension

Notas de Implementación

Suspender asociación entre persona y papel

Parámetros

Parámetros	Descripción	Tipo Parámetro	Tipo Fecha
token	Autenticación token	header	string
ID de una suspensión de papel y persona	Suspensión de persona con papel asociado	body	{ "id": 0, "personRoleId": 0, "startDate": "string", "endDate": "string", "justification": "string" }

Mensajes de Respuesta

HTTP Código Estado	Razón	Modelo de Respuesta
200	Asociación entre persona y papel suspendido
401	Token es inválido o expirado
403	Operación denegada
500	Error de Servidor	{ "code": 0, "message": "string" }

DELETE /person/role/suspension/{id}

Notas de Implementación

Borrar suspensión de asociación entre persona y papel

Parámetros

Parámetros	Descripción	Tipo Parámetro	Tipo Fecha
token	Autenticación token	header	string
id	ID de una suspensión de papel y persona	path	long

Mensajes de Respuesta

HTTP Código Estado	Razón	Modelo de Respuesta
200	Suspensión para asociación entre persona y papel borrado
401	Token es inválido o expirado
403	Operación denegada
404	Persona no encontrada
500	Error de Servidor	{ "code": 0, "message": "string" }

PUT /person/role/suspension

Notas de Implementación

Actualiza suspensiones para asociación entre persona y papel

Parámetros

Parámetros	Descripción	Tipo Parámetro	Tipo Fecha
token	Autenticación token	header	string
ID de una suspensión de papel y persona	Suspensión de persona con papel asociado	path	long

Mensajes de Respuesta

HTTP Código Estado	Razón	Modelo de Respuesta
200	Suspensión por persona con papel asociado actualizado
401	Token es inválido o expirado
403	Operación denegada
500	Error de Servidor	{ "code": 0, "message": "string" }