266 100-412-234 REV. 06
D.1 Web Services
D.1.1 Introduction
The 2000Xc Web Services provide functionality to access the system through Java Script
Object Notation (JSON) web requests. This web access encompasses practically every
aspect of the 2000Xc’s features; from modifying and reading presets to configuring
hardware and getting access to the internal logs of the power supply. In addition to that,
the web service interface offers fully functional login/logout capability that can allow the
client to remotely do anything that can be done from the front panel LCD.
This document gives the details of the web service implementation and interface to the
2000Xc. It also gives the details of JSON Service URLs and the data format required by
the client to implement custom software for the interface. Lastly, this document provides
examples of server/client interaction with details of the data to be expected.
D.1.2 Breakdown
The web service itself is broken down into 2 distinct portions: the URL string and the POST
data.
D.1.3 Service URL
The 2000Xc has a built-in web server that can handle various web requests. In order to
provide the web service functionality, the URL string that is to be sent to the power supply
to initiate the service is of the form:
http://<2000Xc IP Address>/Services/<Service Name>
Where the <2000Xc IP Address> is the IP Address found on the System Information
screen with the label “P/S IP” and the <Service Name> is the feature you wish to exploit.
See 6.12 System Information for details.
D.1.4 POST Method
As with many web requests there is typically additional data to be sent to the server that
accompanies the request. The two most widely used methods are GET and POST. It is
important to note that even though many of the services are attempting to retrieve, or
GET, data from the 2000Xc, all services are accompanied with a POST request. If an
attempt is made to use the GET method, a “Notfound” response will be returned to the
client.
The POST data is in JSON format and is specific to each service. All data must follow JSON
guidelines or else the server will reject the request with a specific error code.
To Next Page
Loading...
