Endpoint Clientes

Endpoint Clientes

Criar um novo cliente

POST http://servidor_vigo/vapi/clientes

Recuperar cliente existente

GET http://servidor_vigo/vapi/clientes/{ID_DO_CLIENTE}

Atualizar cliente

POST http://servidor_vigo/vapi/clientes/{ID_DO_CLIENTE}

Remover cliente

DELETE http://servidor_vigo/vapi/clientes/{ID_DO_CLIENTE}

Listar clientes

GET http://servidor_vigo/vapi/clientes

Resposta e Status HTTP de retorno

Todas as repostas da API são objetos JSON.

As respostas serão respostas HTTP convêncionais para indicar sucesso ou falha nas requisições.

• Status 2xx indicam sucesso
• status 4xx indicam falhas decorrentes de erros nas informações enviadas
• status 5xx indicam erros internos no servidor vigo.

Código	Motivo
200 OK	Tudo ocorreu conforme o esperado.
400 Bad Request	Algum parâmetro obrigatório não foi enviado ou é inválido.
404 Not Found	O objeto solicitado não existe.
500 Internal Server Error	Algo deu errado no servidor vigo.

Exemplo de reposta para status HTTP 400:

{
   "errors":[
      {
         "code":"invalid_value",
         "description":"O campo xxx deve ser informado"
      },
      {
         "code":"invalid_yyy",
         "description":"O valor no campo yyy é inválido"
      }
   ]
}

Atributos do objeto Clientes

campo	tipo	descricao
numero	integer	Numero do cadastro do cliente
nome	string
endereco	string
cidade	string
cep	string
rgie	string	RG ou Inscrição estadual
cpfcgc	string	CPF ou CNPJ
telefone	string
dt_nascimento	date	data de nascimento
login	string	login de acesso a central
tipo	string	F = Física, J = Jurí­dica
situacao	string	'B' = Bloqueado, ' ' = Liberado
vcto	string	Data do vencimento da mensalidade
grupo	string	Grupo do cliente
bairro	string
sexo	string
celular	string
email	string
estcivil	string	Estado civil (casado/solteiro...)
obs	string
uf	string
contrato	string	Numero de contrato
dt_cadastro	date	Data do cadastro
latitude	string
longitude	string
dt_situacao	date	Data do cadastro

Exemplo de resposta json

{
    "numero":1234,
    "nome":"Fulano da Silva",
    "endereco":"Rua XYZ",
    "cidade":"São Paulo",
    "cep":"0000-000",
    "rgie":"1234567-8",
    "cpfcgc":"123.123.123-12",
    "telefone":"",
    "login":"fulano",
    "tipo":"F",
    "situacao":" ",
    "vcto":"2014-01-01",
    "grupo":"GERAL",
    "bairro":"Centro",
    "sexo":"M",
    "celular":"",
    "email":"[email protected]",
    "estcivil":"CASADO",
    "obs":"",
    "uf":"SP",
    "contrato":"",
    "latitude":"",
    "longitude":"",
    "dt_nascimento":"2014-01-01",
    "dt_cadastro":"2014-01-01",
    "dt_situacao":"2014-01-01"
}