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

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

Prerrequisitos generales

• Estar autenticado en Ronda X senior;
• Tener una persona registrada en Ronda senior X;
• Tener un grupo registrado en Ronda senior X;
• Pasar el token en el Header.

Consultar vínculo entre persona y agrupador

• llame al servicioOBTENER /persona/{personaId}/grupo consultar los grupos a los que pertenece 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}/group

Registrar una asociación entre persona y agrupador

• llame al servicioOBTENER /grupo/buscar para búsqueda autocompletada de grupos;
• En el postman, el term debe ser pasado por parámetro: https://sam-api.senior.com.br/api/v1/group/search?term=grupo

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

• llame al servicioENVIAR /grupo/{id}/persona/{personaId};
• En el postman, el id del grupo y el id de la persona deben ser pasados por parámetro: https://sam-api.senior.com.br/api/v1/group/{codigoGrupo}/person/{codigoPessoa}

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

Excluir vínculo entre persona y agrupador

• llame al servicioELIMINAR /grupo/{id}/persona/{personaId};
• En el postman, el id del grupo y el id de la persona deben ser pasados por parámetro: https://sam-api.senior.com.br/api/v1/group/{codigoGrupo}/person/{codigoPessoa}.

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

Informaciones de los servicios

GET person/{personId}/group

Notas de Implementación

Devolver todos los grupos de la persona

Response Class (Status 200)

Todos los grupos de persona

[
{
"id": 0,
"nameWithPath": "string",
"isValidRange": true,
}
]

Parámetros

Parámetros	Descripción	Tipo Parámetro	Tipo Fecha
token	Autenticación token	header	string
personId	Person Id	path	string

Mensajes de Respuesta

HTTP Código Status	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 group/search

Notas de Implementación

Búsqueda completa automática al grupo

Response Class (Estado 200)

Una matriz de información básica de grupo limitada por 10 resultados

[
{
"id": 0,
"nameWithPath": "string",
"isValidRange": true,
}
]

Parámetros

Parámetros	Descripción	Tipo Parámetro	Tipo Fecha
token	Autenticación token	header	string
term	Término del nombre del grupo	query	string

Mensajes de Respuesta

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

POST group/{id}/person/{personId}

Notas de Implementación

Agregar una persona al grupo

Parámetros

Parámetros	Descripción	Tipo Parámetro	Tipo Fecha
token	Autenticación token	header	string
id	Id of Group	path	long
personId	Id de persona	path	long

Mensajes de Respuesta

HTTP Código Status	Razón	Modelo de Respuesta
200	Persona agregada con éxito
401	Token es inválido o expirado
403	Operación denegada
404	Persona no encontrada
500	Error de Servidor	{ "code": 0, "message": "string" }

DELETE /group/{id}/person/{personId}

Notas de Implementación

Elimine a una persona del grupo

Parámetros

Parámetros	Descripción	Tipo Parámetro	Tipo Fecha
token	Autenticación token	header	string
id	Id of group	path	long
personId	Id de persona	path	long

Mensajes de Respuesta

HTTP Código Status	Razón	Modelo de Respuesta
200	Persona eliminada con éxito
401	Token es inválido o expirado
403	Operación denegada
404	Persona no encontrada
500	Error de Servidor	{ "code": 0, "message": "string" }