Pessoa

person/audit/:person-id

Obter informações de interações no registro de Pessoa

GET
http://cftv.barradorio.com.br:8080/api/person/audit/:person-id
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [person.person.read]{ "description": "Autenticação", "type": "@OneOf", "schema": { "token": "Token de autenticação de usuário" } }
URI Input
{ "description": "Registro do(a) Pessoa", "type": "@OneOf", "schema": { "person-id": "Código" } }
Query Input
{ "description": "Registro do(a) Pessoa", "type": "@OneOf", "schema": { "page": "Página", "pagination": "Paginação. Máximo 100." } }
Output
{ "type": "success", "content": "@" } where output @ is { "description": "Registro do(a) Pessoa", "type": "@OneOf", "schema": { "personAudits": { "description": "Auditoria", "type": "@ManyOf", "schema": { "created": "Data\/Hora", "description": "Alterações", "authorUser": { "description": "Auditoria", "type": "@OneOf", "schema": { "id": "Código", "name": "Nome" } } } }, "total": "Total de Registros", "page": "Página Carregada", "pages": "Total de Páginas", "pagination": "Páginação" } }
Output Exception
{ "type": "exception", "message": "@" } where ouput exception @ is equal the string message

person/collection

Coleção de Pessoa com informações resumidas e possibilidade de filtro

GET
http://cftv.barradorio.com.br:8080/api/person/collection
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [person.person.read]{ "description": "Autenticação", "type": "@OneOf", "schema": { "token": "Token de autenticação de usuário" } }
Query Input
{ "description": "Registro do(a) Pessoa", "type": "@OneOf", "schema": { "page": "Página", "pagination": "Paginação. Máximo 100.", "order-by": "Atributo de Ordenação. person.id, person.documentRegistry, person.name, person.nameShort, person.email, person.phonePrimary", "order-type": "Tipo de Ordenação no Atributo. ASC ou DESC. Padrão DESC", "filter-id": "Código", "filter-documentRegistry-contains": "Documento (CPF\/CNPJ)", "filter-name-contains": "Nome", "filter-email-contains": "E-mail" } }
Output
{ "type": "success", "content": "@" } where output @ is { "description": "Registro do(a) Pessoa", "type": "@OneOf", "schema": { "persons": { "description": "Pessoa", "type": "@ManyOf", "schema": { "id": "Código", "documentRegistry": "Documento (CPF\/CNPJ)", "name": "Nome", "nameShort": "Razão Social", "email": "E-mail", "phonePrimary": "Telefone" } }, "total": "Total de Registros", "page": "Página Carregada", "pages": "Total de Páginas", "pagination": "Páginação", "order-by": "Atributo de Ordenação", "order-type": "Tipo de Ordenação" } }
Output Exception
{ "type": "exception", "message": "@" } where ouput exception @ is equal the string message

person/create

Criar um(a) Pessoa

POST
http://cftv.barradorio.com.br:8080/api/person/create
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [person.person.create]{ "description": "Autenticação", "type": "@OneOf", "schema": { "token": "Token de autenticação de usuário" } }
Body Input
{ "description": "Registro do(a) Pessoa", "type": "@OneOf", "schema": { "person": { "description": "Pessoa", "type": "@OneOf", "schema": { "personType": { "description": "Pessoa", "type": "@OneOf", "schema": { "id": "Identificação" } }, "documentRegistry": "Documento (CPF\/CNPJ) precisa ter apenas dígitos, Documento (CPF\/CNPJ) é obrigatório, Documento (CPF\/CNPJ) precisa ter 14 caracteres", "name": "Nome precisa ser um texto, Nome é obrigatório, Nome precisa ter 120 caracteres", "nameShort": "Razão Social precisa ser um texto, Razão Social precisa ter 120 caracteres", "documentState": "Inscrição Estadual precisa ser um texto, Inscrição Estadual precisa ter 14 caracteres", "notes": "Observações precisa ser um texto, Observações precisa ter 255 caracteres", "email": "E-mail precisa ser um texto, E-mail precisa ter 160 caracteres", "phonePrimary": "Telefone precisa ser um texto, Telefone é obrigatório, Telefone precisa ter 15 caracteres", "phoneSecondary": "Telefone Adicional precisa ser um texto, Telefone Adicional precisa ter 15 caracteres", "addressZipcode": "CEP precisa ser um texto, CEP precisa ter 8 caracteres", "addressUf": "UF precisa ser um texto, UF precisa ter 120 caracteres", "addressCity": "Cidade precisa ser um texto, Cidade precisa ter 80 caracteres", "addressDistrict": "Bairro precisa ser um texto, Bairro precisa ter 80 caracteres", "addressStreet": "Rua precisa ser um texto, Rua precisa ter 120 caracteres", "addressNumber": "Número precisa ser um texto, Número precisa ter 12 caracteres", "addressComplements": "Complemento precisa ser um texto, Complemento precisa ter 40 caracteres", "personBranch": { "description": "Filial", "type": "@ManyOf", "schema": { "branch": { "description": "Filial", "type": "@OneOf", "schema": { "id": "Identificação" } } } } } } } }
Output
{ "type": "success", "content": "@" } where output @ is { "description": "Registro do(a) Pessoa", "type": "@OneOf", "schema": { "id": "Código", "message": "Mensagem" } }
Output Exception
{ "type": "exception", "message": "@" } where ouput exception @ is equal the string message

person/delete/:person-id

Deletar Pessoa

DELETE
http://cftv.barradorio.com.br:8080/api/person/delete/:person-id
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [person.person.delete]{ "description": "Autenticação", "type": "@OneOf", "schema": { "token": "Token de autenticação de usuário" } }
URI Input
{ "description": "Registro do(a) Pessoa", "type": "@OneOf", "schema": { "person-id": "Código" } }
Output
{ "type": "success", "content": "@" } where output @ is { "description": "Registro do(a) Pessoa", "type": "@OneOf", "schema": { "message": "Mensagem" } }
Output Exception
{ "type": "exception", "message": "@" } where ouput exception @ is equal the string message

person/edit/:person-id

Editar um(a) Pessoa

POST
http://cftv.barradorio.com.br:8080/api/person/edit/:person-id
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [person.person.edit]{ "description": "Autenticação", "type": "@OneOf", "schema": { "token": "Token de autenticação de usuário" } }
URI Input
{ "description": "Registro do(a) Pessoa", "type": "@OneOf", "schema": { "person-id": "Código" } }
Body Input
{ "description": "Registro do(a) Pessoa", "type": "@OneOf", "schema": { "person": { "description": "Pessoa", "type": "@OneOf", "schema": { "personType": { "description": "Pessoa", "type": "@OneOf", "schema": { "id": "Identificação" } }, "documentRegistry": "Documento (CPF\/CNPJ) precisa ter apenas dígitos, Documento (CPF\/CNPJ) é obrigatório, Documento (CPF\/CNPJ) precisa ter 14 caracteres", "name": "Nome precisa ser um texto, Nome é obrigatório, Nome precisa ter 120 caracteres", "nameShort": "Razão Social precisa ser um texto, Razão Social precisa ter 120 caracteres", "documentState": "Inscrição Estadual precisa ser um texto, Inscrição Estadual precisa ter 14 caracteres", "notes": "Observações precisa ser um texto, Observações precisa ter 255 caracteres", "email": "E-mail precisa ser um texto, E-mail precisa ter 160 caracteres", "phonePrimary": "Telefone precisa ser um texto, Telefone é obrigatório, Telefone precisa ter 15 caracteres", "phoneSecondary": "Telefone Adicional precisa ser um texto, Telefone Adicional precisa ter 15 caracteres", "addressZipcode": "CEP precisa ser um texto, CEP precisa ter 8 caracteres", "addressUf": "UF precisa ser um texto, UF precisa ter 120 caracteres", "addressCity": "Cidade precisa ser um texto, Cidade precisa ter 80 caracteres", "addressDistrict": "Bairro precisa ser um texto, Bairro precisa ter 80 caracteres", "addressStreet": "Rua precisa ser um texto, Rua precisa ter 120 caracteres", "addressNumber": "Número precisa ser um texto, Número precisa ter 12 caracteres", "addressComplements": "Complemento precisa ser um texto, Complemento precisa ter 40 caracteres", "personBranch": { "description": "Filial", "type": "@ManyOf", "schema": { "id": "Código precisa ser um número, Chave primária de identificação do registro gerada automaticamente", "branch": { "description": "Filial", "type": "@OneOf", "schema": { "id": "Identificação" } } } } } } } }
Output
{ "type": "success", "content": "@" } where output @ is { "description": "Registro do(a) Pessoa", "type": "@OneOf", "schema": { "id": "Código", "message": "Mensagem" } }
Output Exception
{ "type": "exception", "message": "@" } where ouput exception @ is equal the string message

person/get/:person-id

Obter Pessoa com todos os detalhes de suas informações

GET
http://cftv.barradorio.com.br:8080/api/person/get/:person-id
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [person.person.read]{ "description": "Autenticação", "type": "@OneOf", "schema": { "token": "Token de autenticação de usuário" } }
URI Input
{ "description": "Registro do(a) Pessoa", "type": "@OneOf", "schema": { "person-id": "Código" } }
Output
{ "type": "success", "content": "@" } where output @ is { "description": "Registro do(a) Pessoa", "type": "@OneOf", "schema": { "person": { "description": "Pessoa", "type": "@OneOf", "schema": { "id": "Código", "personType": { "description": "Pessoa", "type": "@OneOf", "schema": { "id": "Identificação", "name": "Descrição" } }, "created": "Data de Cadastro", "updated": "Data de Atualização", "documentRegistry": "Documento (CPF\/CNPJ)", "name": "Nome", "nameShort": "Razão Social", "documentState": "Inscrição Estadual", "notes": "Observações", "email": "E-mail", "phonePrimary": "Telefone", "phoneSecondary": "Telefone Adicional", "addressZipcode": "CEP", "addressUf": "UF", "addressCity": "Cidade", "addressDistrict": "Bairro", "addressStreet": "Rua", "addressNumber": "Número", "addressComplements": "Complemento", "personBranch": { "description": "Filial", "type": "@ManyOf", "schema": { "id": "Código", "branch": { "description": "Filial", "type": "@OneOf", "schema": { "id": "Identificação", "name": "Descrição" } } } } } } } }
Output Exception
{ "type": "exception", "message": "@" } where ouput exception @ is equal the string message

person/receita/:cnpj

Obter informações de um CNPJ

GET
http://cftv.barradorio.com.br:8080/api/person/receita/:cnpj
URI Input
{ "description": "Registro do(a) CNPJ", "type": "@OneOf", "schema": { "cnpj": "CNPJ" } }
Output
{ "type": "success", "content": "@" } where output @ is { "description": "Registro do(a) CNPJ", "type": "@OneOf", "schema": { "nome": "Razão Social", "fantasia": "Fantasia" } }
Output Exception
{ "type": "exception", "message": "@" } where ouput exception @ is equal the string message