Retornando Classificações de pessoa
Path: /api/classesPessoas/json
Método: GET
Lista todas as classificações de pessoas do sistema.
JSON Retornado (exemplo):
[
{
"id": -34,
"text": "Administrador"
},
{
"id": -4,
"text": "Advg. Acordo"
}
]
Retornando pessoa por id
Path: /api/pessoa/{idPessoa}/json
Método: GET
Informações de uma única pessoa de acordo com seu id.
JSON Retornado (exemplo):
{
"id": 53,
"tipoPessoa": 1,
"nome": "Pessoa de teste",
"sexo": 1,
"email": "email@email.com.teste",
"ativo": "1",
"cpfCnpj": "419.794.398-11",
"inscricaoEstadualRG": "369457859",
"estadoCivil": "Solteiro",
"nacionalidade": "Brasileiro",
"dataDeNascimento": "11/04/1995",
"numeroCliente": "",
"funcaoEmpregado": {
"id": 1,
"nome": "Auxiliar administrativo"
},
"dataAdmissao": "30/04/2020",
"dataDemissao": "25/10/2022",
"numeroPis": "202.548870.28-20",
"carteiraTrabalhoNumero": "0045018",
"carteiraTrabalhoSerie": "0030",
"classePessoa": {
"id": -40,
"nome": "Representante contratada"
},
"telefones": [
{
"id": 26,
"numero": "11949387609",
"tipo": {
"id": 1,
"nome": "Residencial"
}
}
],
"enderecos": [
{
"id": 65,
"bairro": "Cachambi",
"cep": "20771445",
"logradouro": "Rua Tenente Franca",
"numero": "211",
"complemento": "casa",
"cidade": {
"id": -734,
"nome": "Rio de Janeiro"
},
"tipo": {
"id": 1,
"nome": "Residencial"
}
}
]
}
Retornando listagem de todas as pessoas
Path: /api/pessoas/json
Método: GET
Lista todas as pessoas do sistema.
JSON Retornado (exemplo):
[
{
"id": 55,
"tipoPessoa": 1,
"nome": "Marcio Neves de Castro",
"sexo": 1,
"email": "email@email.com.teste",
"ativo": "1",
"cpfCnpj": "419.139.278-11",
"inscricaoEstadualRG": "369089958",
"estadoCivil": "Solteiro",
"nacionalidade": "Brasileiro",
"dataDeNascimento": "11/04/1995",
"numeroCliente": "",
"funcaoEmpregado": {
"id": 1,
"nome": "Auxiliar administrativo"
},
"dataAdmissao": "30/04/2020",
"dataDemissao": "25/10/2022",
"numeroPis": "202.548870.28-20",
"carteiraTrabalhoNumero": "0045018",
"carteiraTrabalhoSerie": "0030",
"classePessoa": {
"id": 3,
"nome": "Parte Contrária"
},
"telefones": [
{
"id": 33,
"numero": "6127202946",
"tipo": {
"id": 1,
"nome": "Residencial"
}
}
],
"enderecos": [
{
"id": 11,
"bairro": "Setor Sudoeste",
"cep": "70675521",
"logradouro": "Quadra QRSW 5 Bloco B-1",
"numero": "435",
"complemento": "apartamento",
"cidade": {
"id": -2816,
"nome": "Brasília"
},
"tipo": {
"id": 1,
"nome": "Residencial"
}
},
{
"id": 17,
"bairro": "Cachambi",
"cep": "20771445",
"logradouro": "Rua Tenente Franca",
"numero": "211",
"complemento": "casa",
"cidade": {
"id": -734,
"nome": "Rio de Janeiro"
},
"tipo": {
"id": 1,
"nome": "Residencial"
}
}
]
},
{
"id": 54,
"tipoPessoa": 1,
"nome": "Mariana de Souza Nunes",
"sexo": 1,
"email": "email@email.com.teste",
"ativo": "1",
"cpfCnpj": "419.479.278-11",
"inscricaoEstadualRG": "369069958",
"estadoCivil": "Solteiro",
"nacionalidade": "Brasileiro",
"dataDeNascimento": "11/04/1995",
"numeroCliente": "",
"funcaoEmpregado": {
"id": 1,
"nome": "Auxiliar administrativo"
},
"dataAdmissao": "30/04/2020",
"dataDemissao": "25/10/2022",
"numeroPis": "202.548870.28-20",
"carteiraTrabalhoNumero": "0045018",
"carteiraTrabalhoSerie": "0030",
"classePessoa": {
"id": 3,
"nome": "Parte Contrária"
},
"telefones": [
{
"id": 32,
"numero": "6127202946",
"tipo": {
"id": 1,
"nome": "Residencial"
}
}
],
"enderecos": []
},
]
Retornando pessoa deacordo com parâmetro
Path: /api/pessoas/busca/json?q={{name}}
Método: POST
Parâmetro: q - Ex: q=”MARIA”
Busca uma pessoa de acordo com um parâmetro
JSON Retornado (exemplo):
[{}]
Inserir/Editar Pessoa
Nova Path: /api/pessoas/nova/json
Edita Path: /api/pessoas/edita/json
Método: POST
Inserir/editar uma pessoa, caso não exista um id no JSON, ocorrerá a inserção. Para edição, basta apenas um id válido.
Observações: Para a edição de uma pessoa, o usuário deve inserir apenas o id e o(s) campo(s) a serem alterados. Caso o usuário queria alterar o telefone e/ou o endereço, usuário deve seguir os seguintes passos:
- Telefone - Para editar um telefone o usuário deve inserir o id da pessoa, o id do telefone e o id do tipo do telefone
- Para excluir os telefones de uma pessoa,basta passar o id da pessoa e o campo telefone da seguinte maneira
. Esta operação exclui todos os telefones. - Para inserir um telefone basta inserir todos os campos, exceto o id do telefone.
- Para excluir os telefones de uma pessoa,basta passar o id da pessoa e o campo telefone da seguinte maneira
Exemplo de Json a ser enviado para exclusão de telefone(s)
{
"id": 100,
"telefones": []
}
- Endereço - Para editar o endereço o usuário deve inserir o id da pessoa, id do endereço , juntamente com o(s) campo(s) que queira alterar.
- Para excluir os endereços de uma pessoa, basta passar o id da pessoa e o atributo "endereços" da seguinte maneira
. Esta operação exclui todos os endereços. - Para inserir um endereço, basta passar pelo menos os campos obrigatórios (cep,logradouro,número e o tipo) e não inserir um id para o endereço.
- Para excluir os endereços de uma pessoa, basta passar o id da pessoa e o atributo "endereços" da seguinte maneira
Exemplo de Json a ser enviado para exclusão de endereço(s)
{
"id": 100,
"enderecos": []
}
JSON Retornado (exemplo):
{
"id": 53,
"tipoPessoa": 1,
"nome": "Pessoa de teste",
"sexo": 1,
"email": "email@email.com.teste",
"ativo": "1",
"cpfCnpj": "419.794.398-11",
"inscricaoEstadualRG": "369457859",
"estadoCivil": "Solteiro",
"nacionalidade": "Brasileiro",
"dataDeNascimento": "11/04/1995",
"numeroCliente": "",
"funcaoEmpregado": {
"id": 1,
"nome": "Auxiliar administrativo"
},
"dataAdmissao": "30/04/2020",
"dataDemissao": "25/10/2022",
"numeroPis": "202.548870.28-20",
"carteiraTrabalhoNumero": "0045018",
"carteiraTrabalhoSerie": "0030",
"classePessoa": {
"id": -40,
"nome": "Representante contratada"
},
"telefones": [
{
"id": 26,
"numero": "11949387609",
"tipo": {
"id": 1,
"nome": "Residencial"
}
}
],
"enderecos": [
{
"id": 65,
"bairro": "Cachambi",
"cep": "20771445",
"logradouro": "Rua Tenente Franca",
"numero": "211",
"complemento": "casa",
"cidade": {
"id": -734,
"nome": "Rio de Janeiro"
},
"tipo": {
"id": 1,
"nome": "Residencial"
}
}
]
}
Buscar pessoas por CPF e CNPJ
Path: /api/pessoas/buscaPorCpfCnpj/{cpfcnpj}
Método: GET
CPF: Máximo de 8 digitos - CNPJ: Máximo de 14 digitos
Buscar pessoas a partir do número do CPF ou CNPJ.
JSON Retornado (exemplo):
[
{
"id": 53,
"text": "Pessoa de teste - 419.794.398-11",
"nome": "Pessoa de teste",
"nomeEcnpj": "Pessoa de teste - 419.794.398-11"
},
{
"id": 200345,
"text": "Pessoa de teste - 419.794.398-11",
"nome": "Pessoa de teste",
"nomeEcnpj": "Pessoa de teste - 419.794.398-11"
}
]
Buscar tipos de endereço
Path : /api/pessoas/tipoEndereco/json
Método: GET
JSON Retornado (exemplo):
[
{
"id": 1,
"nome": "Residencial"
},
{
"id": 2,
"nome": "Comercial"
}
]
Buscar tipos de telefone
Path:/api/pessoas/tipoTelefone/json
Método: GET
JSON Retornado (exemplo):
[
{
"id": 1,
"nome": "Residencial"
},
{
"id": 2,
"nome": "Comercial"
},
{
"id": 3,
"nome": "Celular"
},
{
"id": 5,
"nome": "Fax"
}
]
Buscar função empregado
Path:/api/pessoas/funcaoEmpregado/json
Método: GET
JSON Retornado (exemplo):
[
{
"id": 1,
"nome": "Advogado"
},
{
"id": 2,
"nome": "Estagiário"
}
]