Consulta
POST
Inclusão
Alteração
Exclusão
Para clientes que possuem rotinas ou aplicativos customizados e precisam consultar e alterar as informações na rotina Valores Acessórios(FINA040VA), foram disponibilizados métodos Web Service REST.
| GET Consulta | POST | PUT Alteração | DELETE Exclusão |
| | | |
Para realizar testes, pode ser utilizado qualquer programa de sua preferência, que teste API Web Service REST.
Como exemplos de programas, podemos citar o SoapUI ou Postman . Ambos são excelentes aplicativos.
Os exemplo a seguir serão demonstrados utilizando programa Postman, executando os métodos GET, POST, PUT e DELETE.
Para inclusão ou alteração do registro, pode utilizar a mesma estrutura (body), os campos podem ser adicionados dentro da tag FIELDS.
Maiores detalhes referente a montagem da estrutura, verificar modelo abaixo.
Onde:
id: é id da API
operation: é o código da operação, valor padrão: 1,
pk: é a chave primária do alias do modelo de dados encodado em base64,
models: são os modelos de negócios de cada API, ou seja, modelo de dados do MVC, que é definido por:
id: é o modelo de dados definido no MVC
modeltype: é tipo de modelo de dados, "FIELDS" ou "GRID"
fields: é um vetor com os campos, definido por:
id: é nome do campo
order: ordem do campo na tabela SBE
value: é o valor do campo
Importante Por padrão, para realizar consulta, alteração ou deleção de um determinado dado do servidor através dos métodos GET, PUT ou DELETE, é necessário informar a PK (Primary Key), valor da chave primaria do alias do modelo, encodado em base64, caso contrário não informado, serão retornado os registros conforme sua paginação. |
a. PUT
{
"id": "FINA040VA",
"operation": 4,
"pk": "RCBNRyAwMSBEIE1HIDAxICAgIDAwMDM4NiAgICBORiAwMDAwMDEwMQ==",
"models": [
{
"id": "SE1MASTER",
"modeltype": "FIELDS",
"fields": [
],
"models": [
{
"id": "FK7DETAIL",
"modeltype": "GRID",
"optional": 1,
"struct": [
],
"items": [
{
"id": 1,
"deleted": 0,
"fields": [
]
}
]
},
{
"id": "FKDDETAIL",
"modeltype": "GRID",
"struct": [
],
"items": [
{
"id": 1,
"deleted": 0,
"fields": [
{
"id": "FKD_CODIGO",
"value": "000004"
},
{
"id": "FKD_VALOR",
"value": "1100.00"
}
]
}
]
}
]
}
]
} |
b. GET
{
"id": "FINA040VA",
"operation": 1,
"pk": "RCBNRyAwMSBEIE1HIDAxICAgIDAwMDM4NiAgICBORiAwMDAwMDEwMQ==",
"models": [
{
"id": "SE1MASTER",
"modeltype": "FIELDS",
"fields": [
{
"id": "E1_FILIAL",
"order": 1,
"value": "D MG 01"
},
{
"id": "E1_NUM",
"order": 3,
"value": "000386"
},
{
"id": "E1_TIPO",
"order": 5,
"value": "NF"
},
{
"id": "E1_NATUREZ",
"order": 6,
"value": "001"
},
{
"id": "E1_CLIENTE",
"order": 9,
"value": "000001"
},
{
"id": "E1_LOJA",
"order": 10,
"value": "01"
},
{
"id": "E1_NOMCLI",
"order": 11,
"value": "CLIENTE PADRAO"
},
{
"id": "E1_EMISSAO",
"order": 12,
"value": "20151008"
},
{
"id": "E1_VENCTO",
"order": 13,
"value": "20151008"
},
{
"id": "E1_VENCREA",
"order": 14,
"value": "20151008"
},
{
"id": "E1_VALOR",
"order": 15,
"value": "9000.00"
},
{
"id": "E1_EMIS1",
"order": 24,
"value": "20151008"
},
{
"id": "E1_SITUACA",
"order": 31,
"value": "0"
},
{
"id": "E1_SALDO",
"order": 33,
"value": "9000.00"
},
{
"id": "E1_MOEDA",
"order": 48,
"value": "1"
},
{
"id": "E1_OCORREN",
"order": 57,
"value": "01"
},
{
"id": "E1_VLCRUZ",
"order": 62,
"value": "9000.00"
},
{
"id": "E1_STATUS",
"order": 64,
"value": "A"
},
{
"id": "E1_ORIGEM",
"order": 65,
"value": "FINA040"
},
{
"id": "E1_FLUXO",
"order": 68,
"value": "S"
},
{
"id": "E1_TIPODES",
"order": 71,
"value": "1"
},
{
"id": "E1_FILORIG",
"order": 85,
"value": "D MG 01"
},
{
"id": "E1_MULTNAT",
"order": 101,
"value": "2"
},
{
"id": "E1_PROJPMS",
"order": 102,
"value": "2"
},
{
"id": "E1_DESDOBR",
"order": 103,
"value": "2"
},
{
"id": "E1_MODSPB",
"order": 105,
"value": "1"
},
{
"id": "E1_SCORGP",
"order": 146,
"value": "2"
},
{
"id": "E1_RELATO",
"order": 177,
"value": "2"
},
{
"id": "E1_APLVLMN",
"order": 187,
"value": "1"
},
{
"id": "E1_VLMINIS",
"order": 196,
"value": "1"
},
{
"id": "E1_TPDESC",
"order": 200,
"value": "C"
},
{
"id": "E1_RATFIN",
"order": 201,
"value": "2"
},
{
"id": "E1_MSUIDT",
"order": 231,
"value": "E79042B9-11BB-4A1A-AF62-F85C6C337A0D"
}
],
"models": [
{
"id": "FK7DETAIL",
"modeltype": "GRID",
"optional": 1,
"struct": [
{
"id": "FK7_FILIAL",
"order": 1
},
{
"id": "FK7_IDDOC",
"order": 2
},
{
"id": "FK7_ALIAS",
"order": 3
},
{
"id": "FK7_CHAVE",
"order": 4
},
{
"id": "FK7_FILTIT",
"order": 5
},
{
"id": "FK7_PREFIX",
"order": 6
},
{
"id": "FK7_NUM",
"order": 7
},
{
"id": "FK7_PARCEL",
"order": 8
},
{
"id": "FK7_TIPO",
"order": 9
},
{
"id": "FK7_CLIFOR",
"order": 10
}
],
"items": [
{
"id": 1,
"deleted": 0,
"fields": [
{
"id": "FK7_FILIAL",
"value": "D MG 01"
},
{
"id": "FK7_IDDOC",
"value": "242940befdd2400085327422191116f6"
},
{
"id": "FK7_ALIAS",
"value": "SE1"
},
{
"id": "FK7_CHAVE",
"value": "D MG 01 | |000386 | |NF |000001|01"
},
{
"id": "FK7_FILTIT",
"value": "D MG 01"
},
{
"id": "FK7_NUM",
"value": "000386"
},
{
"id": "FK7_TIPO",
"value": "NF"
},
{
"id": "FK7_CLIFOR",
"value": "000001"
}
]
}
]
},
{
"id": "FKDDETAIL",
"modeltype": "GRID",
"optional": 1,
"struct": [
{
"id": "FKD_FILIAL",
"order": 1
},
{
"id": "FKD_CODIGO",
"order": 2
},
{
"id": "FKD_VALOR",
"order": 8
},
{
"id": "FKD_IDDOC",
"order": 9
},
{
"id": "FKD_SALDO",
"order": 10
},
{
"id": "FKD_DTBAIX",
"order": 11
},
{
"id": "FKD_VLCALC",
"order": 13
},
{
"id": "FKD_VLINFO",
"order": 14
},
{
"id": "FKD_IDFKD",
"order": 15
}
],
"items": [
{
"id": 1,
"deleted": 0,
"fields": [
{
"id": "FKD_FILIAL",
"value": "D MG 01"
},
{
"id": "FKD_CODIGO",
"value": "000004"
},
{
"id": "FKD_VALOR",
"value": "1000.00"
},
{
"id": "FKD_IDDOC",
"value": "242940befdd2400085327422191116f6"
},
{
"id": "FKD_VLCALC",
"value": "1000.00"
},
{
"id": "FKD_IDFKD",
"value": "C95E4F8636D04E118E3DAC5AFCAD9E8A"
}
]
}
]
}
]
}
]
} |
FWRestModel - API RESTful dos modelos de dados do Protheus
Integração do Easy Import Control via API REST