/
instance_mobile_info ()

instance_mobile_info ()

Owned by Pedro Jose Sanchez Luling
Last updated: Nov 14, 2023
Function prototype
instance_mobile_info (os_name)

Returns information about mobile version of the client APP

Input

parameters:

  • os_name: Name of the Operating System of the client (e.g. "Android", "iOS", "Windows"

Output

parameters:

  • result: an XML with the following information
    • name: Name of the APP
    • description: Brief description of the APP
    • min_version: Minimum OS version required
    • store_ref: depending on the Operating System name, this node will include a reference to download the mobile APP version from the corresponding App Store. This can be used by web browsers in responsive mode to display a message inviting to download the mobile App. Note that this node will only be included in the response if there exist a mobile APP version for the Operating System provided
  • ErrorMsg: any fault in the call, either in the validation of input parameters, errors in the connection to the database or any other error, this parameter returns the error message produced
  • ErrorCode

Request

sample:

instance_mobile_info ();

Response

sample:

<?xml version="1.0" encoding="utf-8" standalone="yes"?>
<result>
  <mobile_info>
    <name>2.5.18</name>
	<description>XXXXX</description>
    <min_version>7.0.0</min_version>
    <store_ref></store_ref>
  </mobile_info>
</result>
<ErrorMsg></ErrorMsg>
<ErrorCode></ErrorCode>

Notes:

The values returned by this function are defined in the WEB SERVICES CONFIGURATION file:

  • $GLOBALS["MOBILE_INFO"][os_name]["NAME"]

  • $GLOBALS["MOBILE_INFO"][os_name]["DESCRIPTION"]

  • $GLOBALS["MOBILE_INFO"][os_name]["MIN_VERSION"]

  • $GLOBALS["MOBILE_INFO"][os_name]["STORE_REF"]

Related content