Ronda sénior X - Manual de usuario> Integraciones> Integraciones con otros sistemas> Integrar vínculo entre persona y papel

Integración de vínculo entre persona y papel utilizando la API

Documentación sobre cómo integrar el vínculo entre persona y rol, utilizando la API Ronda senior X.

Prerrequisitos generales

Estar autenticado en Ronda X senior;
Tener una persona registrada en Ronda senior X;
Tener un rol registrado en Ronda senior X.

Consultar vínculo Persona/Papel

llame al servicioOBTENER /persona/{personaId}/roles consultar los papeles que ya posee la persona;
En el postman, el id de la persona debe ser pasado por parámetro en la URL: https://sam-api.senior.com.br/api/v1/person/{codigoPessoa}/roles

Registrar una asociación entre persona y el papel

llame al servicioOBTENER /persona/{id} consultar a la persona;
En el postman, el id de la persona debe ser pasado por parámetro en la URL: https://sam-api.senior.com.br/api/v1/person/{codigoPessoa}
llame al servicioOBTENER /persona/{personaId}/roles consultar los papeles que la persona ya tiene.

Para guardar el vínculo de la persona con el papel:

llame al servicioPUBLICACIÓN /persona/rol;
Pase el token al encabezado;
Pase el JSON en el Cuerpo;
Ensamble el JSON con los datos del enlace. El id de la persona, el id del papel y la fecha de inicio son datos obligatorios. La fecha del fin es un dato opcional.

Observación

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

Excluir un vínculo de persona y papel

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

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

Alterar el vínculo Persona/Papel

Si la fecha inicio del vínculo del papel a la persona es menor que la fecha y hora actual, sólo es posible alterar la fecha fin del papel.

llame al servicioPUT /persona/rol;
Pase el token al encabezado;
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/{personId}/roles

Notas de Implementación

Return all the roles from person

Respuesta Clase (Estado 200)

Return all the roles from person

[
{
"roleId": 0,
"roleName": "string",
"personRoleId": 0,
"startDate": "string",
"endDate": "string",
"isSuspended": true
}
]

Parameters

Parámetros	Description	Tipo Parámetro	Tipo Fecha
token	Autenticación token	header	string
personId	Id de una persona	path	long

Mensajes de Respuesta

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

GET /person/{id}

Notas de Implementación

Retorna una persona

Response Class (Status 200)

Retorna una persona

{
"id": 0,
"name": "string",
"documents": [
{
"id": 0,
"documentType": {
"id": 0,
"name": "string",
"label": "string",
"mask": "string",
"required": true,
"documentToREP": true
},
"document": "string"
}
],
"emails": [
{
"id": 0,
"preferential": true,
"emailAddress": "string"
}
],
"phones": [
{
"id": 0,
"preferential": true,
"ddi": 0,
"phoneNumber": "string",
"extensionLine": "string"
}
],
"gender": 0,
"birthday": "string",
"registry": "string",
"registerDate": "string",
"lastModificationDate": "string",
"address": "string",
"number": "string",
"district": "string",
"city": "string",
"uf": "string",
"cep": "string",
"nationality": "string",
"lastAccessDate": "string",
"situation": 0,
"hasValidRole": true,
"hasProvisoryRole": true
}

Parameters

Parámetros	Description	Tipo Parámetro	Tipo Fecha
token	Autenticación token	header	string
id	Id de persona	path	long

Mensajes de Respuesta

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

POST /person/role

Notas de Implementación

Persona con Papel

Parameters

Parámetros	Description	Tipo Parámetro	Tipo Fecha
token	Autenticación token	header	string
personaPapel	Persona con papel asociado	body	{ "id": 0, "personId": 0, "roleId": 0, "startDate": "string", "endDate": "string" }

Mensajes de Respuesta

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

DELETE /person/role/{roleId}

Notas de Implementación

Borrado persona y papel unido

Parameters

Parámetros	Description	Tipo Parámetro	Tipo Fecha
token	Autenticación token	header	string
personRoleId	Id de personRole	path	long

Mensajes de Respuesta

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

PUT /person/role

Notas de Implementación

Actualización de unión entre la persona y el papel

Parámetros

Parámetros	Description	Tipo Parámetro	Tipo Fecha
token	Autenticación token	header	string
personaPapel	Persona con papel asociado	body	{ "id": 0, "personId": 0, "roleId": 0, "startDate": "string", "endDate": "string" }

Mensajes de Respuesta

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