Objetivos

Determinar os serviços que estarão disponíveis no Protheus para que haja compatibilidade entre o módulo de Ativo Fixo e o aplicativo Meus Ativos Fixos.

GET /wsatf001/entities

Retorna a lista de notas e ativos 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".

Retorno

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

Exemplo de retorno da requisição:

GET /wsatf001/entities?page=1&pageSize=2&searchKey="Gr"

{
	"hasNext": true,
	"entities" : [
		{
			"type": 0,
			"asset": "00001",
			"item": "00001",
			"description": "Grua",
			"invoice": null,
			"series": null,
			"supplier": null,
			"unit": null
		},
		{
			"type": 1,
			"asset": null,
			"item": null,
			"description": null,
			"invoice": "000001",
			"series": "01",
			"supplier": {
				"name": "Grupo JLima",
				"id": "000001"
			},
			"unit": "0001"
		},
	]
}

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

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

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

Exemplo de retorno da requisição:

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

{
	"location": {
		"lat": -23.5084952, 
		"lng": -46.6536569,
		"local": {
			"code": "0000001".
			"description": "BRAZ LEME"
		}
	},
	"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.

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.

Exemplo de retorno da requisição:

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

{
	"location": {
		"lat": -23.5084952, 
		"lng": -46.6536569,
		"local": "0000001"
	},
	"image": true,
	"fields": [
		{
			"identifier": "N3_HISTOR",
			"type": "string",
			"value": "01",
			"label": "Histórico"
		},
		{
			"identifier": "N3_BAIXA",
			"type": "string",
			"value": "false",
			"label": "Baixado"
		}
	]
}

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

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

Retorno

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

Exemplo de retorno da requisição:

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

{
	"fields": [
		{
			"identifier": "NUMNOTA",
			"type": "string",
			"value": "000001",
			"label": "Número da nota"
		},
		{
			"identifier": "SERIE",
			"type": "string",
			"value": "01",
			"label": "Série da nota"
		}
	],
	"items" : [
			"item": "01",
			"product" : "Grua",
			"quantity" : 2
	],
	"assets": [
		"asset" : "000001",
		"item": "00001",
		"description" : "Grua"
	]
}

GET /wsatf001/invoices/{supplier}/{unit}/{invoice}/{series}

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

Retorno

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

Exemplo de retorno da requisição:

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

{
	"fields": [
		{
			"identifier": "NUMNOTA",
			"type": "string",
			"value": "000001",
			"label": "Número da nota"
		},
		{
			"identifier": "SERIE",
			"type": "string",
			"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:

• GET /wsatf001/fields/assets
• GET /wsatf001/fields/balances
  
  

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.

Exemplo de retorno da requisição:

GET /wsatf001/fields/invoices?language=pt

{
	"fields": [
		{
			"identifier": "NUMNOTA",
			"type": "string",
			"label": "Número da nota"
		},
		{
			"identifier": "SERIE",
			"type": "string",
			"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.

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:

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. Este serviço pode ser usado de duas formas: enviando lat e lng para atualizar a geolocalização, ou enviando o local para atualizar o N1_LOCAL.

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

- local: Código do local cadastrado no Protheus.

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

Exemplo 1: Atualizando a geolocalização


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


Exemplo 2: Atualizando o N1_LOCAL:
{
 "type": "local",
 "location": {
 	"local": "000001"
 }
}

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

GET /wsatf001/assets/locations

Serviço para retornar a lista de locais possíveis que podem ser selecionados ao atualizar a localização (N1_LOCAL) de um ativo.

O serviço deve aceitar os parâmetros page, pageSize e searchKey, que fará uma busca na descrição (description) e no código (code) do local. Os dados devem ser retornados em ordem alfabética crescente.

 O retorno deve obedecer à estrutura:

{
         “hasNext”: true,
         “locations”: [
                   {
                            “code”: “0000001”,
                            “description”:“BRAZ LEME”
                   },
                   {
                            “code”:“0000002”,
                            “description”: “CANINDE”
                   }
         ]
}

O retorno da requisição, em caso de sucesso, deve ser um HTTP 200 OK.