Retrieve the name of the currently displayed screen
Returns the name of the screen currently displayed on the pos device.
getPosDeviceScreen ( ueSecurityToken Token)
Type | Name | Description |
---|---|---|
ueSecurityToken | Token | Merchant security token: used to identify merchant and retrieve the custom fields. |
string | Screen | The name of the current screen |
The following exceptions (errors) are applicable to this method.
Code | Message | Advice |
---|---|---|
21101 | POS Device offline | Try rebooting device |
For directions on how to set up the WSDL link, create “$token” and “$client”, go to PHP Soap How-to.
Request:
<?xml version="1.0" encoding="UTF-8"?> <SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="https://www-stage.usaepay.com/soap/2.0/uedocs"> <SOAP-ENV:Body> <ns1:getPosDeviceScreen> <Token> <ClientIP>192.168.0.1</ClientIP> <PinHash> <HashValue>92e9c5ed25f016912aaa1bc6f2848056f145893d</HashValue> <Seed>1365177903337933503</Seed> <Type>sha1</Type> </PinHash> <SourceKey>e42SYc86C4uvlvyP62ow54Kv93SZsJVm</SourceKey> </Token> </ns1:getPosDeviceScreen> </SOAP-ENV:Body> </SOAP-ENV:Envelope>
Response:
Version | Change |
---|---|
1.6 | Method added in this release |