get_service_types_m Sample Call and Response
This example shows a call to get_service_types_m, which retrieves the complete list of service types that are configured in Aria and that you can reference by code when calling other Admin Tools API methods. The example is based on methods_m_r73.yml.
Because this method takes no filtering arguments beyond the standard authentication fields, the sample call is intentionally short. The sample response shows three representative service type entries; it does not represent every service type that Aria supports.
Sample call
{
"rest_call": "get_service_types_m",
"output_format": "json",
"client_no": 32001,
"auth_key": "a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6"
}
The rest_call and output_format fields are envelope fields added by the REST layer; they are not part of the method’s own documented arguments. Every other field in this call is required: client_no is the Aria-assigned identifier for the Aria client making the request, and auth_key is the Aria-assigned authentication key associated with that client. This method has no optional arguments, so there is nothing else to add to the call.
Sample response
{
"error_code": 0,
"error_msg": "OK",
"service_types": [
{
"service_type_cd": "RC",
"service_type_name": "Recurring",
"service_desc": "A service that is billed on a recurring schedule, such as a monthly subscription fee."
},
{
"service_type_cd": "AC",
"service_type_name": "Activation",
"service_desc": "A one-time service that is billed when an account or plan is first activated."
},
{
"service_type_cd": "UB",
"service_type_name": "Usage",
"service_desc": "A service that is billed based on measured usage, such as per-minute or per-unit charges."
}
]
}
An error_code of 0 and an error_msg of "OK" indicate that the call succeeded. The service_types array holds one entry for each service type that Aria supports; this example shows three representative entries (Recurring, Activation, and Usage), but the full response from a real Aria client would list every service type configured for that client, which may include additional entries beyond these three. Each entry consists of only three fields: service_type_cd, which is the short code you pass into other Admin Tools API methods as input; service_type_name; and service_desc. All three fields are always present in every entry, so nothing has been left out of the individual entries shown.