get_service_details_m
Summary
| API Name | get_service_details_m |
|---|---|
| Class | administration_services_m |
| Update Version | 5.6 |
Description
Retrieve details on specified service
Inputs
| Name | Type | Length | Required | Description | ||||||
|---|---|---|---|---|---|---|---|---|---|---|
| client_no | long | 12 | Yes |
Aria-assigned unique identifier indicating the Aria client providing service to this account. |
||||||
| auth_key | string | 32 | Yes |
Aria-assigned unique key to be passed with each method call for authenticating the validity of the requestor. |
||||||
| service_no | long | 8 | Yes |
Specifies the Service number Alternative required field: client_service_id |
||||||
| client_service_id | string | 100 | Yes |
Client defined unique id Alternative required field: service_no |
||||||
| locale_no | long | 38 | No |
Aria-assigned unique identifier of the locale used for translations. Alternative field: locale_name |
||||||
| locale_name | string | 32 | No |
Name of the locale to which the translations belong. Alternative field: locale_no |
||||||
| include_translations | string | 5 | No |
Setting this flag as True will fetch the translated fields in all the locales defined. If not passed it defaults to False. Allowed values:
|
Outputs
| Name | Type | Length | Required | Description |
|---|---|---|---|---|
| error_code | long | No |
Aria-assigned error identifier. 0 indicates no error |
|
| error_msg | string | No |
Textual description of any error that occurred. "OK" if there was no error. |
|
| service_no | long | 8 | No |
Specifies the Service number |
| client_service_id | string | 100 | No |
Client defined unique id |
| service_name | string | 100 | No |
Specifies the service name |
| service_type | string | 30 | No |
Specifies Service types. Valid values are: "Usage Based", "Recurring", "Activation" |
| gl_cd | string | 30 | No |
Specifies chart of access code |
| taxable_ind | int | 1 | No |
Indicates If The service has tax associated with it [can be 0 or 1]; 1 indicates taxable and 0 indicates non taxable. |
| tax_group | int | 1 | No |
Specifies tax group associated with service. This will be null if taxable_ind is set to 0 |
| usage_type | int | 38 | No |
Specifies usage type associated with service |
| rev_rec_ind | int | 8 | No |
Specifies if this service is revrec related. |
| ar_ind | int | 8 | No |
Account receivable indicator. |
| ar_gl_cd | string | 8 | No |
Account receivable gl code. |
| def_ind | int | 8 | No |
Deferred indicator |
| def_gl_cd | string | 8 | No |
Deferred gl code. |
| Start of supplemental_obj_fields object | ||||
| supplemental_obj_fields | object | No |
The supplemental_obj_fields associated with this method. |
|
| Name | Type | Length | Required | Description |
| ▶field_no | long | 100 | No |
the field no |
| ▶field_value | string | No |
the field value |
|
| ▶field_name | string | 100 | No |
the field name |
| End of supplemental_obj_fields object | ||||
| commodity_cd | string | 20 | No |
Commodity Code |
| client_tax_group_id | string | 100 | No |
Client defined unique identifier |
| Start of service_locations object | ||||
| service_locations | object | No |
The service_locations associated with this method. |
|
| Name | Type | Length | Required | Description |
| ▶svc_location_no | long | 38 | No |
The Aria-assigned unique identifier for the origin location for the service. |
| ▶client_svc_location_id | string | 100 | No |
The client-defined location identifier for the origin location for the service. |
| ▶svc_location_name | string | 100 | No |
The name of the origin location for the service. |
| ▶svc_location_company_name | string | 300 | No |
Company name of the service location. |
| ▶svc_location_address1 | string | 300 | No |
First address line of the service location. |
| ▶svc_location_address2 | string | No |
Second address line of the service location. |
|
| ▶svc_location_address3 | string | 300 | No |
Third address line of the service location. |
| ▶svc_location_city | string | 300 | No |
City of the service location. |
| ▶svc_location_locality | string | 25 | No |
Locality of the service location. |
| ▶svc_location_state_prov | string | 10 | No |
State or Province of the service location. The official postal-service codes for all United States, Australia and Canada states, provinces, and territories. This field does not support states, provinces or territories from other countries. Use the locality field for other countries. |
| ▶svc_location_country | string | 300 | No |
Country of the location contact. The ISO-compliant 2-character country code abbreviation in uppercase. |
| ▶svc_location_postal_cd | string | 15 | No |
Postal/Zip code for the service location address. |
| End of service_locations object | ||||
| Start of service_translation_info object | ||||
| service_translation_info | object | No |
Array that contains all the translated values for a given locale. |
|
| Name | Type | Length | Required | Description |
| ▶locale_name | string | 32 | No |
Name of the locale to which the translations belong. Alternative field: locale_no |
| ▶locale_no | long | 38 | No |
Aria-assigned unique identifier of the locale used for translations. Alternative field: locale_name |
| ▶service_no | long | 8 | Yes |
Specifies the Service number |
| ▶service_name | string | 100 | Yes |
Specifies the service name |
| End of service_translation_info object | ||||