Histórico da Página
Índice
...
Objetivos
Determinar os serviços que serão consumidos aplicativo TOTVS Supervisor 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 do atendenteda Agenda | - |
cInOut | string | Tipo Marcação 1=Entrada/2=Saída | - |
e
Retorno
O serviço deve retornar as propriedades informadas, de acordo com os parâmetros passados na consulta.
...
Bloco de código | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
{ "checkin": [ { "lat": "-23.5083524", "long": "-46.6497187", "hr": "11:11", "obs": "" "selfie": “Aqui vem o base64 da imagem” "additionalphotos": [] } ], "count": 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 | stringcódigo da estação | Código do Local | - |
cStart | stringdata | inicioHorário Inicial | - |
cEnd | stringdata | fimHorá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.
...
Bloco de código | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
{ "appointments": [ { "code": "000000000283", "attendant": "MATHEUS LANDO RAIMUNDO", "schedule": "08:00", "realschedule": "", "inout": "1", "desc": "Entrada", "late": "1", "executed": " " }, { "code": "000000000283", "attendant": "MATHEUS LANDO RAIMUNDO", "schedule": "12:00", "realschedule": "", "desc": "Saída", "late": "2", "inout": "2", "executed": " " } ], "count": 2 } |
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.
...
GET rest/SUPERVISORGS/stations?nSituation=43&cStart=&cEnd=&cMinutes=&cClients=&cPlaces=&cRegions
...
Bloco de código | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
{ "stations": [ { "code": "00000001", "desc": "TOTVS SITE SP", "type": "2", "lat": "-23.5085024", "long": "-46.6527313" } ], "count": 1 } |
GET /rest/supervisorgs/clients
Retorna a lista dos clientes 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) | - |
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.
...
Bloco de código | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
{ "clients": [ { "code": "001", "store": "01", "check": "false", "desc": "CLIENTE 001" }, { "code": "000001", "store": "01", "check": "false", "desc": "CLIENTE PADRAO P/ ORCAMENTO" }, { "code": "EX0001", "store": "01", "check": "false", "desc": "CLIENTE EXTERIOR 001" } ], "hasNext": "false", "count": 3 } |
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.
e
Retorno
O serviço deve retornar as propriedades informadas, de acordo com os parâmetros passados na consulta.
...
Bloco de código | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
{ "regions": [ { "code": "001", "desc": "Norte" }, { "code": "002", "desc": "Sul" }, { "code": "003", "desc": "Leste" }, { "code": "004", "desc": "Oeste" }, { "code": "005", "desc": "Centro" }, { "code": "006", "desc": "Centro oeste" } ], "count": 5 } |
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.e
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 | Qantidade Quantidade de locais. | - |
GET rest/SUPERVISORGS/palcesplaces
Bloco de código | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
{ "places": [ { "code": "00000001", "desc": "TOTVS SITE SP" }, { "code": "00000002", "desc": "TOTVS MATRIZ - 1000" }, { "code": "00000003", "desc": "CASA DO GUILHERME" }, { "code": "00000004", "desc": "IBIRAPUERA" } ], "count": 4 } |
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 | - |
...
Bloco de código | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
{ cCode: "000000000283", cObs: "teste" } |
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
Bloco de código | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
{
"supervisor": [
{
"code": "D MG 01000023",
"desc": "FUNCIONARIO A"
},
{
"code": "D MG 01000025",
"desc": "FUNCIONARIO C"
},
{
"code": "D MG 01000029",
"desc": "FUNCIONARIO AA"
},
{
"code": "D MG 01000030",
"desc": "FUNCIONARIO BB"
}
],
"hasNext": "false"
} |