Versions Compared

Version Old Version 4 New Version Current
Changes made by

Josefin Klang (Deactivated)

Josefin Klang (Deactivated)

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Updated formatting

...

As the request opens a user interface, it may only be called from localhost.

Image Removed

...

Request and Response overview

...

Request (REST)
title
 Code Block
POST http://localhost:54880/ConfigManager
 Code Block
Request (SOAP)
title
 Code Block
soap operation ConfigManager
 Code Block
Request Data
 Code Block
<?xml version="1.0"?>
<configuration language="EN"/>
Response Data on success
Response Data on success
 Code Block
languagexml
title
<?xml version="1.0"?>
<status_response>
	<result_id>0</result_id>
	<result_text>Success</result_text>
</status_response>
Response Data on error see Introduction to API.
...
Request and Response in detail
Element
Attribute
Description
configuration
[in], Required. Root element for the ConfigurationManger request.
language
[in] Language of the user interface. For details see the notes in Introduction to API.
Retrieve system status
The SystemStatus request is used to retrieve the current system status. As the request does not have an user interface, the web service may be located at localhost or at a separate machine.
...
...
Request and Response overview
...
...
Request (REST)
 Code Block
GET http://localhost:54880/SystemStatus
code
title
Request (SOAP)
title
 Code Block
soap operation SystemStatus
 Code Block
Request Data
 Code Block
None. Therefore, note to use HTTP GET and not POST when using REST!
Response Data on success
Response Data on success
 Code Block
languagexml
title
<?xml version="1.0"?>
<system_status>
	<sdk version="5.0.0.151"/>
	<license valid="true"/>
	<machine name="Workstation75216" port="54880"/>
	<production_status id="0" text="Ready"/>
</system_status>
<cards>
Response Data on error see Introduction to API.
...
Request and Response in detail
Element
Attribute
Description
system_status
[out] Root element for the system status request.
sdk/@version
[out] SDK Version according to the following four numbers scheme:
<major>.<minor>.<maintenance>.<build>
license/@valid
[out] The general information (true or false) if the SDK is in charge of a valid license.
machine/@name
[out] The machine name where the web service is installed.
system/machine/@port
[out] The port number that is used by the web service.
production_status/@id
production_status/@text
[out] The identifier and a textual representation of the current web service status. The value signals the status to accept CardJob requests.
  • id = 0 means the service is ready. A sent card job will be processed immediately.
  • id = 1 means the service is busy. If a new card job is sent it is queued (which means the request will only return when the current card job request is processed).