Request parameters

  • tenant (mandatory)

  • dictionary_name (optional) - name of the dictionary to be returned in response. All available dictionaries will be returned if the parameter is not passed in request.

Available dictionaries

All tenants"acct_cat_code_id", "curr_codes", "bill_dist_codes", "contract_status", "contact_type", "address_type"
Ordering tenants only"order_status", "order_type", "order_position_type", "order_position_unit"


Example of request 

{
   "tenant": "zegoal"
}
CODE

Example of response

{
   "processing_result":    {
      "text": "Dictionary is received.",
      "status": "ok",
      "ctx_id": "qJjp9RMH-Lf",
      "code": 0
   },
   "processing_date": "2020-12-03 20:42:09",
   "GetTenantDict":    {
      "response":       {
         "tenant": "zegoal",
         "dictionary":          [
            "acct_cat_code_id",
			"curr_codes",
			"bill_dist_codes",
			"contract_status",
			"contact_type",
			"address_type"
         ],
         "TZ": "Europe/Minsk"
      },
      "request": {"tenant": "zegoal"},
      "extra_logic": "",
      "enriched_request": {"tenant": "zegoal"}
   }
}
CODE

Example of request with dictionary_name parameter

{
    "tenant": "fortest",
    "dictionary_name": "order_type"
}
CODE

Example of response if dictionary_name is specified in the API request

{
   "processing_result":    {
      "text": "Dictionary is received.",
      "status": "ok",
      "ctx_id": "Ft3d4J6H-r2",
      "code": 0
   },
   "processing_date": "2020-12-04 18:48:15",
   "GetTenantDict":    {
      "response":       {
         "tenant": "fortest",
         "dictionary_name": "order_type",
         "dictionary":          [
                        {
               "value": "OnSite",
               "oid": 77,
               "description": "OnSite"
            },
                        {
               "value": "Online",
               "oid": 76,
               "description": "Online"
            }
         ],
         "TZ": "Europe/Minsk"
      },
      "request":       {
         "tenant": "fortest",
         "dictionary_name": "order_type"
      },
      "extra_logic": "",
      "enriched_request":       {
         "tenant": "fortest",
         "dictionary_name": "order_type"
      }
   }
}
CODE