Skip to content

Endpoint Atendimentos

Clayton A. Alves edited this page Nov 13, 2014 · 1 revision

Endpoint Chamados

Listar Chamados

GET http://servidor_vigo/vapi/chamados

Criar um novo chamado

POST http://servidor_vigo/vapi/chamado

Recuperar chamado existente

GET http://servidor_vigo/vapi/chamado/{ID_DO_CHAMADO}

Atualizar chamado

PUT http://servidor_vigo/vapi/chamado/{ID_DO_CHAMADO}

Remover chamado

DELETE http://servidor_vigo/vapi/chamado/{ID_DO_CHAMADO}

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 Chamados

Campos em negrito são campos obrigatórios:

campo tipo descricao
numero string Chave primária da tabela (gerado automaticamente)
descricao string Descrição curta do chamado
n_usuario string Número do cliente
dt_fechamento date Data de fechamendo do chamado
dt_abertura date Data de abertura do chamado (gerado automaticamente)
anotacao string Campo livre
tipo string Tipo do chamado (default: Outros)
operador string Operador que abriu o chamado
idempresa integer Id da empresa (default: 1)
valor double Valor cobrado (default: 0)
dt_agendamento date Data de agendamento
n_tecnico integer Número do técnico responsável (default: 1)
h_fechamento string Hora de fechamento do chamado
h_abertura string Hora de abertura do chamado
historico string Campo livre para inserção de histórico de atendimentos
encaminhamentos string ?
fec_por string Nome de quem fechou o chamado

Exemplo de resposta json

{
    "dt_fechamento": "2008-03-17",
    "dt_abertura": "2008-03-17",
    "anotacao": null,
    "tipo": "Financeiro",
    "operador": "adm",
    "idempresa": "1",
    "valor": 0,
    "dt_agendamento": null,
    "n_usuario": "00436",
    "numero": "1703004364470",
    "n_tecnico": "1",
    "h_fechamento": null,
    "h_abertura": null,
    "historico": "Dado suporte, reiniciado Radio e Router do cliente - Resolvido",
    "encaminhamentos": "17/03/2008  16:49  ABERTA pelo operador adm\r\n \r\n17/03/2008  16:50  FECHADA pelo operador adm",
    "descricao": "Nao Funcionando",
    "fec_por": null