CLI Reference Guide

NOTE: Changes to the transport protocol — to use or stop using SSL — should be done during device
configuration (Embedded webserver). See the HP Embedded Capture Admin Guide for more information.
NOTE: For all API methods described in this document, URLs have been simplified by replacing the value
with %API_URL%
1.2.1 XML encoding
All API parameters are based on standard XML documents. The conventions used for this XML are the
following:
●
PascalCase for elements
●
camelCase for attributes
Example:
1.2.2 XSD validation
Embedded Capture API is validated by an XSD schema that is available for downloading from the devices.
Each API includes a “schema” section that helps obtain the XSD document in real time.
To identify any issues with content on a client PC, it is highly recommended that XSD schemas be used to
validate the content before sending it to the API.
1.2.3 Response codes
Each API call response message will include a code and a descriptive message. The message description may
change on future releases of HP Embedded Capture (HP EC).
TIP: Any client application using the response information may use the error codes in place of strings to
ensure future compatibility.
2 Chapter 1 API Introduction