Parameters

Endpoints

Get parameters

POST/api/RPC.common.Api.Params.get?token=<TOKEN>

Key Params.get · Open page

Parameters

6 body parameters inside data[]
FieldTypeDescription
idIntegerParameter ID
coderequiredStringParameter ID
namerequiredStringParameter name
get_allBooleanGet all
offsetNumberOffset
limitNumberLimit

Request example

Search By Id:
{
   "data" : [
      {
         "id" : 3139191
      }
   ]
}
Search By Code:
{
   "data" : [
      {
         "code" : "BT"
      }
   ]
}
Search By Name:
{
   "data" : [
      {
         "name" : "Industry"
      }
   ]
}
Search By All Params:
{
   "data" : [
      {
         "id" : 3139191,
         "name" : "Industry",
         "code" : "BT"
      }
   ]
}
Get All:
{
	"data":[
		{}
	],
	"get_all":1,
	"limit":10000,
	"offset":0
}

cURL

Search By Id:
curl -X POST -H 'Content-Type: application/json; charset=utf-8' -d '{   "data" : [      {         "id" : 3139191      }   ]}' "https://<DOMAIN_NAME>/api/RPC.common.Api.Params.get?token=<TOKEN>"
Search By Code:
curl -X POST -H 'Content-Type: application/json; charset=utf-8' -d '{   "data" : [      {         "code" : "BT"      }   ]}' "https://<DOMAIN_NAME>/api/RPC.common.Api.Params.get?token=<TOKEN>"
Search By Name:
curl -X POST -H 'Content-Type: application/json; charset=utf-8' -d '{   "data" : [      {         "name" : "Industry"      }   ]}' "https://<DOMAIN_NAME>/api/RPC.common.Api.Params.get?token=<TOKEN>"
Search By All Params:
curl -X POST -H 'Content-Type: application/json; charset=utf-8' -d '{   "data" : [      {         "id" : 3139191,         "name" : "Industry",         "code" : "BT"      }   ]}' "https://<DOMAIN_NAME>/api/RPC.common.Api.Params.get?token=<TOKEN>"
Curl example Get All:
curl -X POST -H 'Content-Type: application/json; charset=utf-8' -d '{	"data":[		{}	],	"get_all":1,	"limit":10000,	"offset":0}	' "https://<DOMAIN_NAME>/api/RPC.common.Api.Params.get?token=<TOKEN>"

Response example

    HTTP/1.1 200 OK
{
   "count" : 1,
   "total_count" : 1,
   "result" : [
      {
         "id" : 3139191,
         "code" : "BT",
         "tp" : "nomenclature",
         "values" : [
            {
               "name" : "Trade",
               "id" : 3139206,
               "code" : "01",
               "nomenclature_id" : 3139196
            },
            {
               "nomenclature_id" : 3139196,
               "name" : "Food and beverages",
               "id" : 3139207,
               "code" : "03"
            },
            {
               "id" : 3139208,
               "name" : "Software and services",
               "code" : "05",
               "nomenclature_id" : 3139196
            },
            {
               "nomenclature_id" : 3139196,
               "code" : "06",
               "id" : 3139209,
               "name" : "Hardware and services"
            },
            {
               "code" : "07",
               "id" : 3139210,
               "name" : "Manufacturing",
               "nomenclature_id" : 3139196
            },
            {
               "name" : "Construction",
               "id" : 3139211,
               "code" : "08",
               "nomenclature_id" : 3139196
            },
            {
               "nomenclature_id" : 3139196,
               "code" : "09",
               "id" : 3139212,
               "name" : "Finance"
            },
            {
               "code" : "04",
               "name" : "Clothing and fashion",
               "id" : 3139213,
               "nomenclature_id" : 3139196
            },
            {
               "id" : 3139214,
               "name" : "Distribution",
               "code" : "02",
               "nomenclature_id" : 3139196
            }
         ],
         "name" : "Industry",
         "params_for" : "partners",
         "order_id" : 6,
         "nomenclature_id" : 3139196
      }
   ]
}