update_service_m Sample Call and Response
This example shows a client updating an existing recurring service, “Premium Widget Service,” to change its general ledger code, adjust its tax settings, add a commodity code, and enable service credit consumption. It is based on the update_service_m method as defined in methods_m_r73.yml, Admin Tools API.
This example covers every required field, plus a representative set of optional fields telling one story: editing a Recurring service’s accounting and tax attributes and one supplemental object field. It does not cover the Usage-Based, Order-Based, Cancellation, or Minimum Fee service type variants, or every optional field the method accepts.
Sample call
{
"rest_call": "update_service_m",
"output_format": "json",
"client_no": 700123,
"auth_key": "a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6",
"service_no": 8842001,
"service_name": "Premium Widget Service",
"service_type": "Recurring",
"gl_cd": "4010-SALES",
"rev_rec_ind": 0,
"deferred_ind": 0,
"taxable_ind": 1,
"tax_group": 200,
"svc_location_no": 55001,
"commodity_cd": "44101800",
"allow_service_credits": "Y",
"supplemental_obj_field": [
{
"field_no": 91045,
"field_value": ["Gold"]
}
]
}
The rest_call and output_format fields are not part of the method’s own documented arguments. The REST layer adds them to every call: rest_call names the method being invoked, and output_format requests a JSON response rather than the default WDDX format. Within the method’s own arguments, client_no and auth_key identify and authenticate the client making the call, and both come from the shared param_defaults block. The service_no and client_service_id fields are alternatives to each other; this example identifies the service by its Aria-assigned numeric service_no rather than the client-defined client_service_id. service_name and gl_cd are required alongside service_no, service_type is set to “Recurring,” one of the valid service types alongside Activation, Usage-Based, Order-Based, Cancellation, and Minimum Fee, so usage_type is left out since it applies only when service_type is Usage-Based. rev_rec_ind and deferred_ind are both set to 0, meaning ar_gl_cd and def_gl_cd are not required and are therefore left out of this call. taxable_ind is set to 1, meaning the service is taxable, so tax_group is supplied by its Aria-assigned numeric identifier rather than the alternative client_tax_group_id. svc_location_no identifies the Aria-assigned service location rather than the alternative client_svc_location_id. allow_service_credits is set to “Y,” meaning the service can consume service credits. The supplemental_obj_field entry identifies one supplemental object field by its Aria-assigned field_no, and supplies its value as a single-element array, since field_value itself accepts more than one value per field; a call with more supplemental fields would repeat this pattern with additional entries in the array.
Sample response
{
"error_code": 0,
"error_msg": "OK",
"service_no": 8842001
}
An error_code of zero, paired with an error_msg of “OK,” indicates that Aria updated the service successfully. The service_no field echoes back the Aria-assigned identifier of the service that was updated. The method’s returns block consists only of these three fields, so there is no additional output to show.