{"_id":"5632a5ef49e16d0d001224ec","project":"55b933b3146ef121002158d3","version":{"_id":"5632a5e549e16d0d00122443","__v":6,"project":"55b933b3146ef121002158d3","createdAt":"2015-10-29T23:04:05.701Z","releaseDate":"2015-10-29T23:04:05.701Z","categories":["5632a5e749e16d0d00122444","5632a5e749e16d0d00122445","5632a5e749e16d0d00122446","5632a5e749e16d0d00122447","5632a5e749e16d0d00122448","5632a5e749e16d0d00122449","5632a5e749e16d0d0012244a","5632a5e749e16d0d0012244b","5632a5e749e16d0d0012244c","5632a5e749e16d0d0012244d","5632a5e749e16d0d0012244e","5632a5e749e16d0d0012244f","5632a5e749e16d0d00122450","5632b179df556c0d00cd095b","564e13053b2b4a19000cd69b","59caa9df65accc001a489c95","59cab50965accc001a489d28","59cadd464ab7b70024378e74"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"1.1.0","version":"1.1"},"category":{"_id":"5632a5e749e16d0d0012244b","__v":1,"version":"5632a5e549e16d0d00122443","pages":["5632a5ef49e16d0d001224e8","5632a5ef49e16d0d001224e9","5632a5ef49e16d0d001224ea","5632a5ef49e16d0d001224eb","5632a5ef49e16d0d001224ec","5632a5ef49e16d0d001224ed","5632a5ef49e16d0d001224ee","5632a5ef49e16d0d001224ef","5632a5ef49e16d0d001224f0","5632a5ef49e16d0d001224f1","5632a5ef49e16d0d001224f2","5632a5ef49e16d0d001224f3","5632a5ef49e16d0d001224f4"],"project":"55b933b3146ef121002158d3","sync":{"url":"","isSync":false},"reference":false,"createdAt":"2015-08-04T17:33:35.913Z","from_sync":false,"order":10,"slug":"point-of-sale-server","title":"Point of Sale Server"},"githubsync":"","user":"55b932ba8fd1a02b00f496c8","__v":0,"parentDoc":null,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2015-08-04T17:43:56.259Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":4,"body":"Display a screen/message on the pos device\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Description\"\n}\n[/block]\nAllows the developer to display a predefined screen to the pos device associated with the source key. For screens that support it, a custom message can also be set. If the name of screen does not match a screen that is available on the pos device, the default idle screen will be displayed.\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Syntax\"\n}\n[/block]\n**displayPosDeviceScreen** ( [ueSecurityToken](/docs/uesecuritytoken) Token, string Screen, string Message)\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Arguments\"\n}\n[/block]\n\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Type\",\n    \"h-1\": \"Name\",\n    \"h-2\": \"Description\",\n    \"0-0\": \"[ueSecurityToken](/docs/uesecuritytoken)\",\n    \"0-1\": \"Token\",\n    \"0-2\": \"Merchant security token: used to identify merchant and retrieve the custom fields.\",\n    \"1-0\": \"string\",\n    \"1-1\": \"Screen\",\n    \"1-2\": \"Name of screen to display\",\n    \"2-0\": \"string\",\n    \"2-1\": \"Message\",\n    \"2-2\": \"Message to display\"\n  },\n  \"cols\": 3,\n  \"rows\": 3\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Return Value\"\n}\n[/block]\n\n[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"string\",\n    \"0-1\": \"Status\",\n    \"0-2\": \"Confirmation that screen was displayed\"\n  },\n  \"cols\": 3,\n  \"rows\": 1\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Exceptions\"\n}\n[/block]\nThe following exceptions (errors) are applicable to this method.\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Code\",\n    \"h-1\": \"Message\",\n    \"h-2\": \"Advice\",\n    \"0-0\": \"21100\",\n    \"0-1\": \"There are no POS devices associated with this source key\",\n    \"0-2\": \"Register a pos device to this source key\",\n    \"1-0\": \"21101\",\n    \"1-1\": \"POS device offline\",\n    \"1-2\": \"Device associated with this source key is offline, try rebooting\"\n  },\n  \"cols\": 3,\n  \"rows\": 2\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Examples\"\n}\n[/block]\n## XML \n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"Request:\\n<?xml version=\\\"1.0\\\" encoding=\\\"UTF-8\\\"?>\\n<SOAP-ENV:Envelope xmlns:SOAP-ENV=\\\"http://schemas.xmlsoap.org/soap/envelope/\\\" xmlns:ns1=\\\"https://secure.eBizCharge.com/soap/2.0/uedocs\\\">\\n<SOAP-ENV:Body>\\n<ns1:displayPosDeviceScreen>\\n<Token>\\n<ClientIP>192.168.0.1</ClientIP>\\n<PinHash>\\n<HashValue>01c95985232effa5e74f07b39884a091a8982c97</HashValue>\\n<Seed>13651794221583757287</Seed>\\n<Type>sha1</Type>\\n</PinHash>\\n<SourceKey>e42SYc86C4uvlvyP62ow54Kv93SZsJVm</SourceKey>\\n</Token>\\n<Screen>idle</Screen>\\n<Message>Testing 879642494</Message>\\n</ns1:displayPosDeviceScreen>\\n</SOAP-ENV:Body>\\n</SOAP-ENV:Envelope>\\nResponse:\\n\",\n      \"language\": \"xml\"\n    }\n  ]\n}\n[/block]","excerpt":"","slug":"displayposdevicescreen","type":"basic","title":"displayPosDeviceScreen"}

displayPosDeviceScreen


Display a screen/message on the pos device [block:api-header] { "type": "basic", "title": "Description" } [/block] Allows the developer to display a predefined screen to the pos device associated with the source key. For screens that support it, a custom message can also be set. If the name of screen does not match a screen that is available on the pos device, the default idle screen will be displayed. [block:api-header] { "type": "basic", "title": "Syntax" } [/block] **displayPosDeviceScreen** ( [ueSecurityToken](/docs/uesecuritytoken) Token, string Screen, string Message) [block:api-header] { "type": "basic", "title": "Arguments" } [/block] [block:parameters] { "data": { "h-0": "Type", "h-1": "Name", "h-2": "Description", "0-0": "[ueSecurityToken](/docs/uesecuritytoken)", "0-1": "Token", "0-2": "Merchant security token: used to identify merchant and retrieve the custom fields.", "1-0": "string", "1-1": "Screen", "1-2": "Name of screen to display", "2-0": "string", "2-1": "Message", "2-2": "Message to display" }, "cols": 3, "rows": 3 } [/block] [block:api-header] { "type": "basic", "title": "Return Value" } [/block] [block:parameters] { "data": { "0-0": "string", "0-1": "Status", "0-2": "Confirmation that screen was displayed" }, "cols": 3, "rows": 1 } [/block] [block:api-header] { "type": "basic", "title": "Exceptions" } [/block] The following exceptions (errors) are applicable to this method. [block:parameters] { "data": { "h-0": "Code", "h-1": "Message", "h-2": "Advice", "0-0": "21100", "0-1": "There are no POS devices associated with this source key", "0-2": "Register a pos device to this source key", "1-0": "21101", "1-1": "POS device offline", "1-2": "Device associated with this source key is offline, try rebooting" }, "cols": 3, "rows": 2 } [/block] [block:api-header] { "type": "basic", "title": "Examples" } [/block] ## XML [block:code] { "codes": [ { "code": "Request:\n<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<SOAP-ENV:Envelope xmlns:SOAP-ENV=\"http://schemas.xmlsoap.org/soap/envelope/\" xmlns:ns1=\"https://secure.eBizCharge.com/soap/2.0/uedocs\">\n<SOAP-ENV:Body>\n<ns1:displayPosDeviceScreen>\n<Token>\n<ClientIP>192.168.0.1</ClientIP>\n<PinHash>\n<HashValue>01c95985232effa5e74f07b39884a091a8982c97</HashValue>\n<Seed>13651794221583757287</Seed>\n<Type>sha1</Type>\n</PinHash>\n<SourceKey>e42SYc86C4uvlvyP62ow54Kv93SZsJVm</SourceKey>\n</Token>\n<Screen>idle</Screen>\n<Message>Testing 879642494</Message>\n</ns1:displayPosDeviceScreen>\n</SOAP-ENV:Body>\n</SOAP-ENV:Envelope>\nResponse:\n", "language": "xml" } ] } [/block]