developer:soap-1.6:methods:getposdevicescreen

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

developer:soap-1.6:methods:getposdevicescreen [2013/07/01 08:30] (current)
edenmcewen created
Line 1: Line 1:
 +<embed ..:​contents/>​
  
 +====== getPosDeviceScreen ======
 +
 +Retrieve the name of the currently displayed screen
 +
 +===== Description =====
 +
 +Returns the name of the screen currently displayed on the pos device.  ​
 +
 +
 +===== Syntax =====
 +
 +**getPosDeviceScreen** ( [[..:​objects:​ueSecurityToken]] Token)
 +
 +===== Arguments =====
 +
 +^Type   ​^Name ​  ​^Description ​  ^
 +|[[..:​objects:​ueSecurityToken]] |Token |Merchant security token: used to identify merchant and retrieve the custom fields.|
 +
 +===== Return Value =====
 +
 +|string |Screen |The name of the current screen ​ |
 +
 +
 +===== Exceptions =====
 +
 +The following exceptions (errors) are applicable to this method. ​
 +
 +^Code ^Message ​ ^Advice ​ ^
 +|21101 |POS Device offline |Try rebooting device |
 +===== Examples =====
 +
 +
 +==== PHP ====
 +
 +For directions on how to set up the WSDL link, create "​$token"​ and "​$client",​ go to [[..:​howto:​php|PHP Soap How-to]].
 +
 +<code php>
 +</​code>​
 +
 +==== VB ====
 +
 +<code vb>
 +</​code>​
 +
 +====.NET C# ====
 +<code c>
 +</​code>​
 +
 +==== XML ====
 +Request:
 +<code xml>
 +<?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>​
 +</​code>​
 +
 +Response:
 +<code xml>
 +
 +</​code>​
 +
 +
 +===== Change History =====
 +
 +^Version ^Change ^
 +|[[developer:​soap-1.6:​methods:​getPosDeviceScreen|1.6]] | Method added in this release |
developer/soap-1.6/methods/getposdevicescreen.txt ยท Last modified: 2013/07/01 08:30 by edenmcewen

Page Tools