Í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

language	js
theme	RDark
title	response.json
collapse	true

{
   "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

Código do Local	-
cStart	string

data inicio

Horário Inicial	-
cEnd	string

data fim

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=

...

Bloco de código

language	js
theme	RDark
title	response.json
collapse	true

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

Payload

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

...

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

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

Bloco de código

language	js
theme	RDark
title	response.json
collapse	true

{
    "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

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

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

Bloco de código

language	js
theme	RDark
title	response.json
collapse	true

{
    "clients": [
        {
			"operationcode": 1"001",
			"assetstore": "00000101",
			"itemcheck": "0001false",
			"typedesc": "0",
    "status" : 0,    
	"reason" : "teste",
	"value" : 100,
	"quantity" : 1,
    "balance": {
		"type": "10",
		"balance_type": "3"}
}

PUT /wsatf001/assets/{asset}/{item}

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 Grava a localização de um ativo identificado pelos parâmetros asset e item na url.

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

location

regions

array

Array

Array com

a Localização

as regiões.

-

latnumberLatitude

regions[x].code

string

Código da região.

-

lngnumberLongitude

regions[x].desc

string

Descrição da região.

-

Exemplo de retorno da requisição:

- location: Array com a localização.

- lat: Latitude da localização do ativo.

- lng: Longitude da localização do ativo

count

Numeric

Qantidade de clientes.

-

GET rest/SUPERVISORGS/clientsPut /wsatf001/assets/{assets}/{item}

Bloco de código

language	js
theme	RDark
title	response.json
collapse	true

{
    "locationregions": [
        {
 "lat": -93.5084952,
 "lng": -96.6536569
 }
}

PUT /wsatf001/assets/{asset}/{item}/image

			"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 Grava a foto de um ativo identificado pelos parâmetros asset e item na url.

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

Parâmetro

Tipo	Descrição

Adicional

Valor Default

content

nPage

string

Numeric

Base64 da imagem cadastrada no sistema para o ativo

Página da Consulta

-

Exemplo de retorno da requisição:

- location: Array com a localização.

Put /wsatf001/assets/{assets}/{item}

Bloco de código

language	js
theme	RDark
title	response.json
collapse	true

{
	"content": "data:image/jpeg;base64,/9j/4AAQSkZJRgABAQEAagBqAAD/4RDc...........(continuação do conteúdo da imagem)"
}

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

appointments

regions

Array

Array com os

apontamentos.

locais

-

appointments

regions[x].code

String

string

Código do

atendente

local.

-

appointments

regions[x].

attendant

desc

String

string

Nome do atendente.-

appointments[x].schedule

StringHora do schedule.-

appointments[x].realschedule

StringHora do real schedule-

appointments[x].inout

String-

appointments[x].desc

String-

appointments[x].late

String-

appointments[x].executed

String-

Descrição do local.

-

count

Numeric

Total

Quantidade de

apontamentos

locais.

-

GET rest/SUPERVISORGS/

...

places

Bloco de código

language	js
theme	RDark
title	response.json
collapse	true

{
    "appointmentsplaces": [
        {
			"code": "00000000028300000001",
			"attendantdesc": "MATHEUSTOTVS LANDOSITE RAIMUNDOSP"
		},
		{
			"schedulecode": "08:0000000002",
			"realscheduledesc": "TOTVS MATRIZ - 1000"
		},
		{
			"inoutcode": "100000003",
			"desc": "Entrada",CASA DO GUILHERME"
		},
		{
			"latecode": "100000004",
			"executed": " "
		},
		{
			"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

language	js
theme	RDark
title	response.json
collapse	true

{
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

language	js
theme	RDark
title	response.json
collapse	true

{
    "supervisor": [
        {
            "code": "000000000283D MG  01000023",
			"attendant            "desc": "MATHEUS LANDO RAIMUNDO",
			"schedule": "12:00",
			"realschedule": "",
			"desc": "Saída",
			"late": "2",
			"inout": "2",
			"executed": " "
		FUNCIONARIO A"
        },
        {
            "code": "D MG  01000025",
            "desc": "FUNCIONARIO C"
        },
        {
            "code": "D MG  01000029",
            "desc": "FUNCIONARIO AA"
        },
        {
            "code": "D MG  01000030",
            "desc": "FUNCIONARIO BB"
        }
    ],
    "counthasNext": 2"false"
}

...

Árvore de páginas

Versões comparadas

Versão antiga 11

Nova versão Atual

Chave

Objetivos

Determinar os serviços que serão consumidos aplicativo TOTVS Supervisor Minha Gestão de Postos.

GET /rest/supervisorgs/checkin

Parâmetros aceitos

Retorno

GET /rest/supervisorgs/appointments

Parâmetros aceitos

Retorno

GET /

rest/

supervisorgs/

stations

Parâmetros aceitos

Payload

Retorno

GET /rest/supervisorgs/clients

Parâmetros aceitos

Retorno

PUT /wsatf001/assets/{asset}/{item}

GET /rest/supervisorgs/regions

Parâmetros aceitos

Retorno

PUT /wsatf001/assets/{asset}/{item}/image

GET /rest/supervisorgs/places

Parâmetros aceitos

Payload

Retorno

POST /rest/supervisorgs/operationalDecision

Parâmetros aceitos

Payload

GET /rest/supervisorgs/supervisor

Parâmetros aceitos

Retorno

Árvore de páginas

Histórico da Página

Versões comparadas

Versão antiga 11

Nova versão Atual

Chave

Objetivos

Determinar os serviços que serão consumidos aplicativo TOTVS Supervisor Minha Gestão de Postos.

GET /rest/supervisorgs/checkin

Parâmetros aceitos

Retorno

GET /rest/supervisorgs/appointments

Parâmetros aceitos

Retorno

GET /

rest/

supervisorgs/

stations

Parâmetros aceitos

Payload

Retorno

GET /rest/supervisorgs/clients

Parâmetros aceitos

Retorno

PUT /wsatf001/assets/{asset}/{item}

GET /rest/supervisorgs/regions

Parâmetros aceitos

Retorno

PUT /wsatf001/assets/{asset}/{item}/image

GET /rest/supervisorgs/places

Parâmetros aceitos

Payload

Retorno

POST /rest/supervisorgs/operationalDecision

Parâmetros aceitos

Payload

GET /rest/supervisorgs/supervisor

Parâmetros aceitos

Retorno