get_product_field_categories_m Sample Call and Response
This example shows a client retrieving the complete list of product field categories defined for its account, based on the get_product_field_categories_m method defined in methods_m_r73.yml.
This example includes every required field for the call and a representative set of returned category entries. It does not cover the details of the product fields within each category; get_product_field_category_details_m covers that.
Sample call
{
"rest_call": "get_product_field_categories_m",
"output_format": "json",
"client_no": 60123,
"auth_key": "a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6"
}
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 itself requires only client_no, Aria’s identifier for the client requesting the list, and auth_key, the authentication key issued to that client. The method takes no other arguments, since it always returns every category defined for the client rather than a filtered subset.
Sample response
{
"error_code": 0,
"error_msg": "OK",
"product_field_category": [
{
"field_category_no": "3001",
"field_category_name": "Hardware Attributes"
},
{
"field_category_no": "3002",
"field_category_name": "Subscription Metadata"
},
{
"field_category_no": "3003",
"field_category_name": "Warranty Information"
}
]
}
An error_code of zero and an error_msg of “OK” indicate that the category list was retrieved successfully. The product_field_category array holds one entry per category configured for the client; a real client could have more or fewer than the three entries shown here. Although field_category_no functions as a numeric identifier, the yml defines it as a string field, so this example represents it as a quoted value rather than a bare number. Each entry carries only field_category_no and field_category_name; the individual product fields and the plan associated with each category are returned only by get_product_field_category_details_m, not by this list-level method.