1. Home
  2. Corporate Node
  3. SOAP requests
  4. hello

hello

Operation hello allows to check WUI running status.

Hello request returns basic informations about WUI working status. Most important informations are status of WUI and username (name of logged user).

WUI can be in one of following states

  1. VUI_CONNECTING – WUI is connecting
  2. VUI_CONNECTED – WUI is connected, bot user is not logged in
  3. VUI_LOGGING_IN_OR_REGISTERING – user is now logging in or registering
  4. VUI_LOGGEDIN – user is logged in. WUI is waiting for data and vault access
  5. VUI_READ_AVAILABLE – user is logged in and WUI is waiting for data
  6. VUI_WRITE_AVAILABLE – user is logged in and WUI is waiting for permission to write data
  7. VUI_BOX_READY – user is logged in and its database is ready to read and write, but not all money operations are available
  8. VUI_READY_BUT_VAULTOFFLINE – user is logged in, but vault is not yet ready
  9. VUI_READY – user is logged in and WUI is ready to go

After starting WUI it’s in VUI_CONNECTING state. When it’s in VUI_READY it’s ready to work.

Example SOAP request:

<soapenv:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="ns1">
   <soapenv:Header/>
   <soapenv:Body>
      <ns1:hello soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/"/>
   </soapenv:Body>
</soapenv:Envelope>

Example SOAP response:

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/" 
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:ns1="ns1">
   <SOAP-ENV:Header/>
   <SOAP-ENV:Body SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
      <ns1:helloResponse>
         <return>
            <status>VUI_READY</status>
            <pid>8535</pid>
            <daemon>false</daemon>
            <username>billon_user</username>
            <miport>9090</miport>
            <adminpanelPort>9092</adminpanelPort>
            <soapPort>9791</soapPort>
            <sslRequired>false</sslRequired>
         </return>
      </ns1:helloResponse>
   </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

Request parameters:

Message does not require parameters

Response parameters:

nametypedescription
isMerchantboolinformation whether user has merchant status
sslRequiredboolis SSL security required for SOAP communications
soapPortunsigned shortSOAP port
usernamestringloginname of user logged in WUI
versionstringversion of WUI application
pidunsigned intWUI pid number in operating system
adminpanelPortunsigned shortWUI administrator panel
daemonboolis WUI running in daemon mode (in background)
statusstringWUI running status
miportunsigned shortport WUI used for receiving payments from clients
Was this article helpful to you? Yes No

How can we help?