Get Environment Information

This method returns details about the Commerce SDK modules in use. This also returns the runtime environment information about the platform running Commerce SDK.

Code Samples

CWS

Request

method
string | required
getEnvironmentInfo
 
requestId
string | required
Transaction Request ID
 
targetType
string | required
api
 
parameters
JSONObject | required
All relevant parameters for retrieving the environment information.
 

Response

requestId
string
Transaction Request ID
As specified in the request.
statusDetails
string
Request Status
 
data
JSONObject
Object holding various responses.
 

Example

{
  "method" : "getEnvironmentInfo",
  "requestId" : "1",
  "targetType" : "api"
}
{
    "requestId": "1",
    "statusDetails": "REQUEST_ACCEPTED",
    "data": {
        "cwsInfo": {
            "name": "commerce-web-services",
            "version": "2.5.0.3"
        },
        "conconInfo": {
            "name": "converge-connect",
            "version": "2.3.0.70"
        },
        "comsdkInfo": {
            "componentVersions": [
                {
                    "name": "commerce-core",
                    "version": "2.5.0-SNAPSHOT.DEV"
                },
                {
                    "name": "commerce-converge",
                    "version": "2.5.0-SNAPSHOT.DEV"
                },
                {
                    "name": "commerce-desktop-converge",
                    "version": "2.5.0-SNAPSHOT.DEV"
                },
                {
                    "name": "ingenico-rba",
                    "version": "2.5.0-SNAPSHOT.DEV"
                },
                {
                    "name": "ingenico-rba-wrapper",
                    "version": "2.5.0-SNAPSHOT"
                },
                {
                    "name": "RBA",
                    "version": "4.0.18"
                },
                {
                    "name": "StarMicronics Printer",
                    "version": "2.1.0"
                }
            ],
            "runtimeInformation": [
                {
                    "name": "os.arch",
                    "value": "x86"
                },
                {
                    "name": "os.name",
                    "value": "Windows 7"
                },
                {
                    "name": "os.version",
                    "value": "6.1"
                },
                {
                    "name": "java.version",
                    "value": "1.7.0_75"
                },
                {
                    "name": "java.vendor",
                    "value": "Oracle Corporation"
                }
            ]
        },
        "completed": true
    }
}

Java

ECLEnvironmentInfo info = yourEclAccountInterface.getEnvironmentInfo();   

C#

m_CWS.StartEnvironmentInfo(MyNotifyCWSEvent, MyEnvironmentInfoComplete);
...
public void MyEnvironmentInfoComplete(EnvironmentInfoResults info)
        {
            Log("----------- Environment Info Results ------------");
...