Integração de vínculo entre pessoa e agrupador utilizando a API

Documentação de como realizar a integração de vínculo entre pessoa e agrupador, utilizando a API do Ronda senior X.

Pré-requisitos gerais

• Estar autenticado no Ronda senior X;
• Possuir uma pessoa cadastrada no Ronda senior X;
• Possuir um grupo cadastrado no Ronda senior X;
• Passar o token no Header.

Consultar vínculo entre pessoa e agrupador

• Chame o serviço GET /person/{personId}/group para consultar os grupos dos quais a pessoa faz parte;
• No postman, o id da pessoa deve ser passado por parâmetro na URL: https://sam-api.senior.com.br/api/v1/person/{codigoPessoa}/group

Cadastrar uma associação entre pessoa e agrupador

• Chame o serviço GET /group/search para pesquisa autocomplete dos grupos;
• No postman, o term deve ser passado por parâmetro: https://sam-api.senior.com.br/api/v1/group/search?term=grupo

Para Salvar o vínculo da pessoa com o agrupador:

• Chame o serviço POST /group/{id}/person/{personId};
• No postman, o id do grupo e o id da pessoa devem ser passados por parâmetro: https://sam-api.senior.com.br/api/v1/group/{codigoGrupo}/person/{codigoPessoa}

Se o retorno do serviço tiver êxito (HTTP 200), não haverá JSON de retorno.

Excluir vínculo entre pessoa e agrupador

• Chame o serviço DELETE /group/{id}/person/{personId};
• No postman, o id do grupo e o id da pessoa devem ser passados por parâmetro: https://sam-api.senior.com.br/api/v1/group/{codigoGrupo}/person/{codigoPessoa}.

Se o retorno do serviço tiver sucesso (HTTP 200), não haverá JSON de retorno.

Informações dos serviços

GET person/{personId}/group

Implementation Notes

Return all the groups from person

Response Class (Status 200)

All the groups from person

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

Parameters

Parameter	Description	Parameter Type	Data Type
token	Authentication token	header	string
personId	Person Id	path	string

Response Messages

HTTP Status Code	Reason	Response Model
401	Token is invalid or expired
404	Person not found
500	Server error	{   "code": 0,   "message": "string" }

GET group/search

Implementation Notes

Auto complete search to group

Response Class (Status 200)

A array of basic info from group limited by 10 retults

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

Parameters

Parameter	Description	Parameter Type	Data Type
token	Authentication token	header	string
term	Term of group name	query	string

Response Messages

HTTP Status Code	Reason	Response Model
401	Token is invalid or expired
500	Server error	{   "code": 0,   "message": "string" }

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

Implementation Notes

Add a person to the group

Parameters

Parameter	Description	Parameter Type	Data Type
token	Authentication token	header	string
id	Id of Group	path	long
personId	Id of person	path	long

Response Messages

HTTP Status Code	Reason	Response Model
200	Person added with success
401	Token is invalid or expired
403	Operation denied
404	Person not found
500	Server error	{   "code": 0,   "message": "string" }

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

Implementation Notes

Delete a person from group

Parameters

Parameter	Description	Parameter Type	Data Type
token	Authentication token	header	string
id	Id of group	path	long
personId	Id of person	path	long

Response Messages

HTTP Status Code	Reason	Response Model
200	Person removed with success
401	Token is invalid or expired
403	Operation denied
404	Person not found
500	Server error	{   "code": 0,   "message": "string" }