Integração da suspensão de papel utilizando a API

Documentação de como realizar a integração da suspensão de papel, 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 papel cadastrado no Ronda senior X;
• Possuir uma pessoa vinculada a um papel;
• Passar o token no Header.

Consultar suspensão papel

• Chame o serviço GET /person/role/suspension/{id} para consultar as suspensões de papel que a pessoa possui;
• No postman, o id do vínculo entre a pessoa e o papel deve ser passado por parâmetro na URL: https://sam-api.senior.com.br/api/v1/person/role/suspension/{codigoPessoaPapel}

Cadastrar uma suspensão de papel

• Chame o serviço GET /person/role/suspension/{id} para consultar as suspensões de papel da pessoa.

Para salvar a suspensão do papel:

• Chame o serviço POST /person/role/suspension;
• Passe no Body o JSON;
• Monte o JSON com os dados da suspensão. O id do vínculo da pessoa/papel e a data de início são dados obrigatórios. A data do fim e a justificativa são dados opcionais.

Exemplos

Exemplo do Json:

{
  "id": 0,
  "personRoleId": 39,
  "startDate": "2017-03-24T20:03:00-03:00",
  "endDate": "2017-03-24T21:03:00-03:00",
  "justification": "Teste"
}

Exemplo do Json retornado (status 200):

{
  "id": 6,
  "personRoleId": 39,
  "startDate": "2017-03-24T23:03:00Z",
  "endDate": "2017-03-25T00:03:59Z",
  "justification": "Teste"
}

Excluir suspensão do papel

• Chame o serviço DELETE /person/role/suspension/{id};
• No postman, o id da suspensão deve ser passado por parâmetro na URL: https://sam-api.senior.com.br/api/v1/person/role/{codigoSuspensao}

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

Alterar a suspensão do papel

• Chame o serviço PUT /person/role/suspension;
• Passe no body o JSON modificado.

Exemplo do Json

{
"id": 9,
"personRoleId": 39,
"startDate": "2017-03-24T17:46:00-03:00",
"endDate": "2017-03-25T21:45:00-03:00",
"justification": "Teste"
}

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

Informações dos serviços

GET /person/role/suspension/{id}

Implementation Notes

Return all the suspensions for association between person and role

Response Class (Status 200)

Return all the suspensions for association between person and role

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

Parameters

Parameter	Description	Parameter Type	Data Type
token	Authentication token	header	string
id	Id of association between person and role	path	long

Response Messages

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

POST /person/role/suspension

Implementation Notes

Suspend association between person and role

Parameters

Parameter	Description	Parameter Type	Data Type
token	Authentication token	header	string
personRoleSuspension	Suspension for person with role association	body	{   "id": 0,   "personRoleId": 0,   "startDate": "string",   "endDate": "string",    "justification": "string" }

Response Messages

HTTP Status Code	Reason	Response Model
200	Association between person and role suspended
401	Token is invalid or expired
403	Operation denied
500	Server error	{   "code": 0,   "message": "string" }

DELETE /person/role/suspension/{id}

Implementation Notes

Delete suspension for association between person and role

Parameters

Parameter	Description	Parameter Type	Data Type
token	Authentication token	header	string
id	Id of a personRoleSuspension	path	long

Response Messages

HTTP Status Code	Reason	Response Model
200	Suspension for association between person and role deleted
401	Token is invalid or expired
403	Operation denied
404	Person not found
500	Server error	{   "code": 0,   "message": "string" }

PUT /person/role/suspension

Implementation Notes

Update suspensions for association between person and role

Parameters

Parameter	Description	Parameter Type	Data Type
token	Authentication token	header	string
personRoleSuspension	Suspension for person with role association	path	long

Response Messages

HTTP Status Code	Reason	Response Model
200	Suspension for person with role association updated
401	Token is invalid or expired
403	Operation denied
500	Server error	{   "code": 0,   "message": "string" }