get_services_m
Summary
| API Name | get_services_m |
|---|---|
| Class | administration_services_m |
| Update Version | 5.6 |
Description
Retrieve all services
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. |
||||||
| 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. |
|
| Start of services object | ||||
| services | object | No |
The services associated with this method. |
|
| Name | Type | Length | Required | Description |
| ▶service_no | long | 100 | Yes |
Specifies the service number |
| ▶service_name | string | 100 | Yes |
Specifies the service name |
| ▶service_type | string | 30 | Yes |
Specifies Service types. Valid values are: "Usage Based", "Recurring", "Activation" |
| ▶client_service_id | string | 100 | No |
Client defined unique id |
| Start of service_translations object | ||||
| ▶service_translations | 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 | 100 | No |
Specifies the service number |
| ▶▶service_name | string | 100 | No |
Specifies the service name |
| End of service_translations object | ||||
| End of services object | ||||