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 | - |
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.
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. | - |
...
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.
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=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 } |
POST /wsatf001/assets/request/
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
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 urlEnvia requisição para tranferência / baixa e ampliação do ativo.
Parâmetros aceitos
Não são aceitos parâmetros de URL para esta requisição.
...
Retorno
O payload que será enviado na requisição conterá as seguintes propriedades:serviço deve retornar as propriedades informadas, de acordo com os parâmetros passados na consulta.
Propriedade | Tipo | Descrição | Adicional |
---|
regions |
0: Baixa
1: Transferência
2: Ampliação
0: Pendente
1: Finalizada
2: Cancelada
Se operation=0 -> Motivo
Se operation=1 -> Detalhes
Se operation=2 -> Observação
0: Física
1: Contábil
Exemplo de retorno da requisição:
- item: Código do item (mostrar sempre junto)
- status: Status da solicitação (0-Pendente, 1-Finalizada, 2-cancelada)
- date: Data da solicitação, formato data Protheus YYYYMMDD
- reason: Motivo
Se operation=0 -> Motivo
Se operation=1 -> Detalhes
Se operation=2 -> Observação
- value: (só não existe se operation=1)
- quantity: (só existe se operation=0)
- balances: Tipos de saldo disponíveis no bem (ver GET /assets) (só existe se operation=0)
- type: Tipo de transferência (0-física, 1-contábil) (só existe se for operation=1)
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
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.
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
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 | - |
Post /rest/SUPERVISORGS/operationalDecision
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/supervisorPost /wsatf001/assets/request
Bloco de código | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
{ "operation": 1, "asset "supervisor": [ { "code": "000001D MG 01000023", "item "desc": "0001", "typeFUNCIONARIO A" }, { "code": "0D MG 01000025", "desc": "status" : 0,FUNCIONARIO C" }, "reason" { "code": "testeD MG 01000029", "value" : 100, "quantity" : 1, "desc": "FUNCIONARIO AA" }, { "balancecode": { "type "D MG 01000030", "desc": "10", "balance_typeFUNCIONARIO BB" } ], "hasNext": "3false"} } |