Custom Get

Descripción

El método personalizado GetCustomInfo obtiene la información de una búsqueda personalizada.

---

Request HTTP Post

Tipo de Solicitud	URL Ejemplo
POST	{{url_base}}/GetCustomInfo
Ejemplo	http://suIPyPuerto/datasnap/rest/RESTWebServiceMethods/"GetCustomInfo"

Parámetros de Entrada

Parámetro	Tipo	Obligatorio	Descripción
CustomInfoScriptName	String(50)	Sí	Nombre de la consulta personalizada
CustomInfoParameterList	CustomInfoParameterList	No	Lista de objetos con los parámetros de ejecución de la búsqueda

📝 Objeto CustomInfoParameter

Descripción

El objeto CustomInfoParameter representa un parámetro para ejecutar la consulta personalizada.

Parámetros de Entrada

Parámetros	Tipo	Obligatorio	Descripción
ParamName	String(30)	Sí	Nombre del parámetro personalizado
ParamValue	String(50)	Sí	Valor del parámetro personalizado
ParamType	CustomInfoParamType	No	Tipo del parámetro (cipNotAssigned, cipString, cipNumeric, cipDateTime)

---

Retorno

Parámetro	Tipo	Obligatorio	Descripción
WebServiceReturn	WebServiceReturn	Sí	Información estándar de respuesta del Webservice en la ejecución del método
CustomInfoResultList	GetCustomInfoResultList	Sí	Lista de objetos con la información de retorno de la consulta personalizada

📝 Objeto GetCustomInfoResult

Descripción

El objeto GetCustomInfoResult representa un retorno de la consulta personalizada.

Parámetros de Entrada

Parámetro	Tipo	Obligatorio	Descripción
ResultRowInfoList	GetCustomInfoResultFieldList	Sí	Lista de objetos con todas las columnas y valores retornados por la fila de resultado de la consulta

📝 Objeto GetCustomInfoResultField

Descripción

El objeto GetCustomInfoResultField representa una columna de una fila de la consulta personalizada.

Parámetros de Entrada

Parámetro	Tipo	Obligatorio	Descripción
FieldName	String(30)	Sí	Nombre de la columna retornada en una fila de resultado de la consulta personalizada
FieldValue	String(2000)	Sí	Valor de la columna retornada en una fila de resultado de la consulta personalizada

---

Ejemplo 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"
    }
  ]
}

Ejemplo de Response

{
  "WebServiceReturn": {
    "Success": true,
    "Message": "Consulta ejecutada con éxito."
  },
  "CustomInfoResultList": [
    {
      "ResultRowInfoList": [
        {
          "FieldName": "Producto",
          "FieldValue": "Carne Bovina"
        },
        {
          "FieldName": "Cantidad",
          "FieldValue": "1000"
        },
        {
          "FieldName": "ValorTotal",
          "FieldValue": "25000.00"
        }
      ]
    }
  ]
}