Objetivos 

...

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

GET /rest/supervisorgs/checkin

Retorna a lista de checkins 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".

e

Retorno

O serviço deve retornar as propriedades informadas, de acordo com os parâmetros passados na consulta.

...

{
   "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 Retorna os detalhes de um ativo identificado pelos parâmetros asset e item 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".

Retorno

Retorno

O serviço deve retornar O serviço deve retornar as propriedades informadas, de acordo com os parâmetros passados na consulta.

appointments

Exemplo de retorno da requisição:

GET /wsatf001/assets/00001/00001?language=pt&fields=name,description,quantity

{
	"location": {
		"lat": -23.5084952, 
		"lng": -46.6536569,
		"addess": "0000001"
	},
	"image": true,
	"fields": [
		{
			"identifier": "N1_NOME",
			"type": "string",
			"value": "Grua",
			"label": "Nome"
		},
		{
			"identifier": "N1_DESC",
			"type": "string",
			"value": "Grua 20 metros amarela",
			"label": "Descrição"
		},
		{
			"identifier": "N1_QTDE",
			"type": "number",
			"value": "2",
			"label": "Quantidade"
		},
	],
	"invoices" : [
		{
		   "name": "Grupo JLima",
			"supplier": "000001",
			"unit": "000001",
			"invoice": "0000001",
			"series": "01"
		}
	],
	"balances": [
		{
			"asset_type": "0001",
			"balance_type": "00001",
			"history": '',
			"write_off": false,
			"sequence": "00001"
		}
	]
}

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

Retorna a imagem vinculada ao ativo identificado pelos parâmetros asset e item na url.

Parâmetros aceitos

O parâmetro sera passados por queryParams.

...

Retorno

O serviço deve retornar as propriedades informadas, de acordo com os parâmetros passados na consulta.

...

appointments[x].code

appointments[x].attendant

appointments[x].schedule

appointments[x].realschedule

appointments[x].inout

appointments[x].desc

appointments[x].late

appointments[x].executed

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

Retorno

O serviço deve retornar as propriedades informadas, de acordo com os parâmetros passados na consulta.

stations

stations[x].code

stations[x].desc

stations[x].type

stations[x].lat

stations[x].long

count

GET rest/SUPERVISORGS/stations?nSituation=3&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

Exemplo de retorno da requisição:

GET /wsatf001/assets/00001/00001/image

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

GET /wsatf001/assets/{asset}/{item}/balances/{asset_type}/{balance_type}/{write_off}/{sequence}

Retorna os detalhes de um saldo do ativo.

O ativo será identificado pelos parâmetros asset e item e o saldo será identificado pelo parâmetros  asset_type, balance_type, write_off e sequence.

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

Retorno

O serviço deve retornar as propriedades informadas, de acordo com os parâmetros passados na consulta.

clients

Exemplo de retorno da requisição:

GET /wsatf001/assets/00001/00001/balances/000001/000001/001/01?language=pt&fields=history,write_off

clients[x].code

clients[x].desc

clients[x].store

clients[x].check

hasNext

count

GET rest/SUPERVISORGS/clients

{
	"location    "clients": [
        {
			"latcode": -23.5084952, 
"001",
			"lngstore": -46.6536569"01",
			"localcheck": "0000001false",
	},
		"imagedesc": true,
	"fields": [ "CLIENTE 001"
		},
		{
			"identifiercode": "N3_HISTOR000001",
			"typestore": "string01",
			"valuecheck": "01false",
			"labeldesc": "HistóricoCLIENTE PADRAO P/ ORCAMENTO"
		},
		{
			"identifiercode": "N3_BAIXAEX0001",
			"typestore": "string01",
			"valuecheck": "false",
			"labeldesc": "BaixadoCLIENTE 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.

Retorno

O serviço deve retornar as propriedades informadas, de acordo com os parâmetros passados na consulta.

Retorna a nota vinculada de um ativo identificado pelos parâmetros asset e item.

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

regions

Retorno

O serviço deve retornar as propriedades informadas, de acordo com os parâmetros passados na consulta.

...

regions[x].code

regions[x].desc

count

GET rest/SUPERVISORGS/clients

{
    "regions": [
        {
			"code": "001",
			"desc": "Norte"
		},
		{
			"code": "002",
			"desc": "Sul"
		},
		{
			"code": "003

...

Exemplo de retorno da requisição:

GET /wsatf001/assets/00001/00001/invoice?fields=numnota,serie

{
	"fields": [
		{
			"identifier": "NUMNOTA",
			"typedesc": "stringLeste"
		},
		{
			"valuecode": "000001004",
			"labeldesc": "Número da notaOeste"
		},
		{
			"identifiercode": "SERIE005",
			"typedesc": "stringCentro",
			"value": "01"},
			"label": "Série da nota"{
		}
	],
	"itemscode" : [
			"item006": "01",
			"productdesc" : "GruaCentro oeste",
			"quantity" : 2}
	],
	"assetscount": [
		"asset" : "000001",
		"item": "00001",
		"description" : "Grua"
	]
}5
}

GET /

...

rest/

...

supervisorgs/places

Retorna a lista dos locais disponiveis na urlRetorna a nota vinculada identificada pelos parâmetros supplier e unit, invoice e series.

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"Não são aceitos parâmetros de URL para esta requisição.

Retorno

O serviço deve retornar as propriedades informadas, de acordo com os parâmetros passados na consulta.

regions

regions[x].code

regions[x].desc

Exemplo de retorno da requisição:

GET /wsatf001/assets/invoices/00001/00001/000001/01?fields=numnota,serie

count

GET rest/SUPERVISORGS/places

{
    "places": [
        {
			"code": "00000001",
			"desc": "TOTVS SITE SP"
		},
		

{
	"fields": [
		{
			"identifiercode": "NUMNOTA00000002",
			"typedesc": "string",TOTVS MATRIZ - 1000"
		},
		{
			"valuecode": "00000100000003",
			"labeldesc": "NúmeroCASA daDO notaGUILHERME"
		},
		{
			"identifiercode": "SERIE00000004",
			"typedesc": "stringIBIRAPUERA",
			"value": "01",
			"label": "Série da nota"
		}
	],
	"items" : [
			"item": "01",
			"product" : "Grua",
			"quantity" : 2
	],
	"assets": [
		"asset" : "000001",
		"item": "00001",
		"description" : "Grua"
	]
}

GET /wsatf001/fields/{fieldType}

Retorna os campos disponíveis para um tipo específico identificado pelo fieldType.

Os fieldTypes aceitos são: 'assets', 'balances', 'invoices', correspondendo assim à 3 endpoints distintos:

...

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

cCode

Post /rest/SUPERVISORGS/operationalDecision

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

Retorno

O serviço deve retornar as propriedades informadas, de acordo com os parâmetros passados na consulta.

supervisor

supervisor[x].code

Exemplo de retorno da requisição:

supervisor[x].desc

count

GET rest/SUPERVISORGS/supervisorGET /wsatf001/fields/invoices?language=pt

{
	"fields    "supervisor": [
		{
			"identifier        {
            "code": "NUMNOTAD MG  01000023",
			"type": "string",
			"label            "desc": "NúmeroFUNCIONARIO da notaA"
		        },
		{
			"identifier        {
            "code": "SERIED MG  01000025",
			"type            "desc": "stringFUNCIONARIO C",
			"label": "Série da nota"
		}
	]
}

GET /wsatf001/requests

Retorna as solicitações do histórico disponíveis para consulta no aplicativo..

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

...

Retorno

O serviço deve retornar as propriedades informadas, de acordo com os parâmetros passados na consulta.

...

0: Baixa

1: Transferência

2: Ampliação

...

0: Pendente

1: Finalizada

2: Cancelada

...

Se operation=0, será retornado o motivo.

Se operation=1, serão retornados os detalhes

Se operation=2, será retornada a observação

...

Exemplo de retorno da requisição:

GET /wsatf001/requests?page=1&pageSize=1

{
    "hasNext": false,
    "requests": [
        {
            "operation": "0",
            "status": "0",
            "reason": "fazer a baixa de quantidade 10 saldo tipo gerencial balanco gerencial                                                                                                                                                                                     ",
            "quantity": 10,
            "balances": [
                {
                    "type": "10",
                    "balance_type": "3"
                }
            ],
            "date": "20171010",
            "value": 0
        },
}

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:

...

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)

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

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

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.

Payload

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

...

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

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

{
 "location": {
 "lat": -93.5084952,
 "lng": -96.6536569
 }
}

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

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:

...

Exemplo de retorno da requisição:

- location: Array com a localização.

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

{
	"content": "data:image/jpeg;base64,/9j/4AAQSkZJRgABAQEAagBqAAD/4RDc...........(continuação do conteúdo da imagem)
        },
        {
            "code": "D MG  01000029",
            "desc": "FUNCIONARIO AA"
        },
        {
            "code": "D MG  01000030",
            "desc": "FUNCIONARIO BB"
        }
    ],
    "hasNext": "false"
}