Skip to main content
Aria Knowledge Central

get_product_field_category_details_m Sample Call and Response

This example shows a client looking up the details of a single product field category, including the plan or plans associated with it and the individual product fields it contains, based on the get_product_field_category_details_m method defined in methods_m_r73.yml.

This example includes every required field for the call and a representative set of returned plan and product field information. It does not attempt to enumerate every plan or product field a category could contain.

Sample call

{
  "rest_call": "get_product_field_category_details_m",
  "output_format": "json",
  "client_no": 60123,
  "auth_key": "a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6",
  "field_category_no": 3001
}

The rest_call and output_format fields are envelope fields that the REST layer adds to every call; neither appears in the method’s own documented arguments. The call requires client_no and auth_key, along with an identifier for the category being looked up. The yml lists field_category_no and field_category_name as an alternative pair, so a caller supplies only one of the two; this example supplies field_category_no, Aria’s assigned identifier for the category, rather than field_category_name, the client-defined identifier. The field_category_no field carries a precedence value of secondary in the yml, which only indicates that Aria’s own user interface favors the other side of the pair by default; it does not mean field_category_no should be excluded from a sample call.

Sample response

{
  "error_code": 0,
  "error_msg": "OK",
  "field_category_no": 3001,
  "field_category_name": "Hardware Attributes",
  "plan": [
    {
      "plan_no": 10045,
      "plan_name": "Gold Monthly Plan",
      "plan_desc": "Master plan providing gold-tier service with monthly recurring billing.",
      "client_plan_id": "gold-monthly"
    },
    {
      "plan_no": 10046,
      "plan_name": "Silver Monthly Plan",
      "plan_desc": "Master plan providing silver-tier service with monthly recurring billing.",
      "client_plan_id": "silver-monthly"
    }
  ],
  "product_fields": [
    {
      "product_field_no": 40011,
      "product_field_name": "Serial Number",
      "product_field_desc": "Manufacturer-assigned serial number of the hardware unit.",
      "product_field_value": "SN-88214477",
      "allow_instance_override": 1
    },
    {
      "product_field_no": 40012,
      "product_field_name": "MAC Address",
      "product_field_desc": "Network hardware address of the hardware unit.",
      "product_field_value": "00:1A:2B:3C:4D:5E",
      "allow_instance_override": 0
    }
  ]
}

An error_code of zero and an error_msg of “OK” indicate that the category’s details were retrieved successfully. The plan array lists every plan associated with this category; a category tied to more plans than shown here would return additional entries in the same format. The product_fields array lists the individual fields defined within the category; this example shows two representative fields rather than a complete set. An allow_instance_override value of one means a specific plan instance can override the field’s default value, while a value of zero means the value shown is fixed for all instances. This example does not attempt to show every product field a category could contain.

TOP
  • Was this article helpful?