MDM Registry Edition
- MDM Registry Edition 10.5
- All Products
Web Service
| Description
| Parameters
| Return Code
|
---|---|---|---|
ssacx_connect
| Initiates a socket.
| host is the host to connect to.
port is the port to connect to.
sockh is a socket handle.
| negative for error, 0 for success
|
<?xml version="1.0" ?> <soap:Envelope xmlns:soap=" http://schemas.xmlsoap.org/soap/envelope/"> <soap:Body> <ssacx_connect xmlns="http://www.identitysystems.com/xmlschema/iss-version-1/consoleSvc "> <host>value</host> <port>301</por t> </ssacx_connec t> </soap:Body> </soap:Envelope>
<?xml version="1.0" ?> <soap:Envelope xmlns:soap=" http://schemas.xmlsoap.org/soap/envelope/"> <soap:Body> <ssacx_connect_response xmlns="http://www.identitysystems.com/xmlschema/iss-version-1/consoleSvc "> <response>0</response> <sockh>302</sockh> </ssacx_connec t_response> </soap:Body> </soap:Envelope>
Web Service
| Description
| Parameters
| Return Code
|
---|---|---|---|
ssacx_database_create
| Create a new database.
| database_name - The name of the database.
work_directory - The work directory for the server to use.
| negative for error, 0 for success
|
<?xml version=" 1 . 0 " ?> <soap:Envelope xmlns:soap=" h t t p ://schemas . xmlsoap . org/soap/envelope/"> <soap:Body> <ssacx_database_create xmlns="http://www.identitysystems.com/xmlschema/iss-version-1/consoleSvc "> <database_name>value</database_name> <work_directory>value</work_directory> </ssacx_database_create> </soap:Body> </soap:Envelope>
<?xml version="1.0"?> <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> <soap:Body> <ssacx_database_create_response xmlns="http://www.identitysystems.com/xmlschema/iss-version-1/consoleSvc "> <response>0</response> </ssacx_database_create_response> </soap:Body> </soap:Envelope>
Web Service
| Description
| Parameters
| Return Code
|
---|---|---|---|
ssacx_database_delete
| Delete an existing database.
| database_name - The name of the database.
work_directory - The work directory for the server to use.
| negative for error, 0 for success
|
<?xml version="1.0"?> <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> <soap:Body> <ssacx_database_delete xmlns="http://www.identitysystems.com/xmlschema/iss-version-1/consoleSvc "> <database_name>value</database_name> <work_directory>value</work_directory> </ssacx_database_delete> </soap:Body> </soap:Envelope>
<?xml version="1.0"?> <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> <soap:Body> <ssacx_database_delete_response xmlns="http://www.identitysystems.com/xmlschema/iss-version-1/consoleSvc "> <response>0</response> </ssacx_database_delete_response> </soap:Body> </soap:Envelope>
Web Service
| Description
| Parameters
| Return Code
|
---|---|---|---|
ssacx_disconnect
| Releases resources allocated to a socket.
| none
| negative for error, 0 for success
|
<?xml version="1.0"?> <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> <soap:Body> <ssacx_disconnect xmlns="http://www.identitysystems.com/xmlschema/iss-version-1/consoleSvc "></ssacx_disconnect> </soap:Body> </soap:Envelope>
<?xml version="1.0"?> <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> <soap:Body> <ssacx_disconnect_response xmlns="http://www.identitysystems.com/xmlschema/iss-version-1/consoleSvc "> <response>0</response> </ssacx_disconnect_response> </soap:Body> </soap:Envelope>
Web Service
| Description
| Parameters
| Return Code
|
---|---|---|---|
ssacx_errors_get_all
| Get the Server side error messages from the last API function that failed. This function should be called repeatedly until it returns 1, meaning all messages have been retrieved.
| msg is an error message.
| negative for error, 0 for success
|
<?xml version="1.0"?> <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> <soap:Body> <ssacx_errors_get_all xmlns="http://www.identitysystems.com/xmlschema/iss-version-1/consoleSvc "> <msg_size>256</msg_size> </ssacx_errors_get_all> </soap:Body> </soap:Envelope>
<?xml version="1.0"?> <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> <soap:Body> <ssacx_errors_get_all_response xmlns="http://www.identitysystems.com/xmlschema/iss-version-1/consoleSvc "> <response>0</response> <msg>value</msg> </ssacx_errors_get_all_response> </soap:Body> </soap:Envelope>
Web Service
| Description
| Parameters
| Return Code
|
---|---|---|---|
ssacx_job_run
| Run a user job. Start the job and report status when it is finished.
| rulebase_name - The name of the rulebase.
system_name
- The name of the system
job_name -The name of the job
job_number - The number of the job
job_report - The report on the progress of the job
work_directory - The work directory for the server to use
| negative for error, 0 for success
|
<?xml version="1.0"?> <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> <soap:Body> <ssacx_job_run xmlns="http://www.identitysystems.com/xmlschema/iss-version-1/consoleSvc "> <rulebase_name>value</rulebase_name> <system_name>value</system_name> <job_name>value</job_name> <job_report_size>256</job_report_size> <work_directory>value</work_directory> </ssacx_job_run> </soap:Body> </soap:Envelope>
<?xml version="1.0"?> <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> <soap:Body> <ssacx_job_run_response xmlns="http://www.identitysystems.com/xmlschema/iss-version-1/consoleSvc "> <response>0</response> <job_number>302</job_number> <job_ report>value</job_ report> </ssacx_job_run_response> </soap:Body> </soap:Envelope>
Web Service
| Description
| Parameters
| Return Code
|
---|---|---|---|
ssacx_job_start
| Start a user job and return immediately.
| rulebase_name - The name of the rulebase.
system_name
- The name of the system
job_name -The name of the job
job_number - The number of the job
work_directory - The work directory for the server to use
| negative for error, 0 for success
|
<?xml version="1.0" ?> <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> <soap:Body> <ssacx_job_start xmlns="http://www.identitysystems.com/xmlschema/iss-version-1/consoleSvc "> <rulebase_name>value</rulebase_name> <system_name>value</system_name> <job_name>value</job_name> <work_directory>value</work_directory> </ssacx_job_start> </soap:Body> </soap:Envelope>
<?xml version="1.0" ?> <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> <soap:Body> <ssacx_job_start_response xmlns="http://www.identitysystems.com/xmlschema/iss-version-1/consoleSvc "> <response>0</response> <job_number>302</job_number> </ssacx_job_start_response> </soap:Body> </soap:Envelope>
Web Service
| Description
| Parameters
| Return Code
|
---|---|---|---|
ssacx_job_status
| Get the status of a user job.
| rulebase_name - The name of the rulebase.
system_name
- The name of the system
job_name -The name of the job
job_number - The number of the job
job_status -The status of the job (0 = success, 1 = running, -ve = failed)
job_report - The report on the progress of the job
work_directory - The work directory for the server to use
| negative for error, 0 for success
|
<?xml version="1.0" ?> <soap:Envelope xmlns:soap=" http://schemas.xmlsoap.org/soap/envelope/"> <soap:Body> <ssacx_job_status xmlns="http://www.identitysystems.com/xmlschema/iss-version-1/consoleSvc"> <rulebase_name>value</rulebase_name> <system_name>value</system_name> <job_name>value</job_name> <job_number>301</job_number> <job_report_size>256</job_report_size> <work_directory>value</work_directory> </ssacx_job_status> </soap:Body> </soap:Envelope>
<?xml version="1.0"?> <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> <soap:Body> <ssacx_job_status_response xmlns="http://www.identitysystems.com/xmlschema/iss-version-1/consoleSvc "> <response>0</response> <job_status>0</job_status> <job_report>value</job_report> </ssacx_job_status_response> </soap:Body> </soap:Envelope>
Web Service
| Description
| Parameters
| Return Code
|
---|---|---|---|
ssacx_job_stop
| Stop a user job.
| rulebase_name - The name of the rulebase.
system_name - The name of the system
job_number - The number of the job
work_directory - The work directory for the server to use
| negative for error, 0 for success
|
<?xml version="1.0"?> <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> <soap:Body> <ssacx_job_stop xmlns="http://www.identitysystems.com/xmlschema/iss-version-1/consoleSvc "> <rulebase_name>value</rulebase_name> <system_name>value</system_name> <job_number>301</job_number> <work_directory>value</work_directory> </ssacx_job_stop> </soap:Body> </soap:Envelope>
<?xml version="1.0"?> <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> <soap:Body> <ssacx_job_stop_response xmlns="http://www.identitysystems.com/xmlschema/iss-version-1/consoleSvc "> <response>0</response> </ssacx_job_stop_response> </soap:Body> </soap:Envelope>
Web Service
| Description
| Parameters
| Return Code
|
---|---|---|---|
ssacx_jobs_running
| List all the running jobs
| job_name The name of the job
job_number The number of the job
job_stepid The number of the step inside the job
job_progress A description of the activity of the job
| negative for error, 0 for success
|
<?xml version="1.0"?> <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> <soap:Body> <ssacx_jobs_running xmlns="http://www.identitysystems.com/xmlschema/iss-version-1/consoleSvc"></ssacx_jobs_running> </soap:Body> </soap:Envelope>
<?xml version="1.0" ?> <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> <soap:Body> <ssacx_jobs_running_response xmlns="http://www.identitysystems.com/xmlschema/iss-version-1/consoleSvc"> <response>0</response> <jobs_running> <job_name>value</job_name> <job_number>302</job_number> <job_stepid>302</job_ stepid> <job_progres sArray> <job_progres s>value</job_progress> </job_progres sArray> </jobs_running> </ssacx_jobs_running_response> </soap:Body> </soap:Envelope>
Web Service
| Description
| Parameters
| Return Code
|
---|---|---|---|
ssacx_rulebase_create
| Create a new rulebase.
| rulebase_name -The name of the rulebase
work_directory - The work directory for the server to use
| negative for error, 0 for success
|
<?xml version="1.0"?> <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> <soap:Body> <ssacx_rulebase_create xmlns="http://www.identitysystems.com/xmlschema/iss-version-1/consoleSvc "> <rulebase_name>value</rulebase_name> <work_directory>value</work_directory> </ssacx_rulebase_create> </soap:Body> </soap:Envelope>
<?xml version="1.0"?> <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> <soap:Body> <ssacx_rulebase_create_response xmlns="http://www.identitysystems.com/xmlschema/iss-version-1/consoleSvc "> <response>0</response> </ssacx_rulebase_create_response> </soap:Body> </soap:Envelope>
Web Service
| Description
| Parameters
| Return Code
|
---|---|---|---|
ssacx_rulebase_delete
| Delete an existing rulebase.
| rulebase_name -The name of the rulebase
work_directory - The work directory for the server to use
| negative for error, 0 for success
|
<?xml version="1.0"?> <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> <soap:Body> <ssacx_rulebase_delete xmlns="http://www.identitysystems.com/xmlschema/iss-version-1/consoleSvc "> <rulebase_name>value</rulebase_name> <work_directory>value</work_directory> </ssacx_rulebase_delete> </soap:Body> </soap:Envelope>
<?xml version="1.0"?> <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> <soap:Body> <ssacx_rulebase_delete_response xmlns="http://www.identitysystems.com/xmlschema/iss-version-1/consoleSvc "> <response>0</response> </ssacx_rulebase_delete_response> </soap:Body> </soap:Envelope>
Web Service
| Description
| Parameters
| Return Code
|
---|---|---|---|
ssacx_server_check
| Check the status of a server
| address - The URL of the server
| negative for error, 0 for success
|
<?xml version="1.0"?> <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> <soap:Body> <ssacx_server_check xmlns="http://www.identitysystems.com/xmlschema/iss-version-1/consoleSvc "> <address>value</address> </ssacx_server_check> </soap:Body> </soap:Envelope>
<?xml version="1.0"?> <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> <soap:Body> <ssacx_server_check_response xmlns="http://www.identitysystems.com/xmlschema/iss-version-1/consoleSvc "> <response>0</response> </ssacx_server_check_response> </soap:Body> </soap:Envelope>
Web Service
| Description
| Parameters
| Return Code
|
---|---|---|---|
ssacx_server_flush
| Issue a flush command to a server
| address - The URL of the server
| negative for error, 0 for success
|
<?xml version="1.0"?> <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> <soap:Body> <ssacx_server_flush xmlns="http://www.identitysystems.com/xmlschema/iss-version-1/consoleSvc "> <address>value</address> </ssacx_server_flush> </soap:Body> </soap:Envelope>
<?xml version="1.0"?> <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> <soap:Body> <ssacx_server_flush_response xmlns="http://www.identitysystems.com/xmlschema/iss-version-1/consoleSvc "> <response>0</response> </ssacx_server_flush_response> </soap:Body> </soap:Envelope>
Web Service
| Description
| Parameters
| Return Code
|
---|---|---|---|
ssacx_server_start
| Start a server
| server -The name of the server (HT = HTTP, RB = rulebase, SE = search, XM = XML search, XS = XML synchronizer)
address - The URL of the server
work_directory - The work directory for the server to use
| negative for error, 0 for success
|
<?xml version="1.0"?> <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> <soap:Body> <ssacx_server_start xmlns="http://www.identitysystems.com/xmlschema/iss-version-1/consoleSvc "> <server>value</server> <address>value</address> <work_directory>value</work_directory> </ssacx_server_start> </soap:Body> </soap:Envelope>
<?xml version="1.0"?> <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> <soap:Body> <ssacx_server_start_response xmlns="http://www.identitysystems.com/xmlschema/iss-version-1/consoleSvc "> <response>0</response> </ssacx_server_start_response> </soap:Body> </soap:Envelope>
Web Service
| Description
| Parameters
| Return Code
|
---|---|---|---|
ssacx_server_stop
| Stop a server
| address - The URL of the server
| negative for error, 0 for success
|
<?xml version="1.0"?> <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> <soap:Body> <ssacx_server_stop xmlns="http://www.identitysystems.com/xmlschema/iss-version-1/consoleSvc "> <address>value</address> </ssacx_server_stop> </soap:Body> </soap:Envelope>
<?xml version="1.0"?> <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> <soap:Body> <ssacx_server_stop_response xmlns="http://www.identitysystems.com/xmlschema/iss-version-1/consoleSvc "> <response>0</response> </ssacx_server_stop_response> </soap:Body> </soap:Envelope>
Web Service
| Description
| Parameters
| Return Code
|
---|---|---|---|
ssacx_servers_start
| Start the servers
| none
| negative for error, 0 for success
|
<?xml version="1.0"?> <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> <soap:Body> <ssacx_servers_start xmlns="http://www.identitysystems.com/xmlschema/iss-version-1/consoleSvc"></ssacx_servers_star</soap:Body> </soap:Envelope>
<?xml version="1.0"?> <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> <soap:Body> <ssacx_servers_start_response xmlns="http://www.identitysystems.com/xmlschema/iss-version-1/consoleSvc"> <response>0</response> </ssacx_servers_start_response> </soap:Body> </soap:Envelope>
Web Service
| Description
| Parameters
| Return Code
|
---|---|---|---|
ssacx_servers_stop
| Stop the servers
| none
| negative for error, 0 for success
|
<?xml version="1.0"?> <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> <soap:Body> <ssacx_servers_stop xmlns="http://www.identitysystems.com/xmlschema/iss-version-1/consoleSvc"></ssacx_servers_stop> </soap:Body> </soap:Envelope>
<?xml version="1.0"?> <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> <soap:Body> <ssacx_servers_stop_response xmlns="http://www.identitysystems.com/xmlschema/iss-version-1/consoleSvc"> <response>0</response> </ssacx_servers_stop_response> </soap:Body> </soap:Envelope>
Web Service
| Description
| Parameters
| Return Code
|
---|---|---|---|
ssacx_system_create
| Create a new system from a System Definition File (SDF)
| rulebase_name - The name of the rulebase
database_name - The name of the database
system_name - The name of the system
work_directory - The work directory for the server to use
sdf_name - The name of the System Definition File
| negative for error, 0 for success
|
<?xml version="1.0"?> <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> <soap:Body> <ssacx_system_create xmlns="http://www.identitysystems.com/xmlschema/iss-version-1/consoleSvc"> <rulebase_name>value</rulebase_name> <database_name>value</database_name> <system_name>value</system_name> <work_directory>value</work_directory> <sdf_name>value</sdf_name> </ssacx_system_create> </soap:Body> </soap:Envelope>
<?xml version="1.0"?> <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> <soap:Body> <ssacx_system_create_response xmlns="http://www.identitysystems.com/xmlschema/iss-version-1/consoleSvc"> <response>0</response> </ssacx_system_create_response> </soap:Body> </soap:Envelope>
Web Service
| Description
| Parameters
| Return Code
|
---|---|---|---|
ssacx_system_delete
| Delete an existing database.
| rulebase_name - The name of the rulebase
system_name - The name of the system
work_directory - The work directory for the server to use
| negative for error, 0 for success
|
<?xml version="1.0"?> <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> <soap:Body> <ssacx_system_delete xmlns="http://www.identitysystems.com/xmlschema/iss-version-1/consoleSvc"> <rulebase_name>value</rulebase_name> <system_name>value</system_name> <work_directory>value</work_directory> </ssacx_system_delete> </soap:Body> </soap:Envelope>
<?xml version="1.0"?> <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> <soap:Body> <ssacx_system_delete_response xmlns="http://www.identitysystems.com/xmlschema/iss-version-1/consoleSvc"> <response>0</response> </ssacx_system_delete_response> </soap:Body> </soap:Envelope>
Web Service
| Description
| Parameters
| Return Code
|
---|---|---|---|
ssacx_system_import
| Create a system from an export file
| rulebase_name - The name of the rulebase
database_name - The name of the database
system_name - The name of the system
work_directory - The work directory for the server to use
file_name - The name of the file
| negative for error, 0 for success
|
<?xml version="1.0"?> <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> <soap:Body> <ssacx_system_import xmlns="http://www.identitysystems.com/xmlschema/iss-version-1/consoleSvc"> <rulebase_name>value</rulebase_name> <database_name>value</database_name> <system_name>value</system_name> <work_directory>value</work_directory> <file_name>value</file_name> </ssacx_system_import> </soap:Body> </soap:Envelope>
<?xml version="1.0"?> <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> <soap:Body> <ssacx_system_import_response xmlns="http://www.identitysystems.com/xmlschema/iss-version-1/consoleSvc"> <response>0</response> </ssacx_system_import_response> </soap:Body> </soap:Envelope>
Web Service
| Description
| Parameters
| Return Code
|
---|---|---|---|
ssacx_system_status_get
| Get the status of a system
| rulebase_name - The name of the rulebase
system_name - The name of the system
work_directory - The work directory for the server to use
system_status - The system status (build, locked, production, test or prototype)
| negative for error, 0 for success
|
<?xml version="1.0"?> <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> <soap:Body> <ssacx_system_status_get xmlns="http://www.identitysystems.com/xmlschema/iss-version-1/consoleSvc"> <rulebase_name>value</rulebase_name> <system_name>value</system_name> <work_directory>value</work_directory> <system_status_size>256</system_status_size> </ssacx_system_status_get> </soap:Body> </soap:Envelope>
<?xml version="1.0"?> <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> <soap:Body> <ssacx_system_status_get_response xmlns="http://www.identitysystems.com/xmlschema/iss-version-1/consoleSvc"> <response>0</response> <system_status>value</system_status> </ssacx_system_status_get_response> </soap:Body> </soap:Envelope>
Web Service
| Description
| Parameters
| Return Code
|
---|---|---|---|
ssacx_system_status_set
| Set the status of a system
| rulebase_name - The name of the rulebase
system_name - The name of the system
work_directory - The work directory for the server to use
system_status - The system status (build, locked, production, test or prototype)
| negative for error, 0 for success
|
<?xml version="1.0"?> <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> <soap:Body> <ssacx_system_status_set xmlns="http://www.identitysystems.com/xmlschema/iss-version-1/consoleSvc"> <rulebase_name>value</rulebase_name> <system_name>value</system_name> <work_directory>value</work_directory> <system_status>value</system_status> </ssacx_system_status_set> </soap:Body> </soap:Envelope>
<?xml version="1.0"?> <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> <soap:Body> <ssacx_system_status_set_response xmlns="http://www.identitysystems.com/xmlschema/iss-version-1/consoleSvc"> <response>0</response> </ssacx_system_status_set_response> </soap:Body> </soap:Envelope>