Í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

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

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

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

Não existe parametros.

e

Retorno

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

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

language	js
theme	RDark
title	response.json
collapse	true

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

são aceitos parâmetros de URL para esta requisição.

Parâmetro

Propriedade

	Tipo	Descrição

Adicional

Valor Default

regions

nPage

ArrayArray com os locais

Numeric

Página da Consulta

-

regions[x].code

stringCódigo do local.-

regions[x].desc

stringDescrição do local.-

count

NumericQantidade de locais.-

GET rest/SUPERVISORGS/palces

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

language	js
theme	RDark
title	response.json
collapse	true

Bloco de código

language	js
theme	RDark
title	response.json
collapse	true

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

cCode

numberIndica qual solicitação está sendo requisitada.

0: Baixa

1: Transferência

2: Ampliação

assetstringCódigo do ativoitemstringItem do ativorequests[].statusstringStatus da solicitação

0: Pendente

1: Finalizada

2: Cancelada

requests[].datedataData da solicitaçãoFormato data Protheus "YYYYMMDD"requests[].reasonstringMotivo (descrição)

Se operation=0 -> Motivo

Se operation=1 -> Detalhes

Se operation=2 -> Observação

requests[].valuenumberValorSó existe se operation for 1requests[].quantitynumberQuantidade que for baixadaSó existe se operation for 0requests[].balancestringSaldo que foi baixadoSó existe se operation for 0requests[].typestringTipo 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

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": "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"
}

Bloco de código

language	js
theme	RDark
title	response.json
collapse	true

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

Árvore de páginas

Versões comparadas

Versão antiga 20

Nova versão Atual

Chave

Objetivos

GET /rest/supervisorgs/checkin

Parâmetros aceitos

Retorno

GET /rest/supervisorgs/appointments

Parâmetros aceitos

Retorno

GET /rest/supervisorgs/stations

Parâmetros aceitos

Retorno

GET /rest/supervisorgs/clients

Parâmetros aceitos

Retorno

Retorno

GET /rest/supervisorgs/regions

Parâmetros aceitos

Retorno

GET /rest/supervisorgs/places

Parâmetros aceitos

Retorno

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 20

Nova versão Atual

Chave

Objetivos

GET /rest/supervisorgs/checkin

Parâmetros aceitos

Retorno

GET /rest/supervisorgs/appointments

Parâmetros aceitos

Retorno

GET /rest/supervisorgs/stations

Parâmetros aceitos

Retorno

GET /rest/supervisorgs/clients

Parâmetros aceitos

Retorno

Retorno

GET /rest/supervisorgs/regions

Parâmetros aceitos

Retorno

GET /rest/supervisorgs/places

Parâmetros aceitos

Retorno

Retorno

POST /

rest/

supervisorgs/

operationalDecision

Parâmetros aceitos

Payload

GET /rest/supervisorgs/supervisor

Parâmetros aceitos

Retorno