Informações Gerais

...

 Microsiga Protheus

...

Módulo

...

 UBA

...

Segmento Executor

...

 Serviços

...

Projeto

...

IRM

...

Requisito

...

Subtarefa

Todos os serviços disponibilizados devem filtrar sua resposta e comportamento de acordo com a respectiva empresa e filial enviadas no cabeçalho da requisição HTTP (Padrão Protheus, header tenantId).

O Login utilizado será o mesmo padrão Protheus.

Objetivos

Os serviços especificados neste serão consumidos pelo aplicativo "Coleta de Algodão" e tem por objetivo permitir ao usuário consultar e criar cadastros de sardões no módulo UBA do Protheus através de um smartphone ou tablet.

Definições dos Serviços

GET /agra601/crops

Retorna a lista de safras, baseado na tabela NN1 (SAFRAS)

Parâmetros aceitos:
- page: retorna a página desejada
- pageSize: retorna o tamanho da página desejada
- searchKey: faz uma busca pelo ano ou pela sequência

Retorno esperado:
200 OK

{
	"hasNext" : boolean,
	"items" : [
		{
			"code": string (NN1_ANO + NN1_SEQ),
			"year": number (NN1_ANO),
			"sequence": string (NN1_SEQ),
			"description": string (NN1_DESCRI),
			"product": string (NN1_CODPRO),
			"product_description": string (NN1_DESPRO)
		}
	]
}

GET /agra601/farmers

Retorna a lista de produtores e lojas, baseado na tabela DX8 (PRODUTORES)

Parâmetros aceitos:
- page: retorna a página desejada
- pageSize: retorna o tamanho da página desejada
- searchKey: faz uma busca pelo nome, nome reduzido, loja ou pelo código do produtor

Retorno esperado:
200 OK

{
	"hasNext": boolean,
	"items" : [
		{
			"code": string (DX8_CODIGO),
			"unit", string (DX8_LOJA),
			"name": string (DX8_NOME),
			"short_name": string (DX8_NMREDU)
		}
	]
}

GET /agra601/farmers/:farmerId/:farmerUnit/farms

Retorna a lista de fazendas, de acordo com um produtor indicado pelo parâmetro :farmerId e pela loja indicada pelo parâmetro :farmerUnit, baseado na tabela NN2 (FAZENDAS)

Parâmetros aceitos:
- page: retorna a página desejada
- pageSize: retorna o tamanho da página desejada
- searchKey: faz uma busca pelo nome da fazenda ou pelo código da fazenda

Retorno esperado:
200 OK

{
	"hasNext": boolean,
	"items" : [
		{
			"code": string (NN2_CODIGO),
			"name": string (NN2_NOME),
			"status": string (NN2_ATIVA),
			"farmer": string (NN2_PRDTOR),
			"farmer_unit": string (NN2_LJPRO)
		}
	]
}

GET /agra601/places

Retorna a lista de locais de estoque, baseado na tabela NNR (LOCAIS DE ESTOQUE)

Parâmetros aceitos:
- page: retorna a página desejada
- pageSize: retorna o tamanho da página desejada
- searchKey: faz uma busca pelo código ou descrição do local de estoque

Retorno esperado:
200 OK

{
	"hasNext": boolean,
	"items" : [
		{
			"code": string (NNR_CODIGO),
			"description": string (NNR_DESCRI)
		}
	]
}

GET /agra601/plots

Retorna a lista de talhões, baseado na tabela NN3 (TALHÕES)

Parâmetros aceitos:
- crop: Código da safra para filtro
- farm: Código da fazenda para filtro
- page: retorna a página desejada
- pageSize: retorna o tamanho da página desejada
- searchKey: faz uma busca geral pelos campos chave do talhão

Retorno esperado:
200 OK

{
	"hasNext": boolean,
	"items" : [
		{
			"plot": string (NN3_TALHAO),
			"description": string (NN3_DESCRI),
			"crop": string (NN3_SAFRA),
			"farm": string (NN3_FAZ),
			"closed": string (NN3_FECHAD)
		}
	]
}

GET /agra601/plots/varieties

Retorna a lista de variedades dos talhões, baseado na tabela NN4 (VARIEDADES DOS TALHÕES)

Parâmetros aceitos:
- crop: Código da safra para filtro
- farm: Código da fazenda para filtro
- plot: Código do talhão para filtro
- page: retorna a página desejada
- pageSize: retorna o tamanho da página desejada
- searchKey: faz uma busca geral pelos campos chave das variedades do talhão

Retorno esperado:
200 OK

{
	"hasNext": boolean,
	"items" : [
		{
			"plot": string (NN4_TALHAO),
			"crop": string (NN4_SAFRA),
			"farm": string (NN4_FAZ),
			"item": string (NN4_ITEM),
			"code": string (NN4_CODVAR),
			"description": string (NN4_DESVAR)
		}
	]
}

GET /agra601/varieties

Retorna a lista de variedades, baseado na tabela NNV (VARIEDADES)

Parâmetros aceitos:
- page: retorna a página desejada
- pageSize: retorna o tamanho da página desejada
- searchKey: faz uma busca pelo código ou pela descrição da variedade

Retorno esperado:
200 OK

{
	"hasNext": boolean,
	"items" : [
		{
			"code": string (NNV_CODIGO),
			"description": string (NNV_DESCRI)
		}
	]
}

GET /agra601/modules

Retorna a lista de fardões, baseado na tabela DXL (FARDÕES)

Parâmetros aceitos:
- crop: Código da safra (ANO+SEQ) para filtro
- farmer: Código do produtor para filtro
- unit: Loja do produtor para filtro
- farm: Código da fazenda para filtro
- page: retorna a página desejada
- pageSize: retorna o tamanho da página desejada
- searchKey: faz uma busca pelo nome do código ou pela descrição da variedade

Retorno esperado:
200 OK

{
	"hasNext": boolean,
	"items" : [
		{
			"code": string (DXL_CODIGO),
			"crop": string (DXL_SAFRA),
			"farmer": string (DXL_PRDTOR),
			"famerName": string (DXL_NMPDTR)
			"unit": string (DXL_LJPRO),
			"farm": string (DXL_FAZ),
			"farmName": string (DXL_NMFAZ),
			"plot": string (DXL_TALHAO),
			"variety": string (DXL_CODVAR),
			"varietyName": string (DXL_DESCVR),
			"place": string (DXL_LOCAL),
			"bordery": string (DXL_BORDA),
			"pressing_type": string (DXL_TPRENS),
			"estimated_weight": number (DXL_PSESTI),
			"estimated_yield": number (DXL_RDMTOP),
			"obs": string (DXL_OBS),
			"status": string (DXL_STATUS),
			"lat": string (DXL_YLATCO),
			"lng": string (DXL_YLONCO)
		}
	]
}

POST /agra601/modules

Cria um fardão de acordo com os dados informados no corpo da requisição realizando todas as verificações de regra de negócio da rotina.

Playload:

{
	"code": string (Código de barras colhito/digitado),
	"crop": string (Código da Safra),
	"farmer": string (Código do Produtor),
	"unit": string (Loja do Produtor),
	"farm": string (Código da Fazenda),
	"plot": string (Código do Talhão),
	"variety": string (Código da Variedade),
	"place": string (Código do Local),
	"bordery": string (Indicador se o fardão é de bordadura,  1-sim e 2-não),
	"pressing_type": string (Tipo de prensagem do fardão, 1-cilíndrica e 2-retangular),
	"estimated_weight": number (Peso estimado),
	"estimated_yield": number (Rendimento previsto),
	"obs": string (Observações),
	"status": "1" (será considerado que o fardão está ativo),
	"lat": string (Latitude do fardão, novo campo DXL_YLATCO),
	"lng": string (Longitude do fardão, novo campo DXL_YLONCO)
}

Resposta esperada:

201 Created

PUT /agra601/modules/:moduleId

Atualiza os dados de um fardão conforme informações enviadas realizando todas as verificações de regra de negócio da rotina.
O parâmetro :moduleId indica qual fardão será atualizado.
O corpo da mensagem será idêntico ao serviço de criação, sendo que os campos não enviados devem ser desconsiderados.