Custom Get

Descrição

O método customizado GetCustomInfo obtém as informações de uma pesquisa personalizada.

---

Request HTTP Post

Tipo da Requisição	URL Exemplo
POST	{{url_base}}/GetCustomInfo
Exemplo	http://seuIPePorta/datasnap/rest/RESTWebServiceMethods/"GetCustomInfo"

Parâmetros de Entrada

Parâmetro	Tipo	Obrigatório	Descrição
CustomInfoScriptName	String(50)	Sim	Nome da consulta personalizada
CustomInfoParameterList	CustomInfoParameterList	Não	Lista de objetos com os parâmetros de execução da pesquisa

📝 Objeto CustomInfoParameter

Descrição

O objeto CustomInfoParameter representa um parâmetro para executar a consulta personalizada.

Parâmetros de Entrada

Parâmetros	Tipo	Obrigatório	Descrição
ParamName	String(30)	Sim	Nome do parâmetro personalizado
ParamValue	String(50)	Sim	Valor do parâmetro personalizado
ParamType	CustomInfoParamType	Não	Tipo do parâmetro (cipNotAssigned, cipString, cipNumeric, cipDateTime)

---

Retorno

Parâmetro	Tipo	Obrigatório	Descrição
WebServiceReturn	WebServiceReturn	Sim	Informações padrão de resposta do Webservice na execução do método
CustomInfoResultList	GetCustomInfoResultList	Sim	Lista de objetos com as informações de retorno da consulta personalizada

📝 Objeto GetCustomInfoResult

Descrição

O objeto GetCustomInfoResult representa um retorno da consulta personalizada.

Parâmetros de Entrada

Parâmetro	Tipo	Obrigatório	Descrição
ResultRowInfoList	GetCustomInfoResultFieldList	Sim	Lista de objetos com todas as colunas e valores retornados pela linha de resultado da consulta

📝 Objeto GetCustomInfoResultField

Descrição

O objeto GetCustomInfoResultField representa uma coluna de uma linha da consulta personalizada.

Parâmetros de Entrada

Parâmetro	Tipo	Obrigatório	Descrição
FieldName	String(30)	Sim	Nome da coluna retornada em uma linha de resultado da consulta personalizada
FieldValue	String(2000)	Sim	Valor da coluna retornada em uma linha de resultado da consulta personalizada

---

Exemplo de Request

curl --location --request POST '{{url_base}}/GetCustomInfo' \
--header 'Content-Type: application/json;charset=UTF-8' \
--data-raw '{
{
  "CustomInfoScriptName": "SP_Obter_Relatorio_Vendas",
  "CustomInfoParameterList": [
    {
      "ParamName": "DataInicio",
      "ParamValue": "01-2024",
      "ParamType": "cipString"
    },
    {
      "ParamName": "Filial",
      "ParamValue": "12345",
      "ParamType": "cipNumeric"
    }
  ]
}

Exemplo de Response

{
  "WebServiceReturn": {
    "Success": true,
    "Message": "Consulta executada com sucesso."
  },
  "CustomInfoResultList": [
    {
      "ResultRowInfoList": [
        {
          "FieldName": "Produto",
          "FieldValue": "Carne Bovina"
        },
        {
          "FieldName": "Quantidade",
          "FieldValue": "1000"
        },
        {
          "FieldName": "ValorTotal",
          "FieldValue": "25000.00"
        }
      ]
    }
  ]
}