get https://example.com/loadRecord
Regras de negócio
A API possui um serviço genérico para aplicar consultas em todas as Entidades disponíveis no ERP: CRUDServiceProvider.loadRecord com o objetivo de obter 1 registro. O escopo da requisição é mais simples que CRUDServiceProvider.loadRecord e exige apenas o envio dos critérios por meio da tag "rows".
Exemplo de uso:
URL de chamada: https://api.sankhya.com.br/gateway/v1/mge/service.sbr?serviceName=CRUDServiceProvider.loadRecord&outputType=json
Vejamos a seguir a estrutura completa de uma requisição do serviço loadRecords:
{
"serviceName": "CRUDServiceProvider.loadRecord",
"requestBody": {
"dataSet": {
"rootEntity": "Produto",
"entity": [
{
"path": "",
"fieldset": {
"list": "CODPROD, DESCRPROD"
}
},
{
"path": "GrupoProduto",
"fieldset": {
"list": "CODGRUPOPROD, DESCRGRUPOPROD"
}
},
{
"path": "AliquotaIPI",
"fieldset": {
"list": "CODIPI, PERCENTUAL"
}
}
],
"rows": {
"row": {
"CODPROD": {
"$": "4"
}
}
}
}
}
}
O retorno para esta requisição é:
{
"serviceName": "CRUDServiceProvider.loadRecord",
"status": "1",
"pendingPrinting": "false",
"transactionId": "2B265FCF92393625B097EDE09B031295",
"responseBody": {
"entities": {
"total": "1",
"entity": {
"GrupoProduto_CODGRUPOPROD": {
"$": "10401"
},
"AliquotaIPI_PERCENTUAL": {
"$": "3"
},
"GrupoProduto_DESCRGRUPOPROD": {
"$": "REVENDA DE PRODUTO IMPORTADO"
},
"_rmd": {
"CODPROD": {
"$": "{\"decVlr\":2,\"decQtd\":0,\"controle\":{\"tipoContEst\":\"N\",\"listaContEst\":[\"\"],\"usaMascara\":false}}",
"provider": "PRODUTORMP"
}
},
"DESCRPROD": {
"$": "AGUA TONICA "
},
"CODPROD": {
"$": "4"
},
"AliquotaIPI_CODIPI": {
"$": "2"
}
}
}
}
}