get_service_details_m Sample Call and Response
This example shows a call to get_service_details_m, which retrieves the full configuration details for one specified service, including its accounting codes, tax settings, supplemental fields, and origin locations. The example is based on methods_m_r73.yml.
This example includes every required field, along with a representative set of optional fields that together describe one taxable, deferred-revenue recurring service that has an origin location and a translated name. It does not cover every optional output field the method can return, and it does not cover the untranslated case where include_translations is omitted.
Sample call
{
"rest_call": "get_service_details_m",
"output_format": "json",
"client_no": 32001,
"auth_key": "a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6",
"service_no": 40021,
"locale_no": 250,
"include_translations": "true"
}
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. The client_no and auth_key fields are required for every call. The service_no and client_service_id fields are an alternative pair used to identify which service to look up; this example uses service_no, the Aria-assigned numeric identifier for the service, rather than client_service_id, the client-defined identifier. The locale_no and locale_name fields are also an alternative pair, used here to request the French locale by its Aria-assigned numeric identifier rather than by its client-defined name, and include_translations is set to "true" to request that the translated service name for that locale be included in the response.
Sample response
{
"error_code": 0,
"error_msg": "OK",
"service_no": 40021,
"client_service_id": "PREM-SUPPORT-001",
"service_name": "Premium Support Plan Fee",
"service_type": "Recurring",
"gl_cd": "4000-SUPPORT",
"taxable_ind": 1,
"tax_group": 3,
"usage_type": 0,
"rev_rec_ind": 1,
"ar_ind": 1,
"ar_gl_cd": "1200-AR",
"def_ind": 1,
"def_gl_cd": "2400-DEF",
"supplemental_obj_fields": [
{
"field_no": 501,
"field_name": "support_tier",
"field_value": ["Gold"]
},
{
"field_no": 502,
"field_name": "sla_response_hours",
"field_value": ["4"]
}
],
"commodity_cd": "SW523010",
"client_tax_group_id": "TAXGRP-STD",
"service_locations": [
{
"svc_location_no": 9001,
"client_svc_location_id": "LOC-SF-01",
"svc_location_name": "San Francisco Support Center",
"svc_location_company_name": "Aria Systems, Inc.",
"svc_location_address1": "100 Market Street",
"svc_location_address2": "Suite 400",
"svc_location_city": "San Francisco",
"svc_location_state_prov": "CA",
"svc_location_country": "US",
"svc_location_postal_cd": "94105"
}
],
"service_translation_info": [
{
"locale_no": 250,
"locale_name": "fr_FR",
"service_no": 40021,
"service_name": "Frais du plan de support premium"
}
]
}
An error_code of 0 and an error_msg of "OK" indicate that the call succeeded. The taxable_ind field is 1, indicating that the service is taxable; a value of 0 would indicate a non-taxable service, in which case tax_group would be null instead of the value 3 shown here. The ar_ind and def_ind fields are 1, indicating that the service is associated with an accounts-receivable general ledger code and a deferred-revenue general ledger code, respectively, which is why ar_gl_cd and def_gl_cd both have values in this example. Each entry in supplemental_obj_fields represents one supplemental field configured on the service; field_value is represented as an array because its underlying definition is a repeatable structure, allowing a single supplemental field to carry more than one value, as shown here with a single-value array for each of the two fields. This example shows two supplemental fields and one service location, but a real service could have additional supplemental fields and additional origin locations beyond what is shown here; in that case, supplemental_obj_fields and service_locations would each contain one entry per additional field or location. The service_locations entry in this example also leaves out the optional svc_location_address3 and svc_location_locality fields, since this location does not need them. The service_translation_info array shows a single translated entry for the French locale (locale_no 250); if include_translations had been requested for a service with translations defined in several locales, this array would include one entry per locale rather than only one.