This is an old revision of the document!
Retrieves API version, environment, data-center, time.
This method pulls the system information.
Information accessible through this method includes API version number, environment (production/sandbox/staging), data-center location, and the current time.
SystemInfo getSystemInfo ( ueSecurityToken Token )
Type | Name | Description |
---|---|---|
ueSecurityToken | Token | Merchant security token, used to identify merchant and validate request. |
SystemInfo | Retrieves API version, environment, data-center, time. |
For directions on how to set up the WSDL link, create “$token” and “$client”, go to PHP Soap How-to.
try { $response=$client->getSystemInfo($this->token); print_r($response); } catch (SoapFault $e){ echo $client->__getLastRequest(); echo $client->__getLastResponse(); $this->fail("Get SystemInfo failed:" .$e->getMessage()); }
Dim info As usaepay.SystemInfo = New usaepay.SystemInfo info = client.getSystemInfo(token) MsgBox(info.ApiVersion)
try { usaepay.SystemInfo system = client.getSystemInfo(token); MessageBox.Show(string.Concat(system.ApiVersion)); } catch (Exception err) { MessageBox.Show(err.Message); }
Request:
<?xml version="1.0" encoding="UTF-8"?> <SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="urn:usaepay" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/" SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/"> <SOAP-ENV:Body> <ns1:getSystemInfo> <Token xsi:type="ns1:ueSecurityToken"> <ClientIP xsi:type="xsd:string">192.168.0.1</ClientIP> <PinHash xsi:type="ns1:ueHash"> <HashValue xsi:type="xsd:string">ExampleHashedValue</HashValue> <Seed xsi:type="xsd:string">RandomSeed</Seed> <Type xsi:type="xsd:string">sha1</Type> </PinHash> <SourceKey xsi:type="xsd:string">WYF1YourSourceKeyHere4d3</SourceKey> </Token> </ns1:getSystemInfo> </SOAP-ENV:Body> </SOAP-ENV:Envelope>
Response:
<?xml version="1.0" encoding="UTF-8"?> <SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="urn:usaepay" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/" SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/"> <SOAP-ENV:Body> <ns1:getSystemInfoResponse> <getSystemInfoReturn xsi:type="ns1:SystemInfo"> <ApiVersion xsi:type="xsd:string">1.4</ApiVersion> <Environment xsi:type="xsd:string">Development</Environment> <Datacenter xsi:type="xsd:string">Unknown</Datacenter> <Time xsi:type="xsd:string">13:36:23-0800</Time> </getSystemInfoReturn> </ns1:getSystemInfoResponse> </SOAP-ENV:Body> </SOAP-ENV:Envelope>
Version | Change |
---|---|
1.3 | Method added in this release |