Ronda senior X - Manual do Usuário > Integrações > Integrações com outros sistemas > Integrar vínculo entre pessoa e papel

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

Documentação de como realizar a integração de vínculo entre pessoa e 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.

Consultar vínculo Pessoa/Papel

Chame o serviço GET /person/{personId}/roles para consultar os papéis que a pessoa já possui;
No postman, o id da pessoa deve ser passado por parâmetro na URL: https://sam-api.senior.com.br/api/v1/person/{codigoPessoa}/roles

Cadastrar uma associação entre pessoa e o papel

Chame o serviço GET /person/{id} para consultar a pessoa;
No postman, o id da pessoa deve ser passado por parâmetro na URL: https://sam-api.senior.com.br/api/v1/person/{codigoPessoa}
Chame o serviço GET /person/{personId}/roles para consultar os papeis que a pessoa já possui.

Para salvar o vínculo da pessoa com o papel:

Chame o serviço POST /person/role;
Passe no Header o token;
Passe no Body o JSON;
Monte o JSON com os dados do vínculo. O id da pessoa, o id do papel e a data de início são dados obrigatórios. A data do fim é um dado opcional.

Observação

Os dados dataInicio e dataFim devem seguir a seguinte formatação: "2017-03-24T10:09:00-03:00".

Excluir um vínculo de pessoa e papel

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

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

Alterar o vínculo Pessoa/Papel

Se a data início do vínculo do papel à pessoa for menor que a data e hora atual, só é possível alterar a data fim do papel.

Chame o serviço PUT /person/role;
Passe no Header o token;
Passe no body o JSON modificado.

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

Informações dos serviços

GET person/{personId}/roles

Implementation Notes

Return all the roles from person

Response Class (Status 200)

Return all the roles from person

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

Parameters

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

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 /person/{id}

Implementation Notes

Return a person

Response Class (Status 200)

Return a person

{

  "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

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

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" }

POST /person/role

Implementation Notes

Join person with role

Parameters

Parameter	Description	Parameter Type	Data Type
token	Authentication token	header	string
personRole	Person with role association	body	{ "id": 0, "personId": 0, "roleId": 0, "startDate": "string", "endDate": "string" }

Response Messages

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

DELETE /person/role/{roleId}

Implementation Notes

Delete join between person and role

Parameters

Parameter	Description	Parameter Type	Data Type
token	Authentication token	header	string
personRoleId	Id of personRole	path	long

Response Messages

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

PUT /person/role

Implementation Notes

Update Join between person and role

Parameters

Parameter	Description	Parameter Type	Data Type
token	Authentication token	header	string
personRole	Person with role association	body	{ "id": 0, "personId": 0, "roleId": 0, "startDate": "string", "endDate": "string" }

Response Messages

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

PORTAL DE DOCUMENTAÇÃO
Ronda senior X