APIs

API´s ESP -Enterprise Service Platform

22min

Esta seção destina-se a descrever a estrutura de comunicação REST, estabelecida entre aplicativos e o servidor de back-end.

Atenção: CITSMART_URL: prefixo de URL inalterável, para que você possa acessar os serviços disponibilizados para os aplicativos móveis. TODO API QUE NECESSITA UM “sessionID” PRECISARÁ ESTAR EM UMA SESSÃO FORNECIDA PELO “Login” DA API.



Login

Login do usuário para usar os Serviços CITSmart.

Método
URL
Solicitação
Resposta
Campos


ListContracts

Lista dos contratos acessíveis ao atendente.

Método
URL
Solicitação
Resposta
Campos


ListDeniedReasons

Lista de razões quando recusar uma solicitação, como no check-in

Método
URL
Solicitação
Resposta
Campos


ListSolicitationStatus

Lista os status de uma solicitação a ser usada, por exemplo, no serviço de checkout.

Método
URL
Solicitação
Resposta
Campos


ListUnits

Lista as unidades de um contrato

Método
URL
Solicitação
Resposta
Campos


SendCoordinates

Atualiza as coordenadas geográficas de uma unidade.

Método
URL
Solicitação
Resposta
Campos


DeviceDisassociate

Desassociar um usuário de um dispositivo para que, quando um usuário excluir uma conexão, o usuário não receba mais a notificação push da conexão excluída.

Método
URL
Solicitação
Resposta
Campos


GetNewest

Recupera a solicitação mais recente para o usuário no grupo, a partir da última (newestNumber) no aplicativo

Método
URL
Solicitação
Resposta
Campos


GetOldest

Recupere a solicitação mais recente para o usuário no grupo, do mais antigo.

Método
URL
Solicitação
Resposta
Campos


GetByCoordinates

Recupera a solicitação mais recente para o usuário no grupo, a partir das coordenadas atuais do usuário.

Método
URL
Solicitação
Resposta
Campos


UpdateNotification

Recupera as tarefas de um serviço.

Método
URL
Solicitação
Resposta
Campos


GetById

Recupera detalhes de uma solicitação, de acordo com seu identificador

Método
URL
Solicitação
Resposta
Campos


GetReasons

Recuperar os motivos a serem utilizados na aprovação de uma solicitação, de acordo com a solicitação.

Método
URL
Solicitação
Resposta
Campos


AttendRequest

Informar o início do atendimento de uma solicitação de serviço.

Método
URL
Solicitação
Resposta
Campos


AttendantLocation

Informa a localização automática da posição do atendente.

Método
URL
Solicitação
Resposta
Campos


Feedback

Registra uma aprovação ou negação de uma solicitação de serviço.

Método
URL
Solicitação
Resposta
Campos


New

Cria uma nova solicitação

Método
URL
Solicitação
Resposta
Campos


Check-In

Check-in do atendente em uma solicitação. Em outras palavras, inicia o cumprimento da solicitação.

Método
URL
Solicitação
Resposta
Campos


Check-Out

Verifica um atendente em uma solicitação, atualizando seu status ("Suspenso", "Resolvido", etc.).

Método
URL
Solicitação
Resposta
Campos


Check-InDenied

Registrar a negação de uma solicitação de atendimento pelo atendente, nos casos de recusa ao check-in.

Método
URL
Solicitação
Resposta
Campos