Client Info Request

When building a API client, this covers how to tell the client what settings should be set or not set in the client. This will make things a lot cleaner as we can avoid server side error messages, and provide client side validation.

Request

Request URL: /account
Request VERB: GET
  Parameters:
    user:
      api_key:        # The users API key
Response:
  user:
    api_version                  # String.  The current API version is 3.
    version                      # String.  The version number of the LiquidFiles system.
    version_numeric              # Integer. The version number of the LiquidFiles system in numeric format.
                                            Version v2.3.1 will be listed as 20301.
    api_client_size_override     # Integer. The value (in Megabytes) for API clients (such as the Outlook plugin) when 
                                 #          to override the normal client behaviour and send files through the 
                                 #          LiquidFiles appliance instead.
    max_expiration               # Integer. The users max message expiration number of days.
    max_file_size                # Integer. The maximum file size this user is allowed to send (in Mb).
    change_expiration            # Boolean. True if the user is allowed to change file expiration time.
    default_file_expiration      # Integer. The number of days the users default expiration is.
    can_change_expires_after     # Boolean. True if the user is allowed to change expires_after.
    max_expires_after            # Integer. The max number of days the user can set the Max Expires After to. Blank if no limit.
    accepted_filetypes           # String.  A comma separated list of accepted file types the user is allowed to send.
    blocked_extensions           # String.  A comma separated list of blocked files types. Either accepted_filetypes 
                                 #          or blocked_extensions will be set. Never both.
    default_bcc_myself           # Boolean. True if the LiquidFiles appliance will default to bcc the user on delivery.
    can_change_bcc_myself        # Boolean. True if the user is permitted to change the BCC myself setting.
    default_authorization        # Integer. 0: Anyone can download
                                 #          1: Anyone after authentication can download
                                 #          2: Specified recipients and local users can download
                                 #          3: Only specified recipients can download
    can_override_size_limit      # Boolean. True if the user can change the value of the api_client_size_override
    enable_send_folders          # Boolean. True if the send folders feature should be enabled in the Outlook plugin.
    api_enable_secure_send       # Boolean. True if the Secure Send feature should be enabled in the Outlook plugin.
    allow_users_to_change_authorization # Boolean. True if users can change from the default authorization method.
    limit_recipient_domains      # Boolean. True if the user is limited to what domains the can send messages
    can_send_to_local_users      # Boolean. True if the user can send to local users as well as the 
                                 #          limited recipient domains.
    can_use_file_requests        # Boolean. True if the user is permitted to use the File Request feature.
    can_invite_users             # Boolean. True if the user is permitted to invite users.
    can_use_specified_recipients # Boolean. True if the user is permitted to set the authorization level of Specified Recipients Only.
    can_use_specified_recipients_and_local # Boolean. True if the user is permitted to set the authorization level of Specified Recipients and Local Users.
    can_use_anyone_with_auth     # Boolean. True if the user is permitted to set the authorization level of Anyone (with authentication).
    can_use_anyone               # Boolean. True if the user is permitted to set the authorization level with no Authentication.
    disable_sending              # Boolean. True if the user is not permitted to send files.
    recipients_domains           # Array.   The list of limited recipient domains the user can only send to.
    custom_settings              # mixed.   Copied directly from the users groups custom api settings value. 

In case the user is presented with an interface (email client plugin, …) these responses dictates what should be visible to the end user. If the user is allowed to change the file expiration, show the control with the listed default parameters. If the user isn't allowed to change file expiration, either grey out or remove those controls.

Example Response

<?xml version="1.0" encoding="UTF-8"?>
<user>
  <api_version>3</api_version>
  <version>v2.0.7</version>
  <version_numeric type="integer">20007</version_numeric>
  <api_client_size_override type="integer">10</api_client_size_override>
  <max_expiration type="integer">14</max_expiration>
  <max_file_size type="integer">2000</max_file_size>
  <change_expiration type="boolean">true</change_expiration>
  <default_file_expiration type="integer">2</default_file_expiration>
  <default_file_expiration_format>weeks</default_file_expiration_format>
  <can_change_expires_after type="boolean">true</can_change_expires_after>
  <max_expires_after type="integer"></max_expires_after>
  <accepted_filetypes></accepted_filetypes>
  <blocked_extensions>exe, vbs, pif, scr, bat, cmd, com, cpl</blocked_extensions>
  <default_authorization type="integer">3</default_authorization>
  <allow_users_to_change_authorization type="boolean">true</allow_users_to_change_authorization>
  <default_bcc_myself type="boolean">true</default_bcc_myself>
  <can_use_bcc_myself type="boolean>true</can_use_bcc_myself>
  <can_override_size_limit type="boolean">true</can_override_size_limit>
  <enable_send_folders type="boolean">false</enable_send_folders>
  <api_enable_secure_send type="boolean">true</api_enable_secure_send>
  <limit_recipient_domains type="boolean">true</limit_recipient_domains>
  <can_send_to_local_users type="boolean">true</can_send_to_local_users>
  <can_use_file_requests type="boolean">true</can_use_file_requests>
  <recipients_domains type="array">
    <recipients_domain>springfield.com</recipients_domain>
  </recipients_domains>
  <custom_settings>
<![CDATA[
enable_some_other_custom_value=true
]]>
  </custom_settings>
</user>