Epson TM-H6000V Web Config API Users Manual - Page 10

Acquisition of setting values from the printer, Creation of setting values

Page 10 highlights

Chapter 1 Overview Acquisition of setting values from the printer The GET Request() is used to acquire setting values from the printer. The settings can be acquired from the following URLs.  Used to acquire all data: https:///webconfig/api/v1/webconfig.cgi?keyname=,... The printer's setting values are included in the GET Response(). The data is in JSON format. Creation of setting values 1 Creation of each key value to configure the printer. There are two setting methods: You can specify only the value of the specified key or you can edit the JSON data acquired by using the GET Response().  Edit JSON data acquired from the printer. For example: Acquisition JSON data Edit data ... "StatusNotification": { "Active": "OFF", "ID": "", "Interval": "5", "Name": "" "Password": "(Not registered)", "Url": "", "UseProxy": "OFF", "UseServerAuthentication": "OFF", "UseUrlEncode": "ON" ... } "message" : "Success" }, ... ... "StatusNotification": { "Active": "ON", "ID": "", "Interval": "5", "Name": "PJ9F000156", "Url": "http:\/\/statusnoticationserver.test\/test.php", "UseProxy": "OFF", "UseServerAuthentication": "OFF", "UseUrlEncode": "ON" ... } "message" : "Success" }, ...  Specify only the value of the specified key. Specify the key and value, see "Reference" on page 25. Setting values are Sent to the Printer The specified JSON data is sent to the printer by the PUT Request(). https://

  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8
  • 9
  • 10
  • 11
  • 12
  • 13
  • 14
  • 15
  • 16
  • 17
  • 18
  • 19
  • 20
  • 21
  • 22
  • 23
  • 24
  • 25
  • 26
  • 27
  • 28

10
Chapter 1
Overview
1
Acquisition of setting values from the printer
The GET Request() is used to acquire setting values from the printer. The settings can be acquired from the fol-
lowing URLs.
Used to acquire all data:
https://<Printer’s IP address>/webconfig/api/v1/webconfig.cgi
Used to acquire a specific key:
https://<Printer’s IP address>/webconfig/api/v1/webconfig.cgi?keyname=<keyname1>,<keyname2>...
The printer's setting values are included in the GET Response(). The data is in JSON format.
Creation of setting values
Creation of each key value to configure the printer.
There are two setting methods: You can specify only the value of the specified key or you can edit the JSON data
acquired by using the GET Response().
Edit JSON data acquired from the printer.
Specify only the value of the specified key.
Specify the key and value, see
"Reference" on page 25
.
Setting values are Sent to the Printer
The specified JSON data is sent to the printer by the PUT Request().
https://<Printer’s IP address>/webconfig/api/v1/webconfig.cgi
Check the Response
When a printer receives a PUT Request, it returns a PUT Response().
If the setting values are processed normally, the "message" parameter of the PUT Response() is "Success".
The values in the PUT Response () are not the values that was set in the printer. Rather, they are the
setting values from the PUT Request ().
...
"StatusNotification": {
"Active": "OFF",
"ID": "",
"Interval": "5",
"Name": ""
"Password": "(Not registered)",
"Url": "",
"UseProxy": "OFF",
"UseServerAuthentication": "OFF",
"UseUrlEncode": "ON"
...
}
"message" : "Success"
},
...
...
"StatusNotification": {
"Active": "ON",
"ID": "",
"Interval": "5",
"Name": "PJ9F000156",
"Url": "
http:\/\/statusnoticationserver.test\/test.php
",
"UseProxy": "OFF",
"UseServerAuthentication": "OFF",
"UseUrlEncode": "ON"
...
}
"message" : "Success"
},
...
For example:
Acquisition JSON data
Edit data