Home > Aria6 User Documentation > Aria6 admintools api > get_usage_type_details

get_usage_type_details

Returns details of specified usage type

Input Arguments

Req Field Name Field Type Max Length Description
required-icon.png client_no long 22 Aria-assigned unique identifier indicating the Aria client providing service to this account.
required-icon.png auth_key string 32 Aria-assigned unique key to be passed with each method call for authenticating the validity of the requestor.
required-icon.png usage_type_no int 8 Unique identifier for usage type
  OR      
  usage_type_code string 30 Client defined unique id
  locale_no int 38 Aria-assigned unique identifier of the locale used for translations.
  OR      
  locale_name string 32 Name of the locale to which the translations belong.
  include_translations string 1 Setting this flag as True will fetch the translated fields in all the locales defined. If not passed it defaults to False.

Allowable values for include_translations

 

Output Arguments

Field Name Field Type Description
error_code long Aria-assigned error identifier. 0 indicates no error.
error_msg string Textual description of any error that occurred. "OK" if there was no error.
usage_type_no int Unique identifier for usage type
usage_type_name string Name of usage type
usage_type_desc string Description of usage type
usage_type_display_string string Supp display string of usage type
usage_unit_type string Unit type for usage type
usage_type_code string Client defined unique identifier
is_editable boolean 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.
supplemental_obj_fields hash  
brd_arrow.gif field_no int the field no
brd_arrow.gif field_value string the field value
brd_arrow.gif field_name string the field name
usage_type_translation_details hash Array that contains all the translated values for a given locale.
brd_arrow.gif locale_name string Name of the locale
brd_arrow.gif locale_no int Aria-assigned unique identifier of the locale used for translations.
brd_arrow.gif usage_type_no int Unique identifier for usage type
brd_arrow.gif usage_type_name string Name of usage type
brd_arrow.gif usage_type_desc string Description of usage type
brd_arrow.gif usage_type_display_string string Supp display string of usage type
 
 
 
Last modified

Tags

This page has no custom tags.

Classifications

This page has no classifications.