Objetivos

Determinar os serviços que serão consumidos aplicativo TOTVS Supervisor 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 atendente	-
cInOut	string		-

e

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

{
   "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	string	código da estação	-
cStart	string	data inicio	-
cEnd	string	data fim	-

e

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=

{
    "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	Valor Default
nSituation	numeric	-
cStart	string	-
cEnd	string	-
cMinutes	string	-
cClients	string	-
cPlaces	string	-
cRegions	string	-

e

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=4&cStart=&cEnd=&cMinutes=&cClients=&cPlaces=&cRegions

{
    "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 existe parametros.

e

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

{
    "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 existe parametros.

e

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

{
    "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 existe parametros.

e

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 de locais.	-

GET rest/SUPERVISORGS/palces

{
    "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 /wsatf001/assets/request/

Envia 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.

Payload

O payload que será enviado na requisição conterá as seguintes propriedades:

Propriedade	Tipo	Descrição	Adicional
operation	number	Indica qual solicitação está sendo requisitada.	0: Baixa 1: Transferência 2: Ampliação
asset	string	Código do ativo
item	string	Item do ativo
requests[].status	string	Status da solicitação	0: Pendente 1: Finalizada 2: Cancelada
requests[].date	data	Data da solicitação	Formato data Protheus "YYYYMMDD"
requests[].reason	string	Motivo (descrição)	Se operation=0 -> Motivo Se operation=1 -> Detalhes Se operation=2 -> Observação
requests[].value	number	Valor	Só existe se operation for 1
requests[].quantity	number	Quantidade que for baixada	Só existe se operation for 0
requests[].balance	string	Saldo que foi baixado	Só existe se operation for 0
requests[].type	string	Tipo de transferência	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)

Post /wsatf001/assets/request

{
	"operation": 1,
	"asset": "000001",
	"item": "0001",
	"type": "0",
    "status" : 0,    
	"reason" : "teste",
	"value" : 100,
	"quantity" : 1,
    "balance": {
		"type": "10",
		"balance_type": "3"}
}