Objetivos
Determinar os serviços que serão consumidos aplicativo Minha Gestão de Postos.
GET /rest/supervisorgs/checkin
Retorna a lista dos apontamentos disponíveis.
Parâmetros aceitos
Os parâmetros serão passados por queryParams e poderão ser utilizados em conjunto. Caso haja mais de um parâmetro enviado, a lógica utilizada dever ser "E".
Parâmetro | Tipo | Descrição | Valor Default |
---|---|---|---|
cCode | string | Filtra pelo código da Agenda | - |
cInOut | string | Tipo Marcação 1=Entrada/2=Saída | - |
Retorno
O serviço deve retornar as propriedades informadas, de acordo com os parâmetros passados na consulta.
Propriedade | Tipo | Descrição | Adicional |
---|---|---|---|
checkin | Array | Lista com os objetos de checkin. | - |
checkin[].lat | string | Latitude do checkin | - |
checkin[].long | string | Longitude do checkin. | - |
checkin[].hr | string | Hora do checkin. | - |
checkin[].obs | string | Código do item do ativo | - |
checkin[].selfie | string | Selfie | - |
checkin[].additionalphotos | string | Novas fotos | - |
count | string | Total de checkin | - |
Exemplo de retorno da requisição:
GET rest/SUPERVISORGS/checkin?cCode=000000000283&cInOut=1
GET /rest/supervisorgs/appointments
Retorna a lista dos apontaentos na url.
Parâmetros aceitos
Os parâmetros serão passados por queryParams e poderão ser utilizados em conjunto. Caso haja mais de um parâmetro enviado, a lógica utilizada dever ser "E".
Parametro | Tipo | Descrição | Valor Default |
---|---|---|---|
cStation | string | Código do Local | - |
cStart | string | Horário Inicial | - |
cEnd | string | Horário Final | - |
cMinutes | String | Diferença de Minutos entre a agenda e o horário |
Retorno
O serviço deve retornar as propriedades informadas, de acordo com os parâmetros passados na consulta.
Propriedade | Tipo | Descrição | Adicional |
---|---|---|---|
appointments | Array | Array com os apontamentos. | - |
appointments[x].code | String | Código do atendente. | - |
appointments[x].attendant | String | Nome do atendente. | - |
appointments[x].schedule | String | Hora do schedule. | - |
appointments[x].realschedule | String | Hora do real schedule | - |
appointments[x].inout | String | - | |
appointments[x].desc | String | - | |
appointments[x].late | String | - | |
appointments[x].executed | String | - | |
count | Numeric | Total de apontamentos. | - |
GET /rest/SUPERVISORGS/appointments?cStation=00000001&cStart=&cEnd=
GET /rest/supervisorgs/stations
Retorna a lista das estações disponiveis na url.
Parâmetros aceitos
Os parâmetros serão passados por queryParams e poderão ser utilizados em conjunto. Caso haja mais de um parâmetro enviado, a lógica utilizada dever ser "E".
Parametro | Tipo | Descrição | Valor Default |
---|---|---|---|
nSituation | numeric | Situação da estação (1 - Sem Pendencias, 2 - Pendentes, 3 - Todos) | 3 |
cStart | string | Horario Inicial | - |
cEnd | string | Horario Final | - |
cMinutes | string | Minutos | - |
cClients | string | Cliente da estaçao | - |
cPlaces | string | Código do Local | - |
cRegions | string | Regiao da estação | - |
cSupervisor | string | Supervisores | - |
Retorno
O serviço deve retornar as propriedades informadas, de acordo com os parâmetros passados na consulta.
Propriedade | Tipo | Descrição | Adicional |
---|---|---|---|
stations | Array | Array com as estações. | - |
stations[x].code | String | Código da estação. | - |
stations[x].desc | String | Descrição da estação. | - |
stations[x].type | String | Tipo da estação. | - |
stations[x].lat | String | Latitude da estação. | - |
stations[x].long | String | Longitude da estação. | - |
count | Numeric | Qantidade de estações. |
GET rest/SUPERVISORGS/stations?nSituation=3&cStart=&cEnd=&cMinutes=&cClients=&cPlaces=&cRegions
GET /rest/supervisorgs/clients
Retorna a lista dos clientes disponiveis na url.
Parâmetros aceitos
Parâmetro | Tipo | Descrição | Valor Default |
---|---|---|---|
nPage | Numeric | Página da Consulta | - |
nPageSize | Numeric | Tamanho da Página (resultset) | - |
cSearchItem | string | String de Busca que pode ser código ou descrição | - |
Retorno
O serviço deve retornar as propriedades informadas, de acordo com os parâmetros passados na consulta.
Propriedade | Tipo | Descrição | Adicional |
---|---|---|---|
clients | Array | Array com os clientes. | - |
clients[x].code | String | Código do cliente. | - |
clients[x].desc | String | Descrição do cliente | - |
clients[x].store | String | Loja do cliente. | - |
clients[x].check | String | - | |
hasNext | booleano | ndica se há uma próxima página a ser retornada ou se atingiu a última página disponível | true = Há uma próxima página false = É a última página disponível |
count | Numeric | Qantidade de clientes. |
GET rest/SUPERVISORGS/clients
GET /rest/supervisorgs/regions
Retorna a lista das regioes disponiveis na url.
Parâmetros aceitos
Não são aceitos parâmetros de URL para esta requisição.
Retorno
O serviço deve retornar as propriedades informadas, de acordo com os parâmetros passados na consulta.
Propriedade | Tipo | Descrição | Adicional |
---|---|---|---|
regions | Array | Array com as regiões. | - |
regions[x].code | string | Código da região. | - |
regions[x].desc | string | Descrição da região. | - |
count | Numeric | Qantidade de clientes. | - |
GET rest/SUPERVISORGS/clients
GET /rest/supervisorgs/places
Retorna a lista dos locais disponiveis na url.
Parâmetros aceitos
Não são aceitos parâmetros de URL para esta requisição.
Parâmetro | Tipo | Descrição | Valor Default |
---|---|---|---|
nPage | Numeric | Página da Consulta | - |
nPageSize | Numeric | Tamanho da Página (resultset) | - |
cSearchTerm | string | String de Busca que pode ser código ou descrição | - |
Retorno
O serviço deve retornar as propriedades informadas, de acordo com os parâmetros passados na consulta.
Propriedade | Tipo | Descrição | Adicional |
---|---|---|---|
regions | Array | Array com os locais | - |
regions[x].code | string | Código do local. | - |
regions[x].desc | string | Descrição do local. | - |
count | Numeric | Quantidade de locais. | - |
GET rest/SUPERVISORGS/places
POST /rest/supervisorgs/operationalDecision
Envia requisição
Parâmetros aceitos
Não são aceitos parâmetros de URL para esta requisição.
Payload
O payload que será enviado na requisição conterá as seguintes propriedades:
Propriedade | Tipo | Descrição | Adicional |
---|---|---|---|
cCode | string | código do operador | - |
cInOut | String | Tipo da operação 1=Entrada/2=Saída | |
cobs | string | campo de observação | - |
Post /rest/SUPERVISORGS/operationalDecision
GET /rest/supervisorgs/supervisor
Retorna a lista dos supervisores disponiveis na url.
Parâmetros aceitos
Não são aceitos parâmetros de URL para esta requisição.
Parâmetro | Tipo | Descrição | Valor Default |
---|---|---|---|
nPage | Numeric | Página da Consulta | - |
nPageSize | Numeric | Tamanho da Página (resultset) | - |
cSearchTerm | string | String de Busca que pode ser código ou descrição | - |
Retorno
O serviço deve retornar as propriedades informadas, de acordo com os parâmetros passados na consulta.
Propriedade | Tipo | Descrição | Adicional |
---|---|---|---|
supervisor | Array | Array com os locais | - |
supervisor[x].code | string | Código do local. | - |
supervisor[x].desc | string | Descrição do local. | - |
count | Numeric | Quantidade de locais. | - |
GET rest/SUPERVISORGS/supervisor