get_usage_types_m
Summary
| API Name | get_usage_types_m |
|---|---|
| Class | administration_services_m |
| Update Version | 5.6 |
Description
List all usage types
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. |
|
| usage_types | object | No |
The usage_types associated with this method. |
usage_types.usage_type_translations fields
| 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 |
| usage_type_no | long | 8 | Yes |
Unique identifier for usage type |
| usage_type_name | string | 100 | Yes |
Name of usage type |
| usage_type_desc | string | 300 | Yes |
Description of usage type |
usage_types fields
| Name | Type | Length | Required | Description |
|---|---|---|---|---|
| usage_type_no | long | 8 | Yes |
Unique identifier for usage type |
| usage_type_desc | string | 300 | Yes |
Description of usage type |
| usage_unit_type | string | 30 | Yes |
Unit type for usage type |
| usage_type_name | string | 100 | Yes |
Name of usage type |
| is_editable | boolean | 5 | Yes |
Specifies is usage type is editable. Valid values are : "true" - Usage type is editable "false" - Usage type is not editable because one of the reason:- 1. This usage type is system standard. It is available for all clients and therefore not Editable. 2. This usage type is custom to this client. It is associated with a service and therefore not Editable. |
| usage_type_translations | object | No |
Array that contains all the translated values for a given locale. |