COMPASS 6.2 - Service REST API
COMPASS Version 6.2, 6.3, 6.4 © General Re Corporation 2021 - 2026. All Rights Reserved (created: 2026-06-16 generated: 2026-07-10)
Introduction
This document describes the REST API of the COMPASS Service. The COMPASS Service can be run standalone, under a servlet-container or on a cloud environment. It will expose the following APIs described in the next chapters. All calls are POST or GET calls.
For backwards compatibility of the responses most of the calls have two flavors: JSON and XML. XML calls all have the ending “XML” and do have the same request objects than the JSON calls, but the response is an XML string.
When an existing technical user of the COMPASS-Server (standalone java program) with his own implementation of the ScreenBuilder interface wants to use the COMPASS Service, he/she only has to change the calling layer to COMPASS and use the XML flavor of the calls. For new integrators of the COMPASS Service we recommend the usage of the JSON calls.
Most of the JSON-Calls return a simple JSON-Object which is explained in detail for every call. The general structure is like this:
{
"path": "/compass/methodname",
"status": 0,
"statusText": "OK",
"errorDescriptions": [],
"jsonContent": {},
"byteContent": null,
"textContent": null
}If statusText is not OK the errorDescriptions will be filled with a
list of errorDescription-Objects. e.g.
"errorDescriptions": [
{
"errorCode": 323,
"errorMessage": "....exception.CompassOperationException: Case does not exist "
}
]Installation
For a quick test of the COMPASS Service you can start it as a runnable JAR.
Prerequisite: Installed JRE Version > 1.8
Please check if your COMPASS Service installation directory has at least this structure.
-
COMPASS-Service-directory-
bin-
start_COMPASS_Service.bat
-
cpath.bin
-
-
config-
server-
compass.properties
-
EMConversion.properties
-
-
CompassService.properties
-
-
script-
…
-
…
-
-
lib-
CompassService.war
-
mysql-connector-java-8.0.11.jar
-
-
log
-
The mysql-connector-java-8.0.11.jar is an example for the JDBC
database driver, please copy your valid driver in the lib directory
Edit the property file called config/CompassService.properties.
At least you have to change the entry compass.systemname in this file.
compass.systemname is the name of the system you want to uses with
COMPASS. It’s one of the systems declared in compass.properties Please
refer to GettingStarted [1] for the configuration of
these files.
Edit the cPath-File bin/cpath.bat
-
Edit
set jpath="C:\Java\jdk1.8\bin\java.exe"to point to your java.exe
Edit the start-batch bin/start_COMPASS_Service.bat
-
Edit
set dbDriver="lib\mysql-connector-java-8.0.11.jar"to your JDBC-Driver in yourlibDirectory
Please switch to your COMPASS-Service-directory/bin Directory and
start start_COMPASS_Service.bat
The COMPASS Service will start up in a few seconds and will answer REST-Calls to it.
Case manipulation API
These calls will copy, delete and transfer (from/to) a case in the /out of the input interface of compass.
GET /copyCase
Copies an existing case to another destination in the casedata database.
Note: Errors are noted in the errorDescriptions of the result JSON-Map
| Parameter | Description |
|---|---|
|
The id of the <i>Case</i> to be copied |
|
The id of the source subsystem from which this <i>Case</i> is copied |
|
The id of the <i>Case</i> to be created |
|
The id of the destination subsystem to which this <i>Case</i> will be copied |
|
The logging area |
| Path | Type | Description |
|---|---|---|
|
|
API call path |
|
|
If call is completed successfully, then status is set to 0, otherwise it is set to 'WARNING'(=1) or 'OPERATION FAILED'(=2) or 'FATAL ERROR'(=3) |
|
|
Tf call is completed successfully, then status is set to 'OK', otherwise it is set to 'WARNING' or 'OPERATION FAILED' or 'FATAL ERROR' |
|
|
List of errorDescriptions in a JSON response |
|
|
Empty on this call |
|
|
Empty on this call |
|
|
Empty on this call |
sample request
GET /copyCase?sourceCaseId=TestCase&sourceSubId=Demo&destCaseId=TestCaseCopy1&destSubId=Demo&loggingArea=0 HTTP/1.1
Host: localhost:8080sample response
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 173
{
"path" : "/copyCase",
"status" : 0,
"statusText" : "OK",
"errorDescriptions" : [ ],
"jsonContent" : { },
"byteContent" : null,
"textContent" : null
}GET /copyCaseXML
Copies one case to another destination in the casedata database. (XML-Version)
Returns an error if the case does not exists
| Parameter | Description |
|---|---|
|
the caseId of the case to copy |
|
the subId of the case to copy |
|
the destination caseId |
|
the destination subId |
|
the loggingArea |
| Path | Type | Description |
|---|---|---|
|
|
The returned OperationResult for this operation by COMPASS. It is in form of an XML string. |
sample request
GET /copyCaseXML?sourceCaseId=TestCase&sourceSubId=Demo&destCaseId=TestCaseCopy2&destSubId=Demo&loggingArea=0 HTTP/1.1
Host: localhost:8080sample response
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/xml;charset=UTF-8
Content-Length: 75
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
<?xml version="1.0" encoding="UTF-8"?>
<operationResult returnCode="0"/>GET /deleteCase
This command is used when an existing Input Interface should be removed (deleted) from the casedata database.
Note: returns no error if the case does not exists
| Parameter | Description |
|---|---|
|
the caseId of the case to delete |
|
the subId of the case to delete |
|
the loggingArea |
| Path | Type | Description |
|---|---|---|
|
|
API call path |
|
|
If call is completed successfully, then status is set to 0, otherwise it is set to 'WARNING'(=1) or 'OPERATION FAILED'(=2) or 'FATAL ERROR'(=3) |
|
|
Tf call is completed successfully, then status is set to 'OK', otherwise it is set to 'WARNING' or 'OPERATION FAILED' or 'FATAL ERROR' |
|
|
List of errorDescriptions in a JSON response |
|
|
Empty on this call |
|
|
Empty on this call |
|
|
Empty on this call |
sample request
GET /deleteCase?caseId=TestCaseCopy1&subId=Demo&loggingArea=0 HTTP/1.1
Host: localhost:8080sample response
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 175
{
"path" : "/deleteCase",
"status" : 0,
"statusText" : "OK",
"errorDescriptions" : [ ],
"jsonContent" : { },
"byteContent" : null,
"textContent" : null
}GET /deleteCaseXML
This command is used when an existing Input Interface should be removed (deleted) from the casedata database. (XML-Version)
Note: returns no error if the case does not exists
| Parameter | Description |
|---|---|
|
the caseId of the case to delete |
|
the subId of the case to delete |
|
the loggingArea |
| Path | Type | Description |
|---|---|---|
|
|
The returned OperationResult for this operation by COMPASS. It is in form of an XML string. |
sample request
GET /deleteCaseXML?caseId=TestCaseCopy2&subId=Demo&loggingArea=0 HTTP/1.1
Accept: application/xml
Host: localhost:8080sample response
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/xml;charset=UTF-8
Content-Length: 75
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
<?xml version="1.0" encoding="UTF-8"?>
<operationResult returnCode="0"/>GET /transferCaseFromDB
get one case from the casedata database
Note: Errors are noted in the errorDescriptions of the result JSON-Map
| Parameter | Description |
|---|---|
|
the caseId of the case to transfer from db |
|
the subId of the case to transfer from db |
|
the loggingArea |
| Path | Type | Description |
|---|---|---|
|
|
API call path |
|
|
If call is completed successfully, then status is set to 0, otherwise it is set to 'WARNING'(=1) or 'OPERATION FAILED'(=2) or 'FATAL ERROR'(=3) |
|
|
Tf call is completed successfully, then status is set to 'OK', otherwise it is set to 'WARNING' or 'OPERATION FAILED' or 'FATAL ERROR' |
|
|
List of errorDescriptions in a JSON response |
|
|
the case from the input database as JSON-Map |
|
|
Empty on this call |
|
|
Empty on this call |
sample request
GET /transferCaseFromDB?caseId=TestCase&subId=Demo&loggingArea=0 HTTP/1.1
Content-Type: application/json;charset=UTF-8
Host: localhost:8080sample response
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 26496
{
"path" : "/transferCaseFromDB",
"status" : 0,
"statusText" : "OK",
"errorDescriptions" : [ ],
"jsonContent" : {
"VersionID" : 1085,
"Locale" : "en",
"CSP" : 1,
"Benefit" : {
"TypeId" : 0,
"TypeIdName" : "Benefit",
"CaseAttribute" : [ {
"TypeId" : 271,
"TypeIdName" : "life basic_form",
"CaseAttributeValue" : {
"DBRefValue" : {
"Id" : 3,
"Name" : "Endowment"
}
}
}, {
"TypeId" : 94,
"TypeIdName" : "smoker Type",
"CaseAttributeValue" : {
"DBRefValue" : {
"Id" : 2,
"Name" : "General Benefit"
}
}
}, {
"TypeId" : 108,
"TypeIdName" : "name (benefit)",
"CaseAttributeValue" : {
"StringValue" : {
"Value" : "IP"
}
}
}, {
"TypeId" : 355,
"TypeIdName" : "life policy-type",
"CaseAttributeValue" : {
"DBRefValue" : {
"Id" : 3,
"Name" : "Single Life"
}
}
}, {
"TypeId" : 11,
"TypeIdName" : "benefit-type",
"CaseAttributeValue" : {
"DBRefValue" : {
"Id" : 10,
"Name" : "IP own"
}
}
} ],
"Id" : 6
},
"Complete" : "Yes",
"EventPayment" : {
"TypeId" : 1,
"TypeIdName" : "Insurance event payment",
"CaseAttribute" : [ {
"TypeId" : 292,
"TypeIdName" : "age_for_assessment",
"CaseAttributeValue" : {
"SingleValue" : {
"Value" : 33.0,
"UnitName" : "Year(s)",
"Unit" : 16
}
}
}, {
"TypeId" : 103,
"TypeIdName" : "annuity_sum (sum insured)",
"CaseAttributeValue" : {
"SingleValue" : {
"Value" : 0.0,
"UnitName" : "£",
"Unit" : 14
}
}
}, {
"TypeId" : 259,
"TypeIdName" : "bonus_level",
"CaseAttributeValue" : {
"SingleValue" : {
"Value" : 0.0,
"UnitName" : "%",
"Unit" : 12
}
}
}, {
"TypeId" : 37,
"TypeIdName" : "age at entry (examination limits)",
"CaseAttributeValue" : {
"SingleValue" : {
"Value" : 33.0,
"UnitName" : "Year(s)",
"Unit" : 16
}
}
}, {
"TypeId" : 750,
"TypeIdName" : "special_event_benefit (y/n)",
"CaseAttributeValue" : {
"DBRefValue" : {
"Id" : 0,
"Name" : "No"
}
}
}, {
"TypeId" : 316,
"TypeIdName" : "waiting_period",
"CaseAttributeValue" : {
"SingleValue" : {
"Value" : 14.0,
"UnitName" : "Weeks",
"Unit" : 8
}
}
}, {
"TypeId" : 105,
"TypeIdName" : "benefit_payment_period",
"CaseAttributeValue" : {
"SingleValue" : {
"Value" : 20.0,
"UnitName" : "Year(s)",
"Unit" : 16
}
}
}, {
"TypeId" : 161,
"TypeIdName" : "Eventtype",
"CaseAttributeValue" : {
"DBRefValue" : {
"Id" : 0,
"Name" : "Disability own/similar"
}
}
}, {
"TypeId" : 751,
"TypeIdName" : "borrowing",
"CaseAttributeValue" : ""
}, {
"TypeId" : 262,
"TypeIdName" : "conversion_right (y/n)",
"CaseAttributeValue" : {
"DBRefValue" : {
"Id" : 0,
"Name" : "No"
}
}
}, {
"TypeId" : 777,
"TypeIdName" : "premium class",
"CaseAttributeValue" : ""
}, {
"TypeId" : 121,
"TypeIdName" : "insurance_period",
"CaseAttributeValue" : {
"SingleValue" : {
"Value" : 20.0,
"UnitName" : "Year(s)",
"Unit" : 16
}
}
}, {
"TypeId" : 333,
"TypeIdName" : "examination_group",
"CaseAttributeValue" : {
"DBRefValue" : {
"Id" : 3,
"Name" : "IP o/s"
}
}
}, {
"TypeId" : 222,
"TypeIdName" : "benefit sum",
"CaseAttributeValue" : {
"SingleValue" : {
"Value" : 1200.0,
"UnitName" : "£/Month",
"Unit" : 3
}
}
} ],
"Id" : 7
},
"CaseObject" : [ {
"TypeId" : 25,
"TypeIdName" : "Application",
"CaseAttribute" : [ {
"TypeId" : 0,
"TypeIdName" : "application-ID",
"CaseAttributeValue" : {
"StringValue" : {
"Value" : "FS"
}
}
}, {
"TypeId" : 102,
"TypeIdName" : "agent_code",
"CaseAttributeValue" : ""
}, {
"TypeId" : 38,
"TypeIdName" : "own_prev_assess_present (y/n)",
"CaseAttributeValue" : {
"DBRefValue" : {
"Id" : 1,
"Name" : "Yes"
}
}
}, {
"TypeId" : 250,
"TypeIdName" : "association registry existing (y/n)",
"CaseAttributeValue" : {
"DBRefValue" : {
"Id" : 1,
"Name" : "Yes"
}
}
}, {
"TypeId" : 365,
"TypeIdName" : "agent_name",
"CaseAttributeValue" : ""
} ],
"Id" : 0
}, {
"Identifies" : 3,
"TypeId" : 28,
"TypeIdName" : "PH",
"Id" : 5
}, {
"TypeId" : 12,
"TypeIdName" : "Occupation",
"CaseAttribute" : [ {
"TypeId" : 135,
"TypeIdName" : "annual income current year",
"CaseAttributeValue" : {
"SingleValue" : {
"Value" : 30000.0,
"UnitName" : "£/Year",
"Unit" : 1
},
"Source" : 2
}
}, {
"TypeId" : 127,
"TypeIdName" : "occupational_status",
"CaseAttributeValue" : {
"DBRefValue" : {
"Id" : 11,
"Name" : "Employee"
},
"Source" : 2
}
}, {
"TypeId" : 209,
"TypeIdName" : "occupation_code",
"CaseAttributeValue" : {
"DBRefValue" : {
"Locale" : "en",
"Key" : 411202,
"Name" : "Bank clerk"
},
"Source" : 2
}
} ],
"Id" : 9
}, {
"TypeId" : 45,
"TypeIdName" : "Smoking present",
"CaseAttribute" : [ {
"TypeId" : 124,
"TypeIdName" : "number smoked",
"CaseAttributeValue" : {
"SingleValue" : {
"Value" : 12.0,
"UnitName" : "Amount/day",
"Unit" : 0
},
"Time" : 8096,
"Source" : 4
}
}, {
"TypeId" : 22,
"TypeIdName" : "smoking type",
"CaseAttributeValue" : {
"DBRefValue" : {
"Id" : 1,
"Name" : "Cigarettes"
},
"Time" : 5182,
"Source" : 4
}
} ],
"Id" : 10
}, {
"TypeId" : 27,
"TypeIdName" : "AP",
"CaseAttribute" : [ {
"TypeId" : 256,
"TypeIdName" : "hospital or psychiatrist for mental disorder (y/n)",
"CaseAttributeValue" : {
"DBRefValue" : {
"Id" : 0,
"Name" : "No"
},
"Source" : 4
}
}, {
"TypeId" : 78,
"TypeIdName" : "marital_status",
"CaseAttributeValue" : {
"DBRefValue" : {
"Id" : 1,
"Name" : "Single"
}
}
}, {
"TypeId" : 746,
"TypeIdName" : "para_possible (y/n)",
"CaseAttributeValue" : {
"DBRefValue" : {
"Id" : 0,
"Name" : "No"
}
}
}, {
"TypeId" : 223,
"TypeIdName" : "symptoms or complaints (y/n)",
"CaseAttributeValue" : {
"DBRefValue" : {
"Id" : 0,
"Name" : "No"
},
"Source" : 4
}
}, {
"TypeId" : 201,
"TypeIdName" : "depression (y/n)",
"CaseAttributeValue" : {
"DBRefValue" : {
"Id" : 0,
"Name" : "No"
},
"Source" : 4
}
}, {
"TypeId" : 268,
"TypeIdName" : "cancer, neoplasm (y/n)",
"CaseAttributeValue" : {
"DBRefValue" : {
"Id" : 0,
"Name" : "No"
},
"Source" : 4
}
}, {
"TypeId" : 257,
"TypeIdName" : "brain or spine tumour, cyst (y/n)",
"CaseAttributeValue" : {
"DBRefValue" : {
"Id" : 0,
"Name" : "No"
},
"Source" : 4
}
}, {
"TypeId" : 235,
"TypeIdName" : "pain, paralysis, dizziness (y/n)",
"CaseAttributeValue" : {
"DBRefValue" : {
"Id" : 0,
"Name" : "No"
},
"Source" : 4
}
}, {
"TypeId" : 224,
"TypeIdName" : "planned visit to health professional in next 4 weeks (y/n)",
"CaseAttributeValue" : {
"DBRefValue" : {
"Id" : 0,
"Name" : "No"
},
"Source" : 4
}
}, {
"TypeId" : 725,
"TypeIdName" : "periods_off_work (y/n)",
"CaseAttributeValue" : {
"DBRefValue" : {
"Id" : 0,
"Name" : "No"
},
"Source" : 4
}
}, {
"TypeId" : 202,
"TypeIdName" : "fam history myotonic dystrophy (y/n)",
"CaseAttributeValue" : {
"DBRefValue" : {
"Id" : 0,
"Name" : "No"
},
"Source" : 4
}
}, {
"TypeId" : 280,
"TypeIdName" : "urogenital system disorders (y/n)",
"CaseAttributeValue" : {
"DBRefValue" : {
"Id" : 0,
"Name" : "No"
},
"Source" : 4
}
}, {
"TypeId" : 258,
"TypeIdName" : "ear disorder (y/n)",
"CaseAttributeValue" : {
"DBRefValue" : {
"Id" : 0,
"Name" : "No"
},
"Source" : 4
}
}, {
"TypeId" : 158,
"TypeIdName" : "height",
"CaseAttributeValue" : {
"SingleValue" : {
"Value" : 177.0,
"UnitName" : "cm",
"Unit" : 13
},
"Source" : 4
}
}, {
"TypeId" : 236,
"TypeIdName" : "growth, lump, polyp or tumour (y/n)",
"CaseAttributeValue" : {
"DBRefValue" : {
"Id" : 0,
"Name" : "No"
},
"Source" : 4
}
}, {
"TypeId" : 36,
"TypeIdName" : "weight",
"CaseAttributeValue" : {
"SingleValue" : {
"Value" : 80.0,
"UnitName" : "kg",
"Unit" : 6
},
"Time" : 648,
"Source" : 4
}
}, {
"TypeId" : 203,
"TypeIdName" : "fam history multiple sclerosis (y/n)",
"CaseAttributeValue" : {
"DBRefValue" : {
"Id" : 0,
"Name" : "No"
},
"Source" : 4
}
}, {
"TypeId" : 715,
"TypeIdName" : "stop_drinking (y/n)",
"CaseAttributeValue" : {
"DBRefValue" : {
"Id" : 0,
"Name" : "No"
},
"Source" : 4
}
}, {
"TypeId" : 281,
"TypeIdName" : "circulatory system disorders (y/n)",
"CaseAttributeValue" : {
"DBRefValue" : {
"Id" : 0,
"Name" : "No"
},
"Source" : 4
}
}, {
"TypeId" : 738,
"TypeIdName" : "recreational drugs (y/n)",
"CaseAttributeValue" : {
"DBRefValue" : {
"Id" : 0,
"Name" : "No"
},
"Source" : 4
}
}, {
"TypeId" : 226,
"TypeIdName" : "cough for 3 weeks (y/n)",
"CaseAttributeValue" : {
"DBRefValue" : {
"Id" : 0,
"Name" : "No"
},
"Source" : 4
}
}, {
"TypeId" : 204,
"TypeIdName" : "fam history colon cancer, polyposis (y/n)",
"CaseAttributeValue" : {
"DBRefValue" : {
"Id" : 0,
"Name" : "No"
},
"Source" : 4
}
}, {
"TypeId" : 282,
"TypeIdName" : "diabetes, ... (y/n)",
"CaseAttributeValue" : {
"DBRefValue" : {
"Id" : 0,
"Name" : "No"
},
"Source" : 4
}
}, {
"TypeId" : 260,
"TypeIdName" : "eye disorder (y/n)",
"CaseAttributeValue" : {
"DBRefValue" : {
"Id" : 0,
"Name" : "No"
},
"Source" : 4
}
}, {
"TypeId" : 227,
"TypeIdName" : "unexplained bleeding, weight loss (y/n)",
"CaseAttributeValue" : {
"DBRefValue" : {
"Id" : 0,
"Name" : "No"
},
"Source" : 4
}
}, {
"TypeId" : 283,
"TypeIdName" : "respiratory system disorders (y/n)",
"CaseAttributeValue" : {
"DBRefValue" : {
"Id" : 0,
"Name" : "No"
},
"Source" : 4
}
}, {
"TypeId" : 83,
"TypeIdName" : "Hypertension, raised cholesterol, blood (y/n)",
"CaseAttributeValue" : {
"DBRefValue" : {
"Id" : 0,
"Name" : "No"
},
"Source" : 4
}
}, {
"TypeId" : 72,
"TypeIdName" : "occupational_hazards_x (y/n)",
"CaseAttributeValue" : {
"DBRefValue" : {
"Id" : 0,
"Name" : "No"
},
"Time" : 2931,
"Source" : 2
}
}, {
"TypeId" : 61,
"TypeIdName" : "nationality",
"CaseAttributeValue" : {
"DBRefValue" : {
"Locale" : "en",
"Key" : "GB",
"Name" : "United Kingdom"
}
}
}, {
"TypeId" : 228,
"TypeIdName" : "planned doctor appointment in next 3 weeks (y/n)",
"CaseAttributeValue" : {
"DBRefValue" : {
"Id" : 0,
"Name" : "No"
},
"Source" : 4
}
}, {
"TypeId" : 206,
"TypeIdName" : "hospital or investigations (y/n)",
"CaseAttributeValue" : {
"DBRefValue" : {
"Id" : 0,
"Name" : "No"
},
"Source" : 4
}
}, {
"TypeId" : 184,
"TypeIdName" : "fam history hereditary disease (y/n)",
"CaseAttributeValue" : {
"DBRefValue" : {
"Id" : 0,
"Name" : "No"
},
"Source" : 4
}
}, {
"TypeId" : 73,
"TypeIdName" : "sex",
"CaseAttributeValue" : {
"DBRefValue" : {
"Id" : 2,
"Name" : "Male"
}
}
}, {
"TypeId" : 229,
"TypeIdName" : "current treatment (y/n)",
"CaseAttributeValue" : {
"DBRefValue" : {
"Id" : 0,
"Name" : "No"
},
"Time" : 10413,
"Source" : 4
}
}, {
"TypeId" : 307,
"TypeIdName" : "id_no (person)",
"CaseAttributeValue" : {
"StringValue" : {
"Value" : 1
}
}
}, {
"TypeId" : 285,
"TypeIdName" : "gastrointestinal tract disorders (y/n)",
"CaseAttributeValue" : {
"DBRefValue" : {
"Id" : 0,
"Name" : "No"
},
"Source" : 4
}
}, {
"TypeId" : 185,
"TypeIdName" : "fam history polycystic kidney disease (y/n)",
"CaseAttributeValue" : {
"DBRefValue" : {
"Id" : 0,
"Name" : "No"
},
"Source" : 4
}
}, {
"TypeId" : 230,
"TypeIdName" : "gynaecological disorders (y/n)",
"CaseAttributeValue" : {
"DBRefValue" : {
"Id" : 0,
"Name" : "No"
},
"Source" : 4
}
}, {
"TypeId" : 208,
"TypeIdName" : "fam history breast, ovarian cancer (y/n)",
"CaseAttributeValue" : {
"DBRefValue" : {
"Id" : 0,
"Name" : "No"
},
"Source" : 4
}
}, {
"TypeId" : 186,
"TypeIdName" : "fam history Huntington (y/n)",
"CaseAttributeValue" : {
"DBRefValue" : {
"Id" : 0,
"Name" : "No"
},
"Source" : 4
}
}, {
"TypeId" : 253,
"TypeIdName" : "gout or arthritis,... (y/n)",
"CaseAttributeValue" : {
"DBRefValue" : {
"Id" : 0,
"Name" : "No"
},
"Source" : 4
}
}, {
"TypeId" : 231,
"TypeIdName" : "smoking_x (y/n)",
"CaseAttributeValue" : {
"DBRefValue" : {
"Id" : 1,
"Name" : "Yes"
},
"Time" : 2951,
"Source" : 4
}
}, {
"TypeId" : 287,
"TypeIdName" : "nervous or neurological disorders (y/n)",
"CaseAttributeValue" : {
"DBRefValue" : {
"Id" : 0,
"Name" : "No"
},
"Source" : 4
}
}, {
"TypeId" : 187,
"TypeIdName" : "fam history Alzheimer (y/n)",
"CaseAttributeValue" : {
"DBRefValue" : {
"Id" : 0,
"Name" : "No"
},
"Source" : 4
}
}, {
"TypeId" : 265,
"TypeIdName" : "stroke, TIA,... (y/n)",
"CaseAttributeValue" : {
"DBRefValue" : {
"Id" : 0,
"Name" : "No"
},
"Source" : 4
}
}, {
"TypeId" : 176,
"TypeIdName" : "residence (country)",
"CaseAttributeValue" : {
"DBRefValue" : {
"Locale" : "en",
"Key" : "GB",
"Name" : "United Kingdom"
}
}
}, {
"TypeId" : 254,
"TypeIdName" : "gall, liver or pancreas disorder (y/n)",
"CaseAttributeValue" : {
"DBRefValue" : {
"Id" : 0,
"Name" : "No"
},
"Source" : 4
}
}, {
"TypeId" : 744,
"TypeIdName" : "preferred_life (y/n)",
"CaseAttributeValue" : {
"DBRefValue" : {
"Id" : 0,
"Name" : "No"
}
}
}, {
"TypeId" : 210,
"TypeIdName" : "fam history heart, diabetes (y/n)",
"CaseAttributeValue" : {
"DBRefValue" : {
"Id" : 0,
"Name" : "No"
},
"Source" : 4
}
}, {
"TypeId" : 288,
"TypeIdName" : "post_code",
"CaseAttributeValue" : {
"StringValue" : {
"Value" : 33333
}
}
}, {
"TypeId" : 199,
"TypeIdName" : "fam history motor neurone disease (y/n)",
"CaseAttributeValue" : {
"DBRefValue" : {
"Id" : 0,
"Name" : "No"
},
"Source" : 4
}
}, {
"TypeId" : 21,
"TypeIdName" : "age at application",
"CaseAttributeValue" : {
"SingleValue" : {
"Value" : 33.0,
"UnitName" : "Year(s)",
"Unit" : 16
}
}
}, {
"TypeId" : 155,
"TypeIdName" : "tested positive for HIV or hepatitis (y/n)",
"CaseAttributeValue" : {
"DBRefValue" : {
"Id" : 0,
"Name" : "No"
},
"Source" : 4
}
}, {
"TypeId" : 322,
"TypeIdName" : "drinking_x (y/n)",
"CaseAttributeValue" : {
"DBRefValue" : {
"Id" : 0,
"Name" : "No"
},
"Time" : 1533,
"Source" : 4
}
}, {
"TypeId" : 233,
"TypeIdName" : "thyroid disorders (y/n)",
"CaseAttributeValue" : {
"DBRefValue" : {
"Id" : 0,
"Name" : "No"
},
"Source" : 4
}
}, {
"TypeId" : 311,
"TypeIdName" : "pursuit_x (y/n)",
"CaseAttributeValue" : {
"DBRefValue" : {
"Id" : 0,
"Name" : "No"
},
"Time" : 1710,
"Source" : 2
}
}, {
"TypeId" : 44,
"TypeIdName" : "name",
"CaseAttributeValue" : {
"StringValue" : {
"Value" : "MEier"
}
}
}, {
"TypeId" : 211,
"TypeIdName" : "sexually transmitted disease (y/n)",
"CaseAttributeValue" : {
"DBRefValue" : {
"Id" : 0,
"Name" : "No"
},
"Source" : 4
}
}, {
"TypeId" : 200,
"TypeIdName" : "fam history Parkinson (y/n)",
"CaseAttributeValue" : {
"DBRefValue" : {
"Id" : 0,
"Name" : "No"
},
"Source" : 4
}
}, {
"TypeId" : 278,
"TypeIdName" : "mole or freckle (y/n)",
"CaseAttributeValue" : {
"DBRefValue" : {
"Id" : 0,
"Name" : "No"
},
"Source" : 4
}
}, {
"TypeId" : 267,
"TypeIdName" : "foreign_travel_x (y/n)",
"CaseAttributeValue" : {
"DBRefValue" : {
"Id" : 0,
"Name" : "No"
},
"Source" : 2
}
} ],
"Id" : 3
} ],
"Source" : [ {
"TypeId" : 100,
"TypeIdName" : "Technical data",
"Complete" : "Yes",
"DefaultSource" : "Yes",
"RelatedCaseObject" : 0,
"Id" : 1
}, {
"TypeId" : 5,
"TypeIdName" : "Non-health details NEW SB2",
"Complete" : "Yes",
"RelatedCaseObject" : 0,
"Id" : 2
}, {
"TypeId" : 6,
"TypeIdName" : "Health details NEW SB2",
"Complete" : "Yes",
"RelatedCaseObject" : 0,
"Id" : 4
} ],
"CaseMode" : "POS",
"Payment" : {
"TypeId" : 0,
"TypeIdName" : "Payment of Contribution",
"CaseAttribute" : [ {
"TypeId" : 12,
"TypeIdName" : "included_loading percent",
"CaseAttributeValue" : {
"SingleValue" : {
"Value" : 0.0,
"UnitName" : "%",
"Unit" : 12
}
}
}, {
"TypeId" : 15,
"TypeIdName" : "single_premium",
"CaseAttributeValue" : {
"SingleValue" : {
"Value" : 0.0,
"UnitName" : "£",
"Unit" : 14
}
}
}, {
"TypeId" : 41,
"TypeIdName" : "premium_payment_period",
"CaseAttributeValue" : {
"SingleValue" : {
"Value" : 20.0,
"UnitName" : "Year(s)",
"Unit" : 16
}
}
}, {
"TypeId" : 354,
"TypeIdName" : "annual_premium",
"CaseAttributeValue" : {
"SingleValue" : {
"Value" : 111.0,
"UnitName" : "£/Year",
"Unit" : 1
}
}
}, {
"TypeId" : 77,
"TypeIdName" : "included_loading per mille",
"CaseAttributeValue" : {
"SingleValue" : {
"Value" : 0.0,
"UnitName" : "%o",
"Unit" : 9
}
}
} ],
"Id" : 8
},
"PosRequest" : {
"ModuleId" : 100000555,
"ModuleName" : "Financial POS Gen Re",
"GeneratedInSource" : 2,
"RelatedCaseObject" : 3,
"Id" : 3,
"SuppressedByResult" : "No"
},
"CaseObjectRelation" : [ {
"TypeId" : 50,
"TypeIdName" : "Application has PH",
"From" : 0,
"To" : 5
}, {
"TypeId" : 14,
"TypeIdName" : "Application Person has occupation",
"From" : 3,
"To" : 9
}, {
"TypeId" : 69,
"TypeIdName" : "AP has smoking in the present",
"From" : 3,
"To" : 10
}, {
"TypeId" : 49,
"TypeIdName" : "Application has AP",
"From" : 0,
"To" : 3
}, {
"TypeId" : 43,
"TypeIdName" : "Application has Benefit",
"From" : 0,
"To" : 6
}, {
"TypeId" : 47,
"TypeIdName" : "Benefit has insurance event payment",
"From" : 6,
"To" : 7
}, {
"TypeId" : 53,
"TypeIdName" : "insurance event payment has Payment of contribution",
"From" : 7,
"To" : 8
}, {
"TypeId" : 20,
"TypeIdName" : "insurance event payment has AP",
"From" : 7,
"To" : 3
} ],
"NumberOfSourceChanges" : 90,
"VersionName" : "RuleManager UK 6.0 18.06.2020",
"Id" : "FS"
},
"byteContent" : null,
"textContent" : null
}GET /transferCaseFromDBDetails
gets case details of one case from the casedata base.
Note: Errors are noted in the errorDescriptions of the result JSON-Map
| Parameter | Description |
|---|---|
|
the caseId of the case whose details are to be transferred from db |
|
the subId of the case whose details are to be transferred from db |
|
the loggingArea |
| Path | Type | Description |
|---|---|---|
|
|
API call path |
|
|
If call is completed successfully, then status is set to 0, otherwise it is set to 'WARNING'(=1) or 'OPERATION FAILED'(=2) or 'FATAL ERROR'(=3) |
|
|
Tf call is completed successfully, then status is set to 'OK', otherwise it is set to 'WARNING' or 'OPERATION FAILED' or 'FATAL ERROR' |
|
|
List of errorDescriptions in a JSON response |
|
|
The details of a Case |
|
|
CSP Id of a Case |
|
|
Indicates whether a Case is complete |
|
|
Flag if a result is available |
|
|
Number of source changes of a Case |
|
|
Indicates the source information of a Case |
|
|
Source type id |
|
|
Name of the SourceType |
|
|
Indicates whether a SourceType |
|
|
Flag if SourceType is default |
|
|
The related CaseObject |
|
|
Id of the SourceType |
|
|
POS or STD |
|
|
Empty on this call |
|
|
Empty on this call |
sample request
GET /transferCaseFromDBDetails?caseId=TestCase&subId=Demo&loggingArea=0 HTTP/1.1
Content-Type: application/json;charset=UTF-8
Host: localhost:8080sample response
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 820
{
"path" : "/transferCaseFromDBDetails",
"status" : 0,
"statusText" : "OK",
"errorDescriptions" : [ ],
"jsonContent" : {
"CSP" : 1,
"Complete" : "Yes",
"ResultAvailable" : true,
"NumberOfSourceChanges" : 89,
"Source" : [ {
"TypeId" : 100,
"TypeIdName" : "Technical data",
"Complete" : "Yes",
"DefaultSource" : "Yes",
"RelatedCaseObject" : 0,
"Id" : 1
}, {
"TypeId" : 5,
"TypeIdName" : "Non-health details",
"Complete" : "Yes",
"RelatedCaseObject" : 0,
"Id" : 2
}, {
"TypeId" : 6,
"TypeIdName" : "Health details",
"Complete" : "Yes",
"RelatedCaseObject" : 0,
"Id" : 4
} ],
"CaseMode" : "POS"
},
"byteContent" : null,
"textContent" : null
}GET /transferCaseFromDBXML
get one case from the casedata database (XML-Version)
Returns an error if the case does not exists
| Parameter | Description |
|---|---|
|
the caseId of the case to transfer from db |
|
the subId of the case to transfer from db |
|
the loggingArea |
| Path | Type | Description |
|---|---|---|
|
|
The returned OperationResult for this operation by COMPASS. It is in form of an XML string. |
sample request
GET /transferCaseFromDBXML?caseId=TestCase&subId=Demo&loggingArea=0 HTTP/1.1
Host: localhost:8080sample response
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/xml;charset=UTF-8
Content-Length: 44302
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
<?xml version="1.0" encoding="UTF-8"?>
<operationResult returnCode="0">
<caseDestinationReference>
<directCaseReference>
<Case Complete="Yes" CaseMode="POS" VersionName="RuleManager UK 6.0 18.06.2020" CSP="1" Id="FS" VersionID="1085" Locale="en" NumberOfSourceChanges="90">
<Source Complete="Yes" TypeIdName="Technical data" DefaultSource="Yes" Id="1" RelatedCaseObject="0" TypeId="100"/>
<Source Complete="Yes" TypeIdName="Non-health details NEW SB2" Id="2" RelatedCaseObject="0" TypeId="5"/>
<PosRequest ModuleId="100000555" Id="3" RelatedCaseObject="3" SuppressedByResult="No" GeneratedInSource="2" ModuleName="Financial POS Gen Re"/>
<Source Complete="Yes" TypeIdName="Health details NEW SB2" Id="4" RelatedCaseObject="0" TypeId="6"/>
<CaseObject Id="0" TypeId="25" TypeIdName="Application">
<CaseAttribute TypeId="0" TypeIdName="application-ID">
<CaseAttributeValue>
<StringValue Value="FS"/>
</CaseAttributeValue>
</CaseAttribute>
<CaseAttribute TypeId="102" TypeIdName="agent_code">
<CaseAttributeValue/>
</CaseAttribute>
<CaseAttribute TypeId="38" TypeIdName="own_prev_assess_present (y/n)">
<CaseAttributeValue>
<DBRefValue Name="Yes" Id="1"/>
</CaseAttributeValue>
</CaseAttribute>
<CaseAttribute TypeId="250" TypeIdName="association registry existing (y/n)">
<CaseAttributeValue>
<DBRefValue Name="Yes" Id="1"/>
</CaseAttributeValue>
</CaseAttribute>
<CaseAttribute TypeId="365" TypeIdName="agent_name">
<CaseAttributeValue/>
</CaseAttribute>
</CaseObject>
<CaseObject TypeIdName="PH" Id="5" TypeId="28" Identifies="3"/>
<CaseObject Id="9" TypeId="12" TypeIdName="Occupation">
<CaseAttribute TypeId="135" TypeIdName="annual income current year">
<CaseAttributeValue Source="2">
<SingleValue UnitName="£/Year" Value="30000.0" Unit="1"/>
</CaseAttributeValue>
</CaseAttribute>
<CaseAttribute TypeId="127" TypeIdName="occupational_status">
<CaseAttributeValue Source="2">
<DBRefValue Name="Employee" Id="11"/>
</CaseAttributeValue>
</CaseAttribute>
<CaseAttribute TypeId="209" TypeIdName="occupation_code">
<CaseAttributeValue Source="2">
<DBRefValue Name="Bank clerk" Key="411202" Locale="en"/>
</CaseAttributeValue>
</CaseAttribute>
</CaseObject>
<CaseObject Id="10" TypeId="45" TypeIdName="Smoking present">
<CaseAttribute TypeId="124" TypeIdName="number smoked">
<CaseAttributeValue Source="4" Time="8096">
<SingleValue UnitName="Amount/day" Value="12.0" Unit="0"/>
</CaseAttributeValue>
</CaseAttribute>
<CaseAttribute TypeId="22" TypeIdName="smoking type">
<CaseAttributeValue Source="4" Time="5182">
<DBRefValue Name="Cigarettes" Id="1"/>
</CaseAttributeValue>
</CaseAttribute>
</CaseObject>
<CaseObject Id="3" TypeId="27" TypeIdName="AP">
<CaseAttribute TypeId="256" TypeIdName="hospital or psychiatrist for mental disorder (y/n)">
<CaseAttributeValue Source="4">
<DBRefValue Name="No" Id="0"/>
</CaseAttributeValue>
</CaseAttribute>
<CaseAttribute TypeId="78" TypeIdName="marital_status">
<CaseAttributeValue>
<DBRefValue Name="Single" Id="1"/>
</CaseAttributeValue>
</CaseAttribute>
<CaseAttribute TypeId="746" TypeIdName="para_possible (y/n)">
<CaseAttributeValue>
<DBRefValue Name="No" Id="0"/>
</CaseAttributeValue>
</CaseAttribute>
<CaseAttribute TypeId="223" TypeIdName="symptoms or complaints (y/n)">
<CaseAttributeValue Source="4">
<DBRefValue Name="No" Id="0"/>
</CaseAttributeValue>
</CaseAttribute>
<CaseAttribute TypeId="201" TypeIdName="depression (y/n)">
<CaseAttributeValue Source="4">
<DBRefValue Name="No" Id="0"/>
</CaseAttributeValue>
</CaseAttribute>
<CaseAttribute TypeId="268" TypeIdName="cancer, neoplasm (y/n)">
<CaseAttributeValue Source="4">
<DBRefValue Name="No" Id="0"/>
</CaseAttributeValue>
</CaseAttribute>
<CaseAttribute TypeId="257" TypeIdName="brain or spine tumour, cyst (y/n)">
<CaseAttributeValue Source="4">
<DBRefValue Name="No" Id="0"/>
</CaseAttributeValue>
</CaseAttribute>
<CaseAttribute TypeId="235" TypeIdName="pain, paralysis, dizziness (y/n)">
<CaseAttributeValue Source="4">
<DBRefValue Name="No" Id="0"/>
</CaseAttributeValue>
</CaseAttribute>
<CaseAttribute TypeId="224" TypeIdName="planned visit to health professional in next 4 weeks (y/n)">
<CaseAttributeValue Source="4">
<DBRefValue Name="No" Id="0"/>
</CaseAttributeValue>
</CaseAttribute>
<CaseAttribute TypeId="725" TypeIdName="periods_off_work (y/n)">
<CaseAttributeValue Source="4">
<DBRefValue Name="No" Id="0"/>
</CaseAttributeValue>
</CaseAttribute>
<CaseAttribute TypeId="202" TypeIdName="fam history myotonic dystrophy (y/n)">
<CaseAttributeValue Source="4">
<DBRefValue Name="No" Id="0"/>
</CaseAttributeValue>
</CaseAttribute>
<CaseAttribute TypeId="280" TypeIdName="urogenital system disorders (y/n)">
<CaseAttributeValue Source="4">
<DBRefValue Name="No" Id="0"/>
</CaseAttributeValue>
</CaseAttribute>
<CaseAttribute TypeId="258" TypeIdName="ear disorder (y/n)">
<CaseAttributeValue Source="4">
<DBRefValue Name="No" Id="0"/>
</CaseAttributeValue>
</CaseAttribute>
<CaseAttribute TypeId="158" TypeIdName="height">
<CaseAttributeValue Source="4">
<SingleValue UnitName="cm" Value="177.0" Unit="13"/>
</CaseAttributeValue>
</CaseAttribute>
<CaseAttribute TypeId="236" TypeIdName="growth, lump, polyp or tumour (y/n)">
<CaseAttributeValue Source="4">
<DBRefValue Name="No" Id="0"/>
</CaseAttributeValue>
</CaseAttribute>
<CaseAttribute TypeId="36" TypeIdName="weight">
<CaseAttributeValue Source="4" Time="648">
<SingleValue UnitName="kg" Value="80.0" Unit="6"/>
</CaseAttributeValue>
</CaseAttribute>
<CaseAttribute TypeId="203" TypeIdName="fam history multiple sclerosis (y/n)">
<CaseAttributeValue Source="4">
<DBRefValue Name="No" Id="0"/>
</CaseAttributeValue>
</CaseAttribute>
<CaseAttribute TypeId="715" TypeIdName="stop_drinking (y/n)">
<CaseAttributeValue Source="4">
<DBRefValue Name="No" Id="0"/>
</CaseAttributeValue>
</CaseAttribute>
<CaseAttribute TypeId="281" TypeIdName="circulatory system disorders (y/n)">
<CaseAttributeValue Source="4">
<DBRefValue Name="No" Id="0"/>
</CaseAttributeValue>
</CaseAttribute>
<CaseAttribute TypeId="738" TypeIdName="recreational drugs (y/n)">
<CaseAttributeValue Source="4">
<DBRefValue Name="No" Id="0"/>
</CaseAttributeValue>
</CaseAttribute>
<CaseAttribute TypeId="226" TypeIdName="cough for 3 weeks (y/n)">
<CaseAttributeValue Source="4">
<DBRefValue Name="No" Id="0"/>
</CaseAttributeValue>
</CaseAttribute>
<CaseAttribute TypeId="204" TypeIdName="fam history colon cancer, polyposis (y/n)">
<CaseAttributeValue Source="4">
<DBRefValue Name="No" Id="0"/>
</CaseAttributeValue>
</CaseAttribute>
<CaseAttribute TypeId="282" TypeIdName="diabetes, ... (y/n)">
<CaseAttributeValue Source="4">
<DBRefValue Name="No" Id="0"/>
</CaseAttributeValue>
</CaseAttribute>
<CaseAttribute TypeId="260" TypeIdName="eye disorder (y/n)">
<CaseAttributeValue Source="4">
<DBRefValue Name="No" Id="0"/>
</CaseAttributeValue>
</CaseAttribute>
<CaseAttribute TypeId="227" TypeIdName="unexplained bleeding, weight loss (y/n)">
<CaseAttributeValue Source="4">
<DBRefValue Name="No" Id="0"/>
</CaseAttributeValue>
</CaseAttribute>
<CaseAttribute TypeId="283" TypeIdName="respiratory system disorders (y/n)">
<CaseAttributeValue Source="4">
<DBRefValue Name="No" Id="0"/>
</CaseAttributeValue>
</CaseAttribute>
<CaseAttribute TypeId="83" TypeIdName="Hypertension, raised cholesterol, blood (y/n)">
<CaseAttributeValue Source="4">
<DBRefValue Name="No" Id="0"/>
</CaseAttributeValue>
</CaseAttribute>
<CaseAttribute TypeId="72" TypeIdName="occupational_hazards_x (y/n)">
<CaseAttributeValue Source="2" Time="2931">
<DBRefValue Name="No" Id="0"/>
</CaseAttributeValue>
</CaseAttribute>
<CaseAttribute TypeId="61" TypeIdName="nationality">
<CaseAttributeValue>
<DBRefValue Name="United Kingdom" Key="GB" Locale="en"/>
</CaseAttributeValue>
</CaseAttribute>
<CaseAttribute TypeId="228" TypeIdName="planned doctor appointment in next 3 weeks (y/n)">
<CaseAttributeValue Source="4">
<DBRefValue Name="No" Id="0"/>
</CaseAttributeValue>
</CaseAttribute>
<CaseAttribute TypeId="206" TypeIdName="hospital or investigations (y/n)">
<CaseAttributeValue Source="4">
<DBRefValue Name="No" Id="0"/>
</CaseAttributeValue>
</CaseAttribute>
<CaseAttribute TypeId="184" TypeIdName="fam history hereditary disease (y/n)">
<CaseAttributeValue Source="4">
<DBRefValue Name="No" Id="0"/>
</CaseAttributeValue>
</CaseAttribute>
<CaseAttribute TypeId="73" TypeIdName="sex">
<CaseAttributeValue>
<DBRefValue Name="Male" Id="2"/>
</CaseAttributeValue>
</CaseAttribute>
<CaseAttribute TypeId="229" TypeIdName="current treatment (y/n)">
<CaseAttributeValue Source="4" Time="10413">
<DBRefValue Name="No" Id="0"/>
</CaseAttributeValue>
</CaseAttribute>
<CaseAttribute TypeId="307" TypeIdName="id_no (person)">
<CaseAttributeValue>
<StringValue Value="1"/>
</CaseAttributeValue>
</CaseAttribute>
<CaseAttribute TypeId="285" TypeIdName="gastrointestinal tract disorders (y/n)">
<CaseAttributeValue Source="4">
<DBRefValue Name="No" Id="0"/>
</CaseAttributeValue>
</CaseAttribute>
<CaseAttribute TypeId="185" TypeIdName="fam history polycystic kidney disease (y/n)">
<CaseAttributeValue Source="4">
<DBRefValue Name="No" Id="0"/>
</CaseAttributeValue>
</CaseAttribute>
<CaseAttribute TypeId="230" TypeIdName="gynaecological disorders (y/n)">
<CaseAttributeValue Source="4">
<DBRefValue Name="No" Id="0"/>
</CaseAttributeValue>
</CaseAttribute>
<CaseAttribute TypeId="208" TypeIdName="fam history breast, ovarian cancer (y/n)">
<CaseAttributeValue Source="4">
<DBRefValue Name="No" Id="0"/>
</CaseAttributeValue>
</CaseAttribute>
<CaseAttribute TypeId="186" TypeIdName="fam history Huntington (y/n)">
<CaseAttributeValue Source="4">
<DBRefValue Name="No" Id="0"/>
</CaseAttributeValue>
</CaseAttribute>
<CaseAttribute TypeId="253" TypeIdName="gout or arthritis,... (y/n)">
<CaseAttributeValue Source="4">
<DBRefValue Name="No" Id="0"/>
</CaseAttributeValue>
</CaseAttribute>
<CaseAttribute TypeId="231" TypeIdName="smoking_x (y/n)">
<CaseAttributeValue Source="4" Time="2951">
<DBRefValue Name="Yes" Id="1"/>
</CaseAttributeValue>
</CaseAttribute>
<CaseAttribute TypeId="287" TypeIdName="nervous or neurological disorders (y/n)">
<CaseAttributeValue Source="4">
<DBRefValue Name="No" Id="0"/>
</CaseAttributeValue>
</CaseAttribute>
<CaseAttribute TypeId="187" TypeIdName="fam history Alzheimer (y/n)">
<CaseAttributeValue Source="4">
<DBRefValue Name="No" Id="0"/>
</CaseAttributeValue>
</CaseAttribute>
<CaseAttribute TypeId="265" TypeIdName="stroke, TIA,... (y/n)">
<CaseAttributeValue Source="4">
<DBRefValue Name="No" Id="0"/>
</CaseAttributeValue>
</CaseAttribute>
<CaseAttribute TypeId="176" TypeIdName="residence (country)">
<CaseAttributeValue>
<DBRefValue Name="United Kingdom" Key="GB" Locale="en"/>
</CaseAttributeValue>
</CaseAttribute>
<CaseAttribute TypeId="254" TypeIdName="gall, liver or pancreas disorder (y/n)">
<CaseAttributeValue Source="4">
<DBRefValue Name="No" Id="0"/>
</CaseAttributeValue>
</CaseAttribute>
<CaseAttribute TypeId="744" TypeIdName="preferred_life (y/n)">
<CaseAttributeValue>
<DBRefValue Name="No" Id="0"/>
</CaseAttributeValue>
</CaseAttribute>
<CaseAttribute TypeId="210" TypeIdName="fam history heart, diabetes (y/n)">
<CaseAttributeValue Source="4">
<DBRefValue Name="No" Id="0"/>
</CaseAttributeValue>
</CaseAttribute>
<CaseAttribute TypeId="288" TypeIdName="post_code">
<CaseAttributeValue>
<StringValue Value="33333"/>
</CaseAttributeValue>
</CaseAttribute>
<CaseAttribute TypeId="199" TypeIdName="fam history motor neurone disease (y/n)">
<CaseAttributeValue Source="4">
<DBRefValue Name="No" Id="0"/>
</CaseAttributeValue>
</CaseAttribute>
<CaseAttribute TypeId="21" TypeIdName="age at application">
<CaseAttributeValue>
<SingleValue UnitName="Year(s)" Value="33.0" Unit="16"/>
</CaseAttributeValue>
</CaseAttribute>
<CaseAttribute TypeId="155" TypeIdName="tested positive for HIV or hepatitis (y/n)">
<CaseAttributeValue Source="4">
<DBRefValue Name="No" Id="0"/>
</CaseAttributeValue>
</CaseAttribute>
<CaseAttribute TypeId="322" TypeIdName="drinking_x (y/n)">
<CaseAttributeValue Source="4" Time="1533">
<DBRefValue Name="No" Id="0"/>
</CaseAttributeValue>
</CaseAttribute>
<CaseAttribute TypeId="233" TypeIdName="thyroid disorders (y/n)">
<CaseAttributeValue Source="4">
<DBRefValue Name="No" Id="0"/>
</CaseAttributeValue>
</CaseAttribute>
<CaseAttribute TypeId="311" TypeIdName="pursuit_x (y/n)">
<CaseAttributeValue Source="2" Time="1710">
<DBRefValue Name="No" Id="0"/>
</CaseAttributeValue>
</CaseAttribute>
<CaseAttribute TypeId="44" TypeIdName="name">
<CaseAttributeValue>
<StringValue Value="MEier"/>
</CaseAttributeValue>
</CaseAttribute>
<CaseAttribute TypeId="211" TypeIdName="sexually transmitted disease (y/n)">
<CaseAttributeValue Source="4">
<DBRefValue Name="No" Id="0"/>
</CaseAttributeValue>
</CaseAttribute>
<CaseAttribute TypeId="200" TypeIdName="fam history Parkinson (y/n)">
<CaseAttributeValue Source="4">
<DBRefValue Name="No" Id="0"/>
</CaseAttributeValue>
</CaseAttribute>
<CaseAttribute TypeId="278" TypeIdName="mole or freckle (y/n)">
<CaseAttributeValue Source="4">
<DBRefValue Name="No" Id="0"/>
</CaseAttributeValue>
</CaseAttribute>
<CaseAttribute TypeId="267" TypeIdName="foreign_travel_x (y/n)">
<CaseAttributeValue Source="2">
<DBRefValue Name="No" Id="0"/>
</CaseAttributeValue>
</CaseAttribute>
</CaseObject>
<Benefit Id="6" TypeId="0" TypeIdName="Benefit">
<CaseAttribute TypeId="271" TypeIdName="life basic_form">
<CaseAttributeValue>
<DBRefValue Name="Endowment" Id="3"/>
</CaseAttributeValue>
</CaseAttribute>
<CaseAttribute TypeId="94" TypeIdName="smoker Type">
<CaseAttributeValue>
<DBRefValue Name="General Benefit" Id="2"/>
</CaseAttributeValue>
</CaseAttribute>
<CaseAttribute TypeId="108" TypeIdName="name (benefit)">
<CaseAttributeValue>
<StringValue Value="IP"/>
</CaseAttributeValue>
</CaseAttribute>
<CaseAttribute TypeId="355" TypeIdName="life policy-type">
<CaseAttributeValue>
<DBRefValue Name="Single Life" Id="3"/>
</CaseAttributeValue>
</CaseAttribute>
<CaseAttribute TypeId="11" TypeIdName="benefit-type">
<CaseAttributeValue>
<DBRefValue Name="IP own" Id="10"/>
</CaseAttributeValue>
</CaseAttribute>
</Benefit>
<EventPayment Id="7" TypeId="1" TypeIdName="Insurance event payment">
<CaseAttribute TypeId="292" TypeIdName="age_for_assessment">
<CaseAttributeValue>
<SingleValue UnitName="Year(s)" Value="33.0" Unit="16"/>
</CaseAttributeValue>
</CaseAttribute>
<CaseAttribute TypeId="103" TypeIdName="annuity_sum (sum insured)">
<CaseAttributeValue>
<SingleValue UnitName="£" Value="0.0" Unit="14"/>
</CaseAttributeValue>
</CaseAttribute>
<CaseAttribute TypeId="259" TypeIdName="bonus_level">
<CaseAttributeValue>
<SingleValue UnitName="%" Value="0.0" Unit="12"/>
</CaseAttributeValue>
</CaseAttribute>
<CaseAttribute TypeId="37" TypeIdName="age at entry (examination limits)">
<CaseAttributeValue>
<SingleValue UnitName="Year(s)" Value="33.0" Unit="16"/>
</CaseAttributeValue>
</CaseAttribute>
<CaseAttribute TypeId="750" TypeIdName="special_event_benefit (y/n)">
<CaseAttributeValue>
<DBRefValue Name="No" Id="0"/>
</CaseAttributeValue>
</CaseAttribute>
<CaseAttribute TypeId="316" TypeIdName="waiting_period">
<CaseAttributeValue>
<SingleValue UnitName="Weeks" Value="14.0" Unit="8"/>
</CaseAttributeValue>
</CaseAttribute>
<CaseAttribute TypeId="105" TypeIdName="benefit_payment_period">
<CaseAttributeValue>
<SingleValue UnitName="Year(s)" Value="20.0" Unit="16"/>
</CaseAttributeValue>
</CaseAttribute>
<CaseAttribute TypeId="161" TypeIdName="Eventtype">
<CaseAttributeValue>
<DBRefValue Name="Disability own/similar" Id="0"/>
</CaseAttributeValue>
</CaseAttribute>
<CaseAttribute TypeId="751" TypeIdName="borrowing">
<CaseAttributeValue/>
</CaseAttribute>
<CaseAttribute TypeId="262" TypeIdName="conversion_right (y/n)">
<CaseAttributeValue>
<DBRefValue Name="No" Id="0"/>
</CaseAttributeValue>
</CaseAttribute>
<CaseAttribute TypeId="777" TypeIdName="premium class">
<CaseAttributeValue/>
</CaseAttribute>
<CaseAttribute TypeId="121" TypeIdName="insurance_period">
<CaseAttributeValue>
<SingleValue UnitName="Year(s)" Value="20.0" Unit="16"/>
</CaseAttributeValue>
</CaseAttribute>
<CaseAttribute TypeId="333" TypeIdName="examination_group">
<CaseAttributeValue>
<DBRefValue Name="IP o/s" Id="3"/>
</CaseAttributeValue>
</CaseAttribute>
<CaseAttribute TypeId="222" TypeIdName="benefit sum">
<CaseAttributeValue>
<SingleValue UnitName="£/Month" Value="1200.0" Unit="3"/>
</CaseAttributeValue>
</CaseAttribute>
</EventPayment>
<Payment Id="8" TypeId="0" TypeIdName="Payment of Contribution">
<CaseAttribute TypeId="12" TypeIdName="included_loading percent">
<CaseAttributeValue>
<SingleValue UnitName="%" Value="0.0" Unit="12"/>
</CaseAttributeValue>
</CaseAttribute>
<CaseAttribute TypeId="15" TypeIdName="single_premium">
<CaseAttributeValue>
<SingleValue UnitName="£" Value="0.0" Unit="14"/>
</CaseAttributeValue>
</CaseAttribute>
<CaseAttribute TypeId="41" TypeIdName="premium_payment_period">
<CaseAttributeValue>
<SingleValue UnitName="Year(s)" Value="20.0" Unit="16"/>
</CaseAttributeValue>
</CaseAttribute>
<CaseAttribute TypeId="354" TypeIdName="annual_premium">
<CaseAttributeValue>
<SingleValue UnitName="£/Year" Value="111.0" Unit="1"/>
</CaseAttributeValue>
</CaseAttribute>
<CaseAttribute TypeId="77" TypeIdName="included_loading per mille">
<CaseAttributeValue>
<SingleValue UnitName="%o" Value="0.0" Unit="9"/>
</CaseAttributeValue>
</CaseAttribute>
</Payment>
<CaseObjectRelation From="0" TypeIdName="Application has PH" To="5" TypeId="50"/>
<CaseObjectRelation From="3" TypeIdName="Application Person has occupation" To="9" TypeId="14"/>
<CaseObjectRelation From="3" TypeIdName="AP has smoking in the present" To="10" TypeId="69"/>
<CaseObjectRelation From="0" TypeIdName="Application has AP" To="3" TypeId="49"/>
<CaseObjectRelation From="0" TypeIdName="Application has Benefit" To="6" TypeId="43"/>
<CaseObjectRelation From="6" TypeIdName="Benefit has insurance event payment" To="7" TypeId="47"/>
<CaseObjectRelation From="7" TypeIdName="insurance event payment has Payment of contribution" To="8" TypeId="53"/>
<CaseObjectRelation From="7" TypeIdName="insurance event payment has AP" To="3" TypeId="20"/>
</Case>
</directCaseReference>
</caseDestinationReference>
</operationResult>POST /transferCaseToDBXML
Transfers the XML Case to the casedata database (XML-Version) See
InputInterface 5.3.pdf for documentation of the XML-Case
Returns errors if the case exists, or the XML-Case is not correct
| Parameter | Description |
|---|---|
|
CaseId of the case to import |
|
SubId of the case to import |
| Path | Type | Description |
|---|---|---|
|
|
The Case in form of an XML string |
| Path | Type | Description |
|---|---|---|
|
|
The returned OperationResult for this operation by COMPASS. It is in form of an XML string. |
sample request
POST /transferCaseToDBXML?caseId=TestCaseImport&subId=Demo HTTP/1.1
Content-Type: application/xml;charset=UTF-8
Content-Length: 23784
Host: localhost:8080
<Case Complete="Yes" CaseMode="POS" VersionName="Shepherds Friendly UK 15.08.2018" CSP="1" Id="FS" VersionID="1077" Locale="en" NumberOfSourceChanges="84">
<Source Complete="Yes" TypeIdName="Technical data" DefaultSource="Yes" Id="1" RelatedCaseObject="0" TypeId="100"/>
<Source Complete="Yes" TypeIdName="Non-health details" Id="2" RelatedCaseObject="0" TypeId="5"/>
<PosRequest ModuleId="100000555" Id="3" RelatedCaseObject="3" SuppressedByResult="No" GeneratedInSource="2" ModuleName="Financial POS Gen Re"/>
<Source Complete="Yes" TypeIdName="Health details" Id="4" RelatedCaseObject="0" TypeId="6"/>
<CaseObject Id="0" TypeId="25" TypeIdName="Application">
<CaseAttribute TypeId="0" TypeIdName="application-ID">
<CaseAttributeValue>
<StringValue Value="FS"/>
</CaseAttributeValue>
</CaseAttribute>
<CaseAttribute TypeId="102" TypeIdName="agent_code">
<CaseAttributeValue/>
</CaseAttribute>
<CaseAttribute TypeId="38" TypeIdName="own_prev_assess_present (y/n)">
<CaseAttributeValue>
<DBRefValue Name="Yes" Id="1"/>
</CaseAttributeValue>
</CaseAttribute>
<CaseAttribute TypeId="250" TypeIdName="association registry existing (y/n)">
<CaseAttributeValue>
<DBRefValue Name="Yes" Id="1"/>
</CaseAttributeValue>
</CaseAttribute>
<CaseAttribute TypeId="365" TypeIdName="agent_name">
<CaseAttributeValue/>
</CaseAttribute>
</CaseObject>
<CaseObject TypeIdName="PH" Id="5" TypeId="28" Identifies="3"/>
<CaseObject Id="9" TypeId="12" TypeIdName="Occupation">
<CaseAttribute TypeId="135" TypeIdName="annual income current year">
<CaseAttributeValue Source="2">
<SingleValue UnitName="£/Year" Value="30000.0" Unit="1"/>
</CaseAttributeValue>
</CaseAttribute>
<CaseAttribute TypeId="127" TypeIdName="occupational_status">
<CaseAttributeValue Source="2">
<DBRefValue Name="Employee" Id="11"/>
</CaseAttributeValue>
</CaseAttribute>
<CaseAttribute TypeId="209" TypeIdName="occupation_code">
<CaseAttributeValue Source="2">
<DBRefValue Name="Bank clerk" Key="411202" Locale="en"/>
</CaseAttributeValue>
</CaseAttribute>
</CaseObject>
<CaseObject Id="10" TypeId="45" TypeIdName="Smoking present">
<CaseAttribute TypeId="124" TypeIdName="number smoked">
<CaseAttributeValue Source="4" Time="8096">
<SingleValue UnitName="Amount/day" Value="12.0" Unit="0"/>
</CaseAttributeValue>
</CaseAttribute>
<CaseAttribute TypeId="22" TypeIdName="smoking type">
<CaseAttributeValue Source="4" Time="5182">
<DBRefValue Name="Cigarettes" Id="1"/>
</CaseAttributeValue>
</CaseAttribute>
</CaseObject>
<CaseObject Id="3" TypeId="27" TypeIdName="AP">
<CaseAttribute TypeId="256" TypeIdName="hospital or psychiatrist for mental disorder (y/n)">
<CaseAttributeValue Source="4">
<DBRefValue Name="No" Id="0"/>
</CaseAttributeValue>
</CaseAttribute>
<CaseAttribute TypeId="78" TypeIdName="marital_status">
<CaseAttributeValue>
<DBRefValue Name="Single" Id="1"/>
</CaseAttributeValue>
</CaseAttribute>
<CaseAttribute TypeId="746" TypeIdName="para_possible (y/n)">
<CaseAttributeValue>
<DBRefValue Name="No" Id="0"/>
</CaseAttributeValue>
</CaseAttribute>
<CaseAttribute TypeId="223" TypeIdName="symptoms or complaints (y/n)">
<CaseAttributeValue Source="4">
<DBRefValue Name="No" Id="0"/>
</CaseAttributeValue>
</CaseAttribute>
<CaseAttribute TypeId="201" TypeIdName="depression (y/n)">
<CaseAttributeValue Source="4">
<DBRefValue Name="No" Id="0"/>
</CaseAttributeValue>
</CaseAttribute>
<CaseAttribute TypeId="268" TypeIdName="cancer, neoplasm (y/n)">
<CaseAttributeValue Source="4">
<DBRefValue Name="No" Id="0"/>
</CaseAttributeValue>
</CaseAttribute>
<CaseAttribute TypeId="257" TypeIdName="brain or spine tumour, cyst (y/n)">
<CaseAttributeValue Source="4">
<DBRefValue Name="No" Id="0"/>
</CaseAttributeValue>
</CaseAttribute>
<CaseAttribute TypeId="235" TypeIdName="pain, paralysis, dizziness (y/n)">
<CaseAttributeValue Source="4">
<DBRefValue Name="No" Id="0"/>
</CaseAttributeValue>
</CaseAttribute>
<CaseAttribute TypeId="224" TypeIdName="planned visit to health professional in next 4 weeks (y/n)">
<CaseAttributeValue Source="4">
<DBRefValue Name="No" Id="0"/>
</CaseAttributeValue>
</CaseAttribute>
<CaseAttribute TypeId="725" TypeIdName="periods_off_work (y/n)">
<CaseAttributeValue Source="4">
<DBRefValue Name="No" Id="0"/>
</CaseAttributeValue>
</CaseAttribute>
<CaseAttribute TypeId="202" TypeIdName="fam history myotonic dystrophy (y/n)">
<CaseAttributeValue Source="4">
<DBRefValue Name="No" Id="0"/>
</CaseAttributeValue>
</CaseAttribute>
<CaseAttribute TypeId="280" TypeIdName="urogenital system disorders (y/n)">
<CaseAttributeValue Source="4">
<DBRefValue Name="No" Id="0"/>
</CaseAttributeValue>
</CaseAttribute>
<CaseAttribute TypeId="258" TypeIdName="ear disorder (y/n)">
<CaseAttributeValue Source="4">
<DBRefValue Name="No" Id="0"/>
</CaseAttributeValue>
</CaseAttribute>
<CaseAttribute TypeId="158" TypeIdName="height">
<CaseAttributeValue Source="4">
<SingleValue UnitName="cm" Value="177.0" Unit="13"/>
</CaseAttributeValue>
</CaseAttribute>
<CaseAttribute TypeId="236" TypeIdName="growth, lump, polyp or tumour (y/n)">
<CaseAttributeValue Source="4">
<DBRefValue Name="No" Id="0"/>
</CaseAttributeValue>
</CaseAttribute>
<CaseAttribute TypeId="36" TypeIdName="weight">
<CaseAttributeValue Source="4" Time="648">
<SingleValue UnitName="kg" Value="80.0" Unit="6"/>
</CaseAttributeValue>
</CaseAttribute>
<CaseAttribute TypeId="203" TypeIdName="fam history multiple sclerosis (y/n)">
<CaseAttributeValue Source="4">
<DBRefValue Name="No" Id="0"/>
</CaseAttributeValue>
</CaseAttribute>
<CaseAttribute TypeId="715" TypeIdName="stop_drinking (y/n)">
<CaseAttributeValue Source="4">
<DBRefValue Name="No" Id="0"/>
</CaseAttributeValue>
</CaseAttribute>
<CaseAttribute TypeId="281" TypeIdName="circulatory system disorders (y/n)">
<CaseAttributeValue Source="4">
<DBRefValue Name="No" Id="0"/>
</CaseAttributeValue>
</CaseAttribute>
<CaseAttribute TypeId="738" TypeIdName="recreational drugs (y/n)">
<CaseAttributeValue Source="4">
<DBRefValue Name="No" Id="0"/>
</CaseAttributeValue>
</CaseAttribute>
<CaseAttribute TypeId="226" TypeIdName="cough for 3 weeks (y/n)">
<CaseAttributeValue Source="4">
<DBRefValue Name="No" Id="0"/>
</CaseAttributeValue>
</CaseAttribute>
<CaseAttribute TypeId="204" TypeIdName="fam history colon cancer, polyposis (y/n)">
<CaseAttributeValue Source="4">
<DBRefValue Name="No" Id="0"/>
</CaseAttributeValue>
</CaseAttribute>
<CaseAttribute TypeId="282" TypeIdName="diabetes, ... (y/n)">
<CaseAttributeValue Source="4">
<DBRefValue Name="No" Id="0"/>
</CaseAttributeValue>
</CaseAttribute>
<CaseAttribute TypeId="260" TypeIdName="eye disorder (y/n)">
<CaseAttributeValue Source="4">
<DBRefValue Name="No" Id="0"/>
</CaseAttributeValue>
</CaseAttribute>
<CaseAttribute TypeId="227" TypeIdName="unexplained bleeding, weight loss (y/n)">
<CaseAttributeValue Source="4">
<DBRefValue Name="No" Id="0"/>
</CaseAttributeValue>
</CaseAttribute>
<CaseAttribute TypeId="283" TypeIdName="respiratory system disorders (y/n)">
<CaseAttributeValue Source="4">
<DBRefValue Name="No" Id="0"/>
</CaseAttributeValue>
</CaseAttribute>
<CaseAttribute TypeId="83" TypeIdName="Hypertension, raised cholesterol, blood (y/n)">
<CaseAttributeValue Source="4">
<DBRefValue Name="No" Id="0"/>
</CaseAttributeValue>
</CaseAttribute>
<CaseAttribute TypeId="72" TypeIdName="occupational_hazards_x (y/n)">
<CaseAttributeValue Source="2" Time="2931">
<DBRefValue Name="No" Id="0"/>
</CaseAttributeValue>
</CaseAttribute>
<CaseAttribute TypeId="61" TypeIdName="nationality">
<CaseAttributeValue>
<DBRefValue Name="UK" Key="GB-0" Locale="en"/>
</CaseAttributeValue>
</CaseAttribute>
<CaseAttribute TypeId="228" TypeIdName="planned doctor appointment in next 3 weeks (y/n)">
<CaseAttributeValue Source="4">
<DBRefValue Name="No" Id="0"/>
</CaseAttributeValue>
</CaseAttribute>
<CaseAttribute TypeId="206" TypeIdName="hospital or investigations (y/n)">
<CaseAttributeValue Source="4">
<DBRefValue Name="No" Id="0"/>
</CaseAttributeValue>
</CaseAttribute>
<CaseAttribute TypeId="184" TypeIdName="fam history hereditary disease (y/n)">
<CaseAttributeValue Source="4">
<DBRefValue Name="No" Id="0"/>
</CaseAttributeValue>
</CaseAttribute>
<CaseAttribute TypeId="73" TypeIdName="sex">
<CaseAttributeValue>
<DBRefValue Name="Male" Id="2"/>
</CaseAttributeValue>
</CaseAttribute>
<CaseAttribute TypeId="229" TypeIdName="current treatment (y/n)">
<CaseAttributeValue Source="4" Time="10413">
<DBRefValue Name="No" Id="0"/>
</CaseAttributeValue>
</CaseAttribute>
<CaseAttribute TypeId="307" TypeIdName="id_no (person)">
<CaseAttributeValue>
<StringValue Value="1"/>
</CaseAttributeValue>
</CaseAttribute>
<CaseAttribute TypeId="285" TypeIdName="gastrointestinal tract disorders (y/n)">
<CaseAttributeValue Source="4">
<DBRefValue Name="No" Id="0"/>
</CaseAttributeValue>
</CaseAttribute>
<CaseAttribute TypeId="185" TypeIdName="fam history polycystic kidney disease (y/n)">
<CaseAttributeValue Source="4">
<DBRefValue Name="No" Id="0"/>
</CaseAttributeValue>
</CaseAttribute>
<CaseAttribute TypeId="230" TypeIdName="gynaecological disorders (y/n)">
<CaseAttributeValue Source="4">
<DBRefValue Name="No" Id="0"/>
</CaseAttributeValue>
</CaseAttribute>
<CaseAttribute TypeId="208" TypeIdName="fam history breast, ovarian cancer (y/n)">
<CaseAttributeValue Source="4">
<DBRefValue Name="No" Id="0"/>
</CaseAttributeValue>
</CaseAttribute>
<CaseAttribute TypeId="186" TypeIdName="fam history Huntington (y/n)">
<CaseAttributeValue Source="4">
<DBRefValue Name="No" Id="0"/>
</CaseAttributeValue>
</CaseAttribute>
<CaseAttribute TypeId="253" TypeIdName="gout or arthritis,... (y/n)">
<CaseAttributeValue Source="4">
<DBRefValue Name="No" Id="0"/>
</CaseAttributeValue>
</CaseAttribute>
<CaseAttribute TypeId="231" TypeIdName="smoking_x (y/n)">
<CaseAttributeValue Source="4" Time="2951">
<DBRefValue Name="Yes" Id="1"/>
</CaseAttributeValue>
</CaseAttribute>
<CaseAttribute TypeId="287" TypeIdName="nervous or neurological disorders (y/n)">
<CaseAttributeValue Source="4">
<DBRefValue Name="No" Id="0"/>
</CaseAttributeValue>
</CaseAttribute>
<CaseAttribute TypeId="187" TypeIdName="fam history Alzheimer (y/n)">
<CaseAttributeValue Source="4">
<DBRefValue Name="No" Id="0"/>
</CaseAttributeValue>
</CaseAttribute>
<CaseAttribute TypeId="265" TypeIdName="stroke, TIA,... (y/n)">
<CaseAttributeValue Source="4">
<DBRefValue Name="No" Id="0"/>
</CaseAttributeValue>
</CaseAttribute>
<CaseAttribute TypeId="176" TypeIdName="residence (country)">
<CaseAttributeValue>
<DBRefValue Name="UK" Key="GB-0" Locale="en"/>
</CaseAttributeValue>
</CaseAttribute>
<CaseAttribute TypeId="254" TypeIdName="gall, liver or pancreas disorder (y/n)">
<CaseAttributeValue Source="4">
<DBRefValue Name="No" Id="0"/>
</CaseAttributeValue>
</CaseAttribute>
<CaseAttribute TypeId="744" TypeIdName="preferred_life (y/n)">
<CaseAttributeValue>
<DBRefValue Name="No" Id="0"/>
</CaseAttributeValue>
</CaseAttribute>
<CaseAttribute TypeId="210" TypeIdName="fam history heart, diabetes (y/n)">
<CaseAttributeValue Source="4">
<DBRefValue Name="No" Id="0"/>
</CaseAttributeValue>
</CaseAttribute>
<CaseAttribute TypeId="288" TypeIdName="post_code">
<CaseAttributeValue>
<StringValue Value="33333"/>
</CaseAttributeValue>
</CaseAttribute>
<CaseAttribute TypeId="199" TypeIdName="fam history motor neurone disease (y/n)">
<CaseAttributeValue Source="4">
<DBRefValue Name="No" Id="0"/>
</CaseAttributeValue>
</CaseAttribute>
<CaseAttribute TypeId="21" TypeIdName="age at application">
<CaseAttributeValue>
<SingleValue UnitName="Year(s)" Value="33.0" Unit="16"/>
</CaseAttributeValue>
</CaseAttribute>
<CaseAttribute TypeId="155" TypeIdName="tested positive for HIV or hepatitis (y/n)">
<CaseAttributeValue Source="4">
<DBRefValue Name="No" Id="0"/>
</CaseAttributeValue>
</CaseAttribute>
<CaseAttribute TypeId="322" TypeIdName="drinking_x (y/n)">
<CaseAttributeValue Source="4" Time="1533">
<DBRefValue Name="No" Id="0"/>
</CaseAttributeValue>
</CaseAttribute>
<CaseAttribute TypeId="233" TypeIdName="thyroid disorders (y/n)">
<CaseAttributeValue Source="4">
<DBRefValue Name="No" Id="0"/>
</CaseAttributeValue>
</CaseAttribute>
<CaseAttribute TypeId="311" TypeIdName="pursuit_x (y/n)">
<CaseAttributeValue Source="2" Time="1710">
<DBRefValue Name="No" Id="0"/>
</CaseAttributeValue>
</CaseAttribute>
<CaseAttribute TypeId="44" TypeIdName="name">
<CaseAttributeValue>
<StringValue Value="MEier"/>
</CaseAttributeValue>
</CaseAttribute>
<CaseAttribute TypeId="211" TypeIdName="sexually transmitted disease (y/n)">
<CaseAttributeValue Source="4">
<DBRefValue Name="No" Id="0"/>
</CaseAttributeValue>
</CaseAttribute>
<CaseAttribute TypeId="200" TypeIdName="fam history Parkinson (y/n)">
<CaseAttributeValue Source="4">
<DBRefValue Name="No" Id="0"/>
</CaseAttributeValue>
</CaseAttribute>
<CaseAttribute TypeId="278" TypeIdName="mole or freckle (y/n)">
<CaseAttributeValue Source="4">
<DBRefValue Name="No" Id="0"/>
</CaseAttributeValue>
</CaseAttribute>
<CaseAttribute TypeId="267" TypeIdName="foreign_travel_x (y/n)">
<CaseAttributeValue Source="2">
<DBRefValue Name="No" Id="0"/>
</CaseAttributeValue>
</CaseAttribute>
</CaseObject>
<Benefit Id="6" TypeId="0" TypeIdName="Benefit">
<CaseAttribute TypeId="271" TypeIdName="life basic_form">
<CaseAttributeValue>
<DBRefValue Name="Endowment" Id="3"/>
</CaseAttributeValue>
</CaseAttribute>
<CaseAttribute TypeId="94" TypeIdName="smoker Type">
<CaseAttributeValue>
<DBRefValue Name="General Benefit" Id="2"/>
</CaseAttributeValue>
</CaseAttribute>
<CaseAttribute TypeId="108" TypeIdName="name (benefit)">
<CaseAttributeValue>
<StringValue Value="IP"/>
</CaseAttributeValue>
</CaseAttribute>
<CaseAttribute TypeId="355" TypeIdName="life policy-type">
<CaseAttributeValue>
<DBRefValue Name="Single Life" Id="3"/>
</CaseAttributeValue>
</CaseAttribute>
<CaseAttribute TypeId="11" TypeIdName="benefit-type">
<CaseAttributeValue>
<DBRefValue Name="IP own" Id="10"/>
</CaseAttributeValue>
</CaseAttribute>
</Benefit>
<EventPayment Id="7" TypeId="1" TypeIdName="Insurance event payment">
<CaseAttribute TypeId="292" TypeIdName="age_for_assessment">
<CaseAttributeValue>
<SingleValue UnitName="Year(s)" Value="33.0" Unit="16"/>
</CaseAttributeValue>
</CaseAttribute>
<CaseAttribute TypeId="103" TypeIdName="annuity_sum (sum insured)">
<CaseAttributeValue>
<SingleValue UnitName="£" Value="0.0" Unit="14"/>
</CaseAttributeValue>
</CaseAttribute>
<CaseAttribute TypeId="259" TypeIdName="bonus_level">
<CaseAttributeValue>
<SingleValue UnitName="%" Value="0.0" Unit="12"/>
</CaseAttributeValue>
</CaseAttribute>
<CaseAttribute TypeId="37" TypeIdName="age at entry (examination limits)">
<CaseAttributeValue>
<SingleValue UnitName="Year(s)" Value="33.0" Unit="16"/>
</CaseAttributeValue>
</CaseAttribute>
<CaseAttribute TypeId="750" TypeIdName="special_event_benefit (y/n)">
<CaseAttributeValue>
<DBRefValue Name="No" Id="0"/>
</CaseAttributeValue>
</CaseAttribute>
<CaseAttribute TypeId="316" TypeIdName="waiting_period">
<CaseAttributeValue>
<SingleValue UnitName="Weeks" Value="14.0" Unit="8"/>
</CaseAttributeValue>
</CaseAttribute>
<CaseAttribute TypeId="105" TypeIdName="benefit_payment_period">
<CaseAttributeValue>
<SingleValue UnitName="Year(s)" Value="20.0" Unit="16"/>
</CaseAttributeValue>
</CaseAttribute>
<CaseAttribute TypeId="161" TypeIdName="Eventtype">
<CaseAttributeValue>
<DBRefValue Name="Disability own/similar" Id="0"/>
</CaseAttributeValue>
</CaseAttribute>
<CaseAttribute TypeId="751" TypeIdName="borrowing">
<CaseAttributeValue/>
</CaseAttribute>
<CaseAttribute TypeId="262" TypeIdName="conversion_right (y/n)">
<CaseAttributeValue>
<DBRefValue Name="No" Id="0"/>
</CaseAttributeValue>
</CaseAttribute>
<CaseAttribute TypeId="777" TypeIdName="premium class">
<CaseAttributeValue/>
</CaseAttribute>
<CaseAttribute TypeId="121" TypeIdName="insurance_period">
<CaseAttributeValue>
<SingleValue UnitName="Year(s)" Value="20.0" Unit="16"/>
</CaseAttributeValue>
</CaseAttribute>
<CaseAttribute TypeId="333" TypeIdName="examination_group">
<CaseAttributeValue>
<DBRefValue Name="IP o/s" Id="3"/>
</CaseAttributeValue>
</CaseAttribute>
<CaseAttribute TypeId="222" TypeIdName="benefit sum">
<CaseAttributeValue>
<SingleValue UnitName="£/Month" Value="1200.0" Unit="3"/>
</CaseAttributeValue>
</CaseAttribute>
</EventPayment>
<Payment Id="8" TypeId="0" TypeIdName="Payment of Contribution">
<CaseAttribute TypeId="12" TypeIdName="included_loading percent">
<CaseAttributeValue>
<SingleValue UnitName="%" Value="0.0" Unit="12"/>
</CaseAttributeValue>
</CaseAttribute>
<CaseAttribute TypeId="15" TypeIdName="single_premium">
<CaseAttributeValue>
<SingleValue UnitName="£" Value="0.0" Unit="14"/>
</CaseAttributeValue>
</CaseAttribute>
<CaseAttribute TypeId="41" TypeIdName="premium_payment_period">
<CaseAttributeValue>
<SingleValue UnitName="Year(s)" Value="20.0" Unit="16"/>
</CaseAttributeValue>
</CaseAttribute>
<CaseAttribute TypeId="354" TypeIdName="annual_premium">
<CaseAttributeValue>
<SingleValue UnitName="£/Year" Value="111.0" Unit="1"/>
</CaseAttributeValue>
</CaseAttribute>
<CaseAttribute TypeId="77" TypeIdName="included_loading per mille">
<CaseAttributeValue>
<SingleValue UnitName="%o" Value="0.0" Unit="9"/>
</CaseAttributeValue>
</CaseAttribute>
</Payment>
<CaseObjectRelation From="0" TypeIdName="Application has PH" To="5" TypeId="50"/>
<CaseObjectRelation From="3" TypeIdName="Application Person has occupation" To="9" TypeId="14"/>
<CaseObjectRelation From="3" TypeIdName="AP has smoking in the present" To="10" TypeId="69"/>
<CaseObjectRelation From="0" TypeIdName="Application has AP" To="3" TypeId="49"/>
<CaseObjectRelation From="0" TypeIdName="Application has Benefit" To="6" TypeId="43"/>
<CaseObjectRelation From="6" TypeIdName="Benefit has insurance event payment" To="7" TypeId="47"/>
<CaseObjectRelation From="7" TypeIdName="insurance event payment has Payment of contribution" To="8" TypeId="53"/>
<CaseObjectRelation From="7" TypeIdName="insurance event payment has AP" To="3" TypeId="20"/>
</Case>sample response
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/xml;charset=UTF-8
Content-Length: 222
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
<?xml version="1.0" encoding="UTF-8"?>
<operationResult returnCode="0">
<caseDestinationReference>
<databaseReference subId="Demo" id="TestCaseImport"/>
</caseDestinationReference>
</operationResult>GET /subIdList
Returns a list of all SubIds in the casedata database
| Path | Type | Description |
|---|---|---|
|
|
list of Sub Ids |
sample request
GET /subIdList HTTP/1.1
Host: localhost:8080sample response
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 37
{
"subIds" : [ "Demo", "TEST" ]
}GET /caseList
Returns a list of all caseIds in one subId in the casedata database
Note: returns and empty list if nothing is found or an invalid subId is used
| Parameter | Description |
|---|---|
|
the subId from which all cases are listed |
| Path | Type | Description |
|---|---|---|
|
|
list of CaseIds in the SubId |
sample request
GET /caseList?subId=Demo HTTP/1.1
Content-Type: application/json;charset=UTF-8
Host: localhost:8080sample response
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 121
{
"caseIds" : [ "FS", "FS-2", "JSONCase", "Klaus", "New", "Test-Import", "TestCase", "TestCaseImport", "TestDemo" ]
}POST /createCaseInDB
creates a case in the casedata database with the given caseId and subId.
Note: Errors are noted in the errorDescriptions of the result JSON-Map
Please refer to CreateCaseInDB Interface Documentation for more information and use cases for this REST endpoint.
| Parameter | Description |
|---|---|
caseId |
Id of the case to be created - corresponds to the column rex_CaseId in the c40_casedata table |
subId |
ID of the Subsystem in which the case will be persisted in the database - corresponds to the column rex_SubID in the c40_casedata table |
loggingArea |
Logging-Area of the COMPASS Kernel |
| Type | Description |
|---|---|
CaseDto |
A JSON formatted description of the case. For more details see CreateCaseInDB Interface Documentation |
| Path | Type | Description |
|---|---|---|
responseEntity |
ResponseEntity |
the HTTP Response for this operation; a generic format used by many COMPASS REST services. For more details see CreateCaseInDB Interface Documentation |
Sample request
POST /createCaseInDB?caseId=JSONCase&subId=Demo&loggingArea=loggingArea HTTP/1.1
Content-Type: application/json;charset=UTF-8
Content-Length: 1493
Host: localhost:8080
{
"cspSetId" : 1,
"pos" : true,
"caseId" : "JSONCase",
"locale" : "en",
"complete" : false,
"techSource" : {
"sourceTypeId" : 100,
"complete" : true
},
"application" : {
"attributes" : null,
"ownPortfolioAvailable" : false,
"persons" : [ {
"attributes" : null,
"id" : "123",
"name" : "Klaus Mustermann",
"ap" : true,
"ph" : false,
"age" : 50,
"gender" : 2,
"maritalStatus" : 2,
"residenceCountry" : "D",
"nationality" : "D",
"occupation" : null,
"existingCoversInPortfolio" : null,
"requestedBenefits" : [ {
"attributes" : null,
"benefitType" : 0,
"smokerType" : 2,
"benefitName" : "1",
"singleLife" : false,
"lifeBasicForm" : 3,
"premiumPaymentYears" : 10,
"premiumPaymentAnnual" : 5000,
"singlePremium" : 1500,
"insurancePeriodYears" : 10,
"limitGroup" : 1001,
"sumInsured" : 10000,
"benefitSum" : null,
"disabilityPaymentYears" : 10,
"disabilityWaitingPeriodWeeks" : 4
} ],
"disorders" : null,
"pursuits" : [ {
"attributes" : {
"153" : {
"id" : -1,
"value" : "20000",
"unit" : -1
}
},
"name" : null,
"locale" : null,
"key" : "0250",
"deletable" : true
} ]
} ]
}
}Sample response
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 364
{
"path" : "/createCaseInDB",
"status" : 3,
"statusText" : "FATAL ERROR",
"errorDescriptions" : [ {
"errorCode" : 547,
"errorMessage" : "InvalidArgumentException: The attribute with typeId: 153 is incompatible for the pursuit. Please check your input data."
} ],
"jsonContent" : null,
"byteContent" : null,
"textContent" : null
}Screenbuilder API
The Screenbuilder API is used by the client to render it’s its own screens. The structure and sequence of the screens is given by COMPASS.
A typical screenbuilder loop would look like this
-
createAndCaptueorcapture(if the case is prefilled with technical data) -
show first screen by the user
-
userAction(return an answer to a question) -
show screen to user
-
go to 3, until all screens are consistent
-
checkCompleteness
The following two documents explains the result of the calls in the screenbuilder interface
POST /createAndCapture
This command is used, when a case (this means an Input Interface) shall be created, and all information for one SourceType (see Input Interface document for more details about a SourceType) shall be captured. When the case does already exist, and should only be modified, use the command capture
Note: Errors are noted in the errorDescriptions of the result JSON-Map
| Path | Type | Description |
|---|---|---|
|
|
This value will set the language when capturing the information. |
|
|
References the relevant SourceType by its numerical ID. Only screens of this SourceType will be shown during the capture process. The SourceType has to be a “creating” SourceType. |
|
|
The id of the used case |
|
|
The subsystem id of the used case |
|
|
pos, headoffice or form |
|
|
references a set of company specific parameters (CSP) by its numerical ID. The set of CSPs for a case cannot be modified later. |
|
|
the logging Area |
| Path | Type | Description |
|---|---|---|
|
|
API call path |
|
|
If call is completed successfully, then status is set to 0, otherwise it is set to 'WARNING'(=1) or 'OPERATION FAILED'(=2) or 'FATAL ERROR'(=3) |
|
|
Tf call is completed successfully, then status is set to 'OK', otherwise it is set to 'WARNING' or 'OPERATION FAILED' or 'FATAL ERROR' |
|
|
List of errorDescriptions in a JSON response |
|
|
the first screen to present. JSON-Map of the XML description in the screenbuilder SB1/SB2 documentation |
|
|
Empty on this call |
|
|
Empty on this call |
sample request
POST /createAndCapture HTTP/1.1
Content-Type: application/json;charset=UTF-8
Content-Length: 161
Host: localhost:8080
{
"language" : "en",
"caseMode" : "pos",
"sourceType" : 100,
"caseId" : "TestCaseCopy3",
"subId" : "Demo",
"csp" : 1,
"loggingArea" : "0"
}sample response (This is a SB1 screen, because a createAndCapture starts with technical screens technical screens are in SB1 only.)
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 30772
{
"path" : "/createAndCapture",
"status" : 0,
"statusText" : "OK",
"errorDescriptions" : [ ],
"jsonContent" : {
"screen" : {
"navigation" : {
"item" : [ {
"item" : [ {
"default" : true,
"appearance" : {
"border" : false,
"errorToolTip" : "",
"toolTip" : "",
"disabled" : false,
"foregroundColor" : 0,
"alignment" : "west",
"fillStrategy" : "none"
},
"name" : "OK",
"id" : "_6",
"commandid" : 2
}, {
"appearance" : {
"border" : false,
"errorToolTip" : "",
"toolTip" : "",
"disabled" : false,
"foregroundColor" : 0,
"alignment" : "west",
"fillStrategy" : "none"
},
"name" : "Cancel",
"id" : "_8",
"commandid" : 8
}, {
"appearance" : {
"border" : false,
"errorToolTip" : "",
"toolTip" : "",
"disabled" : false,
"foregroundColor" : 0,
"alignment" : "west",
"fillStrategy" : "none"
},
"name" : "Save",
"id" : "_10",
"commandid" : 6
}, {
"appearance" : {
"border" : false,
"errorToolTip" : "",
"toolTip" : "",
"disabled" : false,
"foregroundColor" : 0,
"alignment" : "northwest",
"fillStrategy" : "none"
},
"name" : "Turbo",
"id" : "_12",
"commandid" : 4
} ],
"name" : "File",
"id" : "File"
}, {
"item" : [ {
"shown" : true,
"caseObj" : "25_0",
"name" : "Application",
"consistent" : true,
"id" : "_103",
"fixedID" : 260
}, {
"item" : [ {
"shown" : false,
"name" : "AP",
"id" : "_104",
"fixedID" : 264
}, {
"name" : "AP",
"id" : "_x_104",
"isSeparator" : true
}, {
"shown" : false,
"caseObj" : "27_3",
"name" : "Details AP unknown",
"consistent" : false,
"id" : "_105",
"fixedID" : 265
}, {
"shown" : false,
"caseObj" : "27_3",
"name" : "Own pre-existing Insurance/ Association Registry",
"consistent" : true,
"id" : "_106",
"fixedID" : 266
} ],
"shown" : false,
"caseObj" : "25_0",
"name" : "AP",
"consistent" : true,
"id" : "_104",
"fixedID" : 264
}, {
"shown" : false,
"caseObj" : "25_0",
"name" : "Documents in Portfolio",
"consistent" : true,
"id" : "_107",
"fixedID" : 259
}, {
"item" : [ {
"shown" : false,
"name" : "Specify the applied Benefits",
"id" : "_108",
"fixedID" : 268
}, {
"name" : "Specify the applied Benefits",
"id" : "_x_108",
"isSeparator" : true
}, {
"item" : [ {
"shown" : false,
"name" : "Basic Data for Benefit",
"id" : "_109",
"fixedID" : 255
}, {
"name" : "Basic Data for Benefit",
"id" : "_x_109",
"isSeparator" : true
}, {
"item" : [ {
"shown" : false,
"name" : "Details Event Payment Life",
"id" : "_110",
"fixedID" : 257
}, {
"name" : "Details Event Payment Life",
"id" : "_x_110",
"isSeparator" : true
}, {
"shown" : false,
"caseObj" : "0_1;1_2;0_4",
"name" : "Contribution/Payment Life - unknown",
"consistent" : false,
"id" : "_111",
"fixedID" : 258
} ],
"shown" : false,
"caseObj" : "0_1;1_2",
"name" : "Details Event Payment Life",
"consistent" : false,
"id" : "_110",
"fixedID" : 257
} ],
"shown" : false,
"caseObj" : "0_1",
"name" : "Basic Data for Benefit",
"consistent" : false,
"id" : "_109",
"fixedID" : 255
} ],
"shown" : false,
"caseObj" : "25_0",
"name" : "Specify the applied Benefits",
"consistent" : true,
"id" : "_108",
"fixedID" : 268
} ],
"name" : "Navigation",
"id" : "Navigation"
}, {
"item" : [ {
"name" : "German",
"id" : "_100"
}, {
"name" : "French",
"id" : "_101"
}, {
"default" : true,
"name" : "English",
"id" : "_102"
} ],
"name" : "Language",
"id" : "Language"
} ],
"renderingHint" : "menuBar",
"name" : "NavigationBar",
"id" : "NavigationBar"
},
"resizable" : true,
"helpID" : "file://help/usersGuide/recordingData/HTML/en/applicationscreen.htm",
"buttonRow" : {
"button" : [ {
"default" : true,
"appearance" : {
"border" : false,
"errorToolTip" : "",
"toolTip" : "",
"disabled" : false,
"foregroundColor" : 0,
"alignment" : "west",
"fillStrategy" : "none"
},
"name" : "OK",
"id" : "_0",
"position" : {
"relYPosition" : 1,
"relXPosition" : 4
},
"commandid" : 2
}, {
"appearance" : {
"border" : false,
"errorToolTip" : "",
"toolTip" : "",
"disabled" : false,
"foregroundColor" : 0,
"alignment" : "west",
"fillStrategy" : "none"
},
"name" : "Cancel",
"id" : "_1",
"position" : {
"relYPosition" : 1,
"relXPosition" : 3
},
"commandid" : 8
}, {
"appearance" : {
"border" : false,
"errorToolTip" : "",
"toolTip" : "",
"disabled" : false,
"foregroundColor" : 0,
"alignment" : "west",
"fillStrategy" : "none"
},
"name" : "Save",
"id" : "_2",
"position" : {
"relYPosition" : 1,
"relXPosition" : 1
},
"commandid" : 6
}, {
"appearance" : {
"border" : false,
"errorToolTip" : "",
"toolTip" : "",
"disabled" : false,
"foregroundColor" : 0,
"alignment" : "northwest",
"fillStrategy" : "none"
},
"name" : "Turbo",
"id" : "_3",
"position" : {
"relYPosition" : 1,
"relXPosition" : 5
},
"commandid" : 4
} ],
"name" : "buttonRow",
"id" : "buttonRow"
},
"id" : "_103",
"title" : "Application",
"fixedID" : 260,
"group" : {
"layout" : {
"appearance" : {
"border" : false,
"fontstyle" : "bold",
"errorToolTip" : "",
"toolTip" : "",
"fontsize" : 12,
"disabled" : false,
"foregroundColor" : 0,
"alignment" : "northwest",
"font" : "Arial Unicode MS",
"fillStrategy" : "both"
},
"position" : {
"relYPosition" : 1,
"relXPosition" : 1
},
"dimension" : {
"width" : 18,
"height" : 72
}
},
"name" : "Application",
"id" : 3092,
"type" : "group",
"group" : [ {
"layout" : {
"appearance" : {
"border" : true,
"errorToolTip" : "",
"toolTip" : "",
"disabled" : false,
"foregroundColor" : 0,
"alignment" : "northwest",
"fillStrategy" : "horizontal"
},
"position" : {
"relYPosition" : 2,
"relXPosition" : 1
}
},
"question" : [ {
"layout" : {
"appearance" : {
"border" : false,
"backgroundColor" : 16777215,
"errorToolTip" : "",
"toolTip" : "",
"disabled" : false,
"foregroundColor" : 0,
"alignment" : "west",
"fillStrategy" : "none"
},
"position" : {
"relYPosition" : 1,
"relXPosition" : 2
}
},
"catyID" : 38,
"selection" : {
"noColumns" : 0,
"noRows" : 1,
"appearance" : {
"border" : false,
"backgroundColor" : 16777215,
"errorToolTip" : "",
"toolTip" : "",
"disabled" : false,
"foregroundColor" : 0,
"alignment" : "west",
"fillStrategy" : "none"
},
"editable" : true,
"name" : "own_prev_assess_present (y/n)",
"renderingHint" : "RadioButton",
"id" : 38,
"position" : {
"relYPosition" : 1,
"relXPosition" : 2
},
"error" : false,
"mandatory" : true,
"value" : [ {
"id" : 0,
"value" : "No"
}, {
"id" : 1,
"value" : "Yes",
"selected" : true
} ]
},
"name" : "own_prev_assess_present (y/n)",
"id" : "_0",
"fixedID" : "0_38",
"cotyID" : 25
}, {
"layout" : {
"appearance" : {
"border" : false,
"backgroundColor" : 16777215,
"errorToolTip" : "",
"toolTip" : "",
"disabled" : false,
"foregroundColor" : 0,
"alignment" : "west",
"fillStrategy" : "none"
},
"position" : {
"relYPosition" : 2,
"relXPosition" : 2
}
},
"catyID" : 250,
"selection" : {
"noColumns" : 0,
"noRows" : 1,
"appearance" : {
"border" : false,
"backgroundColor" : 16777215,
"errorToolTip" : "",
"toolTip" : "",
"disabled" : false,
"foregroundColor" : 0,
"alignment" : "west",
"fillStrategy" : "none"
},
"editable" : true,
"name" : "association registry existing (y/n)",
"renderingHint" : "RadioButton",
"id" : 250,
"position" : {
"relYPosition" : 2,
"relXPosition" : 2
},
"error" : false,
"mandatory" : true,
"value" : [ {
"id" : 0,
"value" : "No"
}, {
"id" : 1,
"value" : "Yes",
"selected" : true
} ]
},
"name" : "association registry existing (y/n)",
"id" : "_1",
"fixedID" : "0_250",
"cotyID" : 25
} ],
"name" : "Control data application",
"id" : 3135,
"text" : [ {
"appearance" : {
"border" : false,
"backgroundColor" : 16777215,
"errorToolTip" : "",
"toolTip" : "",
"disabled" : false,
"foregroundColor" : 128,
"alignment" : "west",
"fillStrategy" : "none"
},
"relFixedID" : "0_38",
"id" : 2440,
"text" : "Portfolio data available",
"position" : {
"relYPosition" : 1,
"relXPosition" : 1
},
"error" : false,
"optimizeWidth" : true
}, {
"appearance" : {
"border" : false,
"backgroundColor" : 16777215,
"errorToolTip" : "",
"toolTip" : "",
"disabled" : false,
"foregroundColor" : 128,
"alignment" : "west",
"fillStrategy" : "none"
},
"relFixedID" : "0_250",
"id" : 2441,
"text" : "Association Registry available",
"position" : {
"relYPosition" : 2,
"relXPosition" : 1
},
"error" : false,
"optimizeWidth" : true
} ],
"type" : "group"
}, {
"layout" : {
"appearance" : {
"border" : false,
"errorToolTip" : "",
"toolTip" : "",
"disabled" : false,
"foregroundColor" : 0,
"alignment" : "northwest",
"fillStrategy" : "both"
},
"position" : {
"relYPosition" : 4,
"relXPosition" : 1
}
},
"name" : "Fourth group",
"id" : 3098,
"type" : "group",
"group" : {
"layout" : {
"appearance" : {
"border" : true,
"errorToolTip" : "",
"toolTip" : "",
"disabled" : false,
"foregroundColor" : 0,
"alignment" : "west",
"fillStrategy" : "both"
},
"position" : {
"relYPosition" : 1,
"relXPosition" : 1
},
"dimension" : {
"width" : 2,
"height" : 2
}
},
"name" : "Policy Holder",
"id" : 246,
"type" : "relation",
"group" : [ {
"layout" : {
"appearance" : {
"border" : false,
"errorToolTip" : "",
"toolTip" : "",
"disabled" : false,
"foregroundColor" : 0,
"alignment" : "west",
"fillStrategy" : "both"
},
"position" : {
"relYPosition" : 2,
"relXPosition" : 1
}
},
"question" : {
"layout" : {
"appearance" : {
"border" : false,
"backgroundColor" : 16777215,
"errorToolTip" : "",
"toolTip" : "",
"disabled" : false,
"foregroundColor" : 0,
"alignment" : "west",
"fillStrategy" : "horizontal"
},
"position" : {
"relYPosition" : 1,
"relXPosition" : 1
}
},
"catyID" : 307,
"selection" : {
"noColumns" : 3,
"noRows" : 5,
"appearance" : {
"border" : false,
"backgroundColor" : 16777215,
"errorToolTip" : "",
"toolTip" : "",
"disabled" : false,
"foregroundColor" : 0,
"alignment" : "west",
"fillStrategy" : "horizontal"
},
"editable" : true,
"multiple" : false,
"renderingHint" : "List",
"collected" : true,
"id" : "_246",
"position" : {
"relYPosition" : 1,
"relXPosition" : 1
},
"value" : {
"id" : "PH UNKNOWN_5",
"value" : "PH UNKNOWN"
}
},
"id" : "_2",
"fixedID" : "0_246",
"cotyID" : 28
},
"name" : "List policy holders",
"id" : 3114,
"type" : "list"
}, {
"layout" : {
"appearance" : {
"border" : false,
"errorToolTip" : "",
"toolTip" : "",
"disabled" : false,
"foregroundColor" : 0,
"alignment" : "west",
"fillStrategy" : "none"
},
"position" : {
"relYPosition" : 2,
"relXPosition" : 2
}
},
"button" : {
"appearance" : {
"border" : false,
"errorToolTip" : "",
"toolTip" : "",
"disabled" : false,
"foregroundColor" : 0,
"alignment" : "west",
"fillStrategy" : "horizontal"
},
"name" : "New",
"id" : "_4",
"position" : {
"relYPosition" : 1,
"relXPosition" : 1
},
"commandid" : 101
},
"name" : "Relation Buttons",
"id" : "246_3118",
"type" : "relButtons"
}, {
"layout" : {
"appearance" : {
"border" : false,
"errorToolTip" : "",
"toolTip" : "",
"disabled" : false,
"foregroundColor" : 0,
"alignment" : "west",
"fillStrategy" : "horizontal"
},
"position" : {
"relYPosition" : 1,
"relXPosition" : 1
}
},
"question" : {
"layout" : {
"appearance" : {
"border" : true,
"backgroundColor" : 16777215,
"errorToolTip" : "",
"toolTip" : "",
"disabled" : false,
"foregroundColor" : 0,
"alignment" : "west",
"fillStrategy" : "horizontal"
},
"position" : {
"relYPosition" : 1,
"relXPosition" : 2
}
},
"catyID" : 307,
"selection" : {
"noRows" : 10,
"appearance" : {
"border" : true,
"backgroundColor" : 16777215,
"errorToolTip" : "",
"toolTip" : "",
"disabled" : false,
"foregroundColor" : 0,
"alignment" : "west",
"fillStrategy" : "horizontal"
},
"editable" : true,
"renderingHint" : "EditableComboBox",
"id" : 291,
"position" : {
"relYPosition" : 1,
"relXPosition" : 2
},
"error" : false,
"mandatory" : true,
"value" : [ {
"id" : "PH UNKNOWN",
"value" : "PH UNKNOWN"
}, {
"id" : "",
"value" : "",
"selected" : true
} ]
},
"name" : "id_no (person)",
"id" : "_3",
"fixedID" : "0_246_307",
"cotyID" : 28
},
"name" : "Question Policy-holder",
"id" : 3152,
"text" : {
"appearance" : {
"border" : false,
"backgroundColor" : 16777215,
"errorToolTip" : "",
"toolTip" : "",
"disabled" : false,
"foregroundColor" : 128,
"alignment" : "west",
"fillStrategy" : "none"
},
"relFixedID" : "0_246_307",
"id" : 2424,
"text" : "Person-ID",
"position" : {
"relYPosition" : 1,
"relXPosition" : 1
},
"error" : false,
"optimizeWidth" : true
},
"type" : "input"
} ]
}
}, {
"layout" : {
"appearance" : {
"border" : true,
"errorToolTip" : "",
"toolTip" : "",
"disabled" : false,
"foregroundColor" : 0,
"alignment" : "northwest",
"fillStrategy" : "horizontal"
},
"position" : {
"relYPosition" : 1,
"relXPosition" : 1
}
},
"question" : {
"layout" : {
"appearance" : {
"border" : false,
"backgroundColor" : 16777215,
"errorToolTip" : "",
"toolTip" : "",
"disabled" : false,
"foregroundColor" : 0,
"alignment" : "west",
"fillStrategy" : "none"
},
"position" : {
"relYPosition" : 1,
"relXPosition" : 2
}
},
"textInput" : {
"appearance" : {
"border" : false,
"backgroundColor" : 16777215,
"errorToolTip" : "",
"toolTip" : "",
"disabled" : false,
"foregroundColor" : 0,
"alignment" : "west",
"fillStrategy" : "none"
},
"columns" : 15,
"editable" : true,
"minLength" : 0,
"id" : 0,
"position" : {
"relYPosition" : 1,
"relXPosition" : 2
},
"rows" : 1,
"error" : false,
"mandatory" : true,
"value" : {
"id" : 305,
"value" : "TestCaseCopy3"
},
"maxLength" : 20
},
"catyID" : 0,
"name" : "application-ID",
"id" : "_11",
"fixedID" : "0_0",
"cotyID" : 25
},
"name" : "Application data",
"id" : 3279,
"text" : {
"appearance" : {
"border" : false,
"backgroundColor" : 16777215,
"errorToolTip" : "",
"toolTip" : "",
"disabled" : false,
"foregroundColor" : 128,
"alignment" : "west",
"fillStrategy" : "none"
},
"relFixedID" : "0_0",
"id" : 2436,
"text" : "Application key",
"position" : {
"relYPosition" : 1,
"relXPosition" : 1
},
"error" : false,
"optimizeWidth" : true
},
"type" : "group"
}, {
"layout" : {
"appearance" : {
"border" : true,
"errorToolTip" : "",
"toolTip" : "",
"disabled" : false,
"foregroundColor" : 0,
"alignment" : "northwest",
"fillStrategy" : "horizontal"
},
"position" : {
"relYPosition" : 3,
"relXPosition" : 1
}
},
"question" : [ {
"layout" : {
"appearance" : {
"border" : false,
"backgroundColor" : 16777215,
"errorToolTip" : "",
"toolTip" : "",
"disabled" : false,
"foregroundColor" : 0,
"alignment" : "west",
"fillStrategy" : "none"
},
"position" : {
"relYPosition" : 1,
"relXPosition" : 2
}
},
"textInput" : {
"appearance" : {
"border" : false,
"backgroundColor" : 16777215,
"errorToolTip" : "",
"toolTip" : "",
"disabled" : false,
"foregroundColor" : 0,
"alignment" : "west",
"fillStrategy" : "none"
},
"columns" : 15,
"editable" : true,
"minLength" : 0,
"id" : 365,
"position" : {
"relYPosition" : 1,
"relXPosition" : 2
},
"rows" : 1,
"error" : false,
"mandatory" : false,
"value" : {
"id" : 306,
"value" : ""
},
"maxLength" : 60
},
"catyID" : 365,
"name" : "agent_name",
"id" : "_12",
"fixedID" : "0_365",
"cotyID" : 25
}, {
"layout" : {
"appearance" : {
"border" : false,
"backgroundColor" : 16777215,
"errorToolTip" : "",
"toolTip" : "",
"disabled" : false,
"foregroundColor" : 0,
"alignment" : "west",
"fillStrategy" : "none"
},
"position" : {
"relYPosition" : 2,
"relXPosition" : 2
}
},
"catyID" : 102,
"selection" : {
"noColumns" : 0,
"noRows" : 1,
"appearance" : {
"border" : false,
"backgroundColor" : 16777215,
"errorToolTip" : "",
"toolTip" : "",
"disabled" : false,
"foregroundColor" : 0,
"alignment" : "west",
"fillStrategy" : "none"
},
"editable" : true,
"name" : "agent_code",
"renderingHint" : "ComboBox",
"id" : 102,
"position" : {
"relYPosition" : 2,
"relXPosition" : 2
},
"error" : false,
"mandatory" : false,
"value" : [ {
"id" : 2,
"value" : "new agent, check"
}, {
"id" : 1,
"value" : "special commission agreement"
}, {
"id" : "unknown",
"value" : "unknown",
"selected" : true
} ]
},
"name" : "agent_code",
"id" : "_13",
"fixedID" : "0_102",
"cotyID" : 25
} ],
"name" : "Agent details",
"id" : 3280,
"text" : [ {
"appearance" : {
"border" : false,
"backgroundColor" : 16777215,
"errorToolTip" : "",
"toolTip" : "",
"disabled" : false,
"foregroundColor" : 128,
"alignment" : "west",
"fillStrategy" : "none"
},
"relFixedID" : "0_365",
"id" : 2437,
"text" : "Name",
"position" : {
"relYPosition" : 1,
"relXPosition" : 1
},
"error" : false,
"optimizeWidth" : true
}, {
"appearance" : {
"border" : false,
"backgroundColor" : 16777215,
"errorToolTip" : "",
"toolTip" : "",
"disabled" : false,
"foregroundColor" : 128,
"alignment" : "west",
"fillStrategy" : "none"
},
"relFixedID" : "0_102",
"id" : 2439,
"text" : "Code",
"position" : {
"relYPosition" : 2,
"relXPosition" : 1
},
"error" : false,
"optimizeWidth" : true
} ],
"type" : "group"
} ]
}
}
},
"byteContent" : null,
"textContent" : null
}POST /createAndCaptureXML
This command is used, when a case (this means an Input Interface) shall be created, and all information for one SourceType (see Input Interface document for more details about a SourceType) shall be captured. When the case does already exist, and should only be modified, use the command capturee (XML-Version)
Note: Errors are noted in an operationResult with errors in the XML-String
| Path | Type | Description |
|---|---|---|
|
|
the language of the capturing |
|
|
the used sourceType |
|
|
The id of the used case |
|
|
The subsystem id of the used case |
|
|
pos, headoffice or form |
|
|
the id of the csp set to use |
|
|
the loggingArea |
| Path | Type | Description |
|---|---|---|
|
|
The screen to be presented. It is in form of an XML string. |
sample request
POST /createAndCaptureXML HTTP/1.1
Content-Type: application/json;charset=UTF-8
Content-Length: 161
Host: localhost:8080
{
"language" : "en",
"caseMode" : "pos",
"sourceType" : 100,
"caseId" : "TestCaseCopy4",
"subId" : "Demo",
"csp" : 1,
"loggingArea" : "0"
}sample response (This is a SB1 screen, because a createAndCapture starts with technical screens technical screens are in SB1 only.)
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/xml;charset=UTF-8
Content-Length: 22762
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
<?xml version="1.0" encoding="UTF-8"?>
<screen resizable="true" id="_103" fixedID="260" helpID="file://help/usersGuide/recordingData/HTML/en/applicationscreen.htm" title="Application">
<navigation renderingHint="menuBar" id="NavigationBar" name="NavigationBar">
<item id="File" name="File">
<item id="_6" default="true" commandid="2" name="OK">
<appearance alignment="west" disabled="false" border="false" foregroundColor="0" toolTip="" errorToolTip="" fillStrategy="none"/>
</item>
<item id="_8" name="Cancel" commandid="8">
<appearance alignment="west" disabled="false" border="false" foregroundColor="0" toolTip="" errorToolTip="" fillStrategy="none"/>
</item>
<item id="_10" name="Save" commandid="6">
<appearance alignment="west" disabled="false" border="false" foregroundColor="0" toolTip="" errorToolTip="" fillStrategy="none"/>
</item>
<item id="_12" name="Turbo" commandid="4">
<appearance alignment="northwest" disabled="false" border="false" foregroundColor="0" toolTip="" errorToolTip="" fillStrategy="none"/>
</item>
</item>
<item id="Navigation" name="Navigation">
<item id="_103" fixedID="260" consistent="true" name="Application" caseObj="25_0" shown="true"/>
<item id="_104" fixedID="264" consistent="true" name="AP" caseObj="25_0" shown="false">
<item id="_104" fixedID="264" name="AP" shown="false"/>
<item isSeparator="true" id="_x_104" name="AP"/>
<item id="_105" fixedID="265" consistent="false" name="Details AP unknown" caseObj="27_3" shown="false"/>
<item id="_106" fixedID="266" consistent="true" name="Own pre-existing Insurance/ Association Registry" caseObj="27_3" shown="false"/>
</item>
<item id="_107" fixedID="259" consistent="true" name="Documents in Portfolio" caseObj="25_0" shown="false"/>
<item id="_108" fixedID="268" consistent="true" name="Specify the applied Benefits" caseObj="25_0" shown="false">
<item id="_108" fixedID="268" name="Specify the applied Benefits" shown="false"/>
<item isSeparator="true" id="_x_108" name="Specify the applied Benefits"/>
<item id="_109" fixedID="255" consistent="false" name="Basic Data for Benefit" caseObj="0_1" shown="false">
<item id="_109" fixedID="255" name="Basic Data for Benefit" shown="false"/>
<item isSeparator="true" id="_x_109" name="Basic Data for Benefit"/>
<item id="_110" fixedID="257" consistent="false" name="Details Event Payment Life" caseObj="0_1;1_2" shown="false">
<item id="_110" fixedID="257" name="Details Event Payment Life" shown="false"/>
<item isSeparator="true" id="_x_110" name="Details Event Payment Life"/>
<item id="_111" fixedID="258" consistent="false" name="Contribution/Payment Life - unknown" caseObj="0_1;1_2;0_4" shown="false"/>
</item>
</item>
</item>
</item>
<item id="Language" name="Language">
<item id="_100" name="German"/>
<item id="_101" name="French"/>
<item id="_102" name="English" default="true"/>
</item>
</navigation>
<buttonRow name="buttonRow" id="buttonRow">
<button id="_0" default="true" commandid="2" name="OK">
<position relYPosition="1" relXPosition="4"/>
<appearance alignment="west" disabled="false" border="false" foregroundColor="0" toolTip="" errorToolTip="" fillStrategy="none"/>
</button>
<button id="_1" name="Cancel" commandid="8">
<position relYPosition="1" relXPosition="3"/>
<appearance alignment="west" disabled="false" border="false" foregroundColor="0" toolTip="" errorToolTip="" fillStrategy="none"/>
</button>
<button id="_2" name="Save" commandid="6">
<position relYPosition="1" relXPosition="1"/>
<appearance alignment="west" disabled="false" border="false" foregroundColor="0" toolTip="" errorToolTip="" fillStrategy="none"/>
</button>
<button id="_3" name="Turbo" commandid="4">
<position relYPosition="1" relXPosition="5"/>
<appearance alignment="northwest" disabled="false" border="false" foregroundColor="0" toolTip="" errorToolTip="" fillStrategy="none"/>
</button>
</buttonRow>
<group name="Application" id="3092" type="group">
<layout>
<dimension height="72" width="18"/>
<position relYPosition="1" relXPosition="1"/>
<appearance disabled="false" alignment="northwest" border="false" fontsize="12" font="Arial UTF-8 MS" fontstyle="bold" foregroundColor="0" fillStrategy="both" errorToolTip="" toolTip=""/>
</layout>
<group name="Control data application" id="3135" type="group">
<layout>
<position relYPosition="2" relXPosition="1"/>
<appearance alignment="northwest" disabled="false" border="true" foregroundColor="0" toolTip="" errorToolTip="" fillStrategy="horizontal"/>
</layout>
<text id="2440" text="Portfolio data available" optimizeWidth="true" error="false" relFixedID="0_38">
<position relYPosition="1" relXPosition="1"/>
<appearance alignment="west" backgroundColor="16777215" disabled="false" border="false" foregroundColor="128" fillStrategy="none" toolTip="" errorToolTip=""/>
</text>
<question catyID="38" id="_0" fixedID="0_38" name="own_prev_assess_present (y/n)" cotyID="25">
<layout>
<position relYPosition="1" relXPosition="2"/>
<appearance alignment="west" backgroundColor="16777215" disabled="false" border="false" foregroundColor="0" fillStrategy="none" toolTip="" errorToolTip=""/>
</layout>
<selection mandatory="true" id="38" name="own_prev_assess_present (y/n)" error="false" noColumns="0" editable="true" noRows="1" renderingHint="RadioButton">
<position relYPosition="1" relXPosition="2"/>
<appearance alignment="west" backgroundColor="16777215" disabled="false" border="false" foregroundColor="0" fillStrategy="none" toolTip="" errorToolTip=""/>
<value id="0" value="No"/>
<value selected="true" id="1" value="Yes"/>
</selection>
</question>
<text id="2441" text="Association Registry available" optimizeWidth="true" error="false" relFixedID="0_250">
<position relYPosition="2" relXPosition="1"/>
<appearance alignment="west" backgroundColor="16777215" disabled="false" border="false" foregroundColor="128" fillStrategy="none" toolTip="" errorToolTip=""/>
</text>
<question catyID="250" id="_1" fixedID="0_250" name="association registry existing (y/n)" cotyID="25">
<layout>
<position relYPosition="2" relXPosition="2"/>
<appearance alignment="west" backgroundColor="16777215" disabled="false" border="false" foregroundColor="0" fillStrategy="none" toolTip="" errorToolTip=""/>
</layout>
<selection mandatory="true" id="250" name="association registry existing (y/n)" error="false" noColumns="0" editable="true" noRows="1" renderingHint="RadioButton">
<position relYPosition="2" relXPosition="2"/>
<appearance alignment="west" backgroundColor="16777215" disabled="false" border="false" foregroundColor="0" fillStrategy="none" toolTip="" errorToolTip=""/>
<value id="0" value="No"/>
<value selected="true" id="1" value="Yes"/>
</selection>
</question>
</group>
<group name="Fourth group" id="3098" type="group">
<layout>
<position relYPosition="4" relXPosition="1"/>
<appearance alignment="northwest" disabled="false" border="false" foregroundColor="0" toolTip="" errorToolTip="" fillStrategy="both"/>
</layout>
<group name="Policy Holder" id="246" type="relation">
<layout>
<dimension height="2" width="2"/>
<position relYPosition="1" relXPosition="1"/>
<appearance alignment="west" disabled="false" border="true" foregroundColor="0" toolTip="" errorToolTip="" fillStrategy="both"/>
</layout>
<group name="List policy holders" id="3114" type="list">
<layout>
<position relYPosition="2" relXPosition="1"/>
<appearance alignment="west" disabled="false" border="false" foregroundColor="0" toolTip="" errorToolTip="" fillStrategy="both"/>
</layout>
<question catyID="307" id="_2" fixedID="0_246" cotyID="28">
<layout>
<position relYPosition="1" relXPosition="1"/>
<appearance alignment="west" backgroundColor="16777215" disabled="false" border="false" foregroundColor="0" fillStrategy="horizontal" toolTip="" errorToolTip=""/>
</layout>
<selection collected="true" multiple="false" id="_246" noColumns="3" editable="true" noRows="5" renderingHint="List">
<position relYPosition="1" relXPosition="1"/>
<appearance alignment="west" backgroundColor="16777215" disabled="false" border="false" foregroundColor="0" fillStrategy="horizontal" toolTip="" errorToolTip=""/>
<value id="PH UNKNOWN_5" value="PH UNKNOWN"/>
</selection>
</question>
</group>
<group name="Relation Buttons" id="246_3118" type="relButtons">
<layout>
<position relYPosition="2" relXPosition="2"/>
<appearance alignment="west" disabled="false" border="false" foregroundColor="0" toolTip="" errorToolTip="" fillStrategy="none"/>
</layout>
<button id="_4" name="New" commandid="101">
<position relYPosition="1" relXPosition="1"/>
<appearance alignment="west" disabled="false" border="false" foregroundColor="0" toolTip="" errorToolTip="" fillStrategy="horizontal"/>
</button>
</group>
<group name="Question Policy-holder" id="3152" type="input">
<layout>
<position relYPosition="1" relXPosition="1"/>
<appearance alignment="west" disabled="false" border="false" foregroundColor="0" toolTip="" errorToolTip="" fillStrategy="horizontal"/>
</layout>
<text id="2424" text="Person-ID" optimizeWidth="true" error="false" relFixedID="0_246_307">
<position relYPosition="1" relXPosition="1"/>
<appearance alignment="west" backgroundColor="16777215" disabled="false" border="false" foregroundColor="128" fillStrategy="none" toolTip="" errorToolTip=""/>
</text>
<question catyID="307" id="_3" fixedID="0_246_307" name="id_no (person)" cotyID="28">
<layout>
<position relYPosition="1" relXPosition="2"/>
<appearance alignment="west" backgroundColor="16777215" disabled="false" border="true" foregroundColor="0" fillStrategy="horizontal" toolTip="" errorToolTip=""/>
</layout>
<selection mandatory="true" noRows="10" id="291" renderingHint="EditableComboBox" editable="true" error="false">
<position relYPosition="1" relXPosition="2"/>
<appearance alignment="west" backgroundColor="16777215" disabled="false" border="true" foregroundColor="0" fillStrategy="horizontal" toolTip="" errorToolTip=""/>
<value id="PH UNKNOWN" value="PH UNKNOWN"/>
<value selected="true" id="" value=""/>
</selection>
</question>
</group>
</group>
</group>
<group name="Application data" id="3279" type="group">
<layout>
<position relYPosition="1" relXPosition="1"/>
<appearance alignment="northwest" disabled="false" border="true" foregroundColor="0" toolTip="" errorToolTip="" fillStrategy="horizontal"/>
</layout>
<text id="2436" text="Application key" optimizeWidth="true" error="false" relFixedID="0_0">
<position relYPosition="1" relXPosition="1"/>
<appearance alignment="west" backgroundColor="16777215" disabled="false" border="false" foregroundColor="128" fillStrategy="none" toolTip="" errorToolTip=""/>
</text>
<question catyID="0" id="_11" fixedID="0_0" name="application-ID" cotyID="25">
<layout>
<position relYPosition="1" relXPosition="2"/>
<appearance alignment="west" backgroundColor="16777215" disabled="false" border="false" foregroundColor="0" fillStrategy="none" toolTip="" errorToolTip=""/>
</layout>
<textInput mandatory="true" columns="15" id="0" rows="1" error="false" editable="true" minLength="0" maxLength="20">
<position relYPosition="1" relXPosition="2"/>
<appearance alignment="west" backgroundColor="16777215" disabled="false" border="false" foregroundColor="0" fillStrategy="none" toolTip="" errorToolTip=""/>
<value id="305" value="TestCaseCopy4"/>
</textInput>
</question>
</group>
<group name="Agent details" id="3280" type="group">
<layout>
<position relYPosition="3" relXPosition="1"/>
<appearance alignment="northwest" disabled="false" border="true" foregroundColor="0" toolTip="" errorToolTip="" fillStrategy="horizontal"/>
</layout>
<text id="2437" text="Name" optimizeWidth="true" error="false" relFixedID="0_365">
<position relYPosition="1" relXPosition="1"/>
<appearance alignment="west" backgroundColor="16777215" disabled="false" border="false" foregroundColor="128" fillStrategy="none" toolTip="" errorToolTip=""/>
</text>
<question catyID="365" id="_12" fixedID="0_365" name="agent_name" cotyID="25">
<layout>
<position relYPosition="1" relXPosition="2"/>
<appearance alignment="west" backgroundColor="16777215" disabled="false" border="false" foregroundColor="0" fillStrategy="none" toolTip="" errorToolTip=""/>
</layout>
<textInput mandatory="false" columns="15" id="365" rows="1" error="false" editable="true" minLength="0" maxLength="60">
<position relYPosition="1" relXPosition="2"/>
<appearance alignment="west" backgroundColor="16777215" disabled="false" border="false" foregroundColor="0" fillStrategy="none" toolTip="" errorToolTip=""/>
<value id="306" value=""/>
</textInput>
</question>
<text id="2439" text="Code" optimizeWidth="true" error="false" relFixedID="0_102">
<position relYPosition="2" relXPosition="1"/>
<appearance alignment="west" backgroundColor="16777215" disabled="false" border="false" foregroundColor="128" fillStrategy="none" toolTip="" errorToolTip=""/>
</text>
<question catyID="102" id="_13" fixedID="0_102" name="agent_code" cotyID="25">
<layout>
<position relYPosition="2" relXPosition="2"/>
<appearance alignment="west" backgroundColor="16777215" disabled="false" border="false" foregroundColor="0" fillStrategy="none" toolTip="" errorToolTip=""/>
</layout>
<selection mandatory="false" id="102" name="agent_code" error="false" noColumns="0" editable="true" noRows="1" renderingHint="ComboBox">
<position relYPosition="2" relXPosition="2"/>
<appearance alignment="west" backgroundColor="16777215" disabled="false" border="false" foregroundColor="0" fillStrategy="none" toolTip="" errorToolTip=""/>
<value id="2" value="new agent, check"/>
<value id="1" value="special commission agreement"/>
<value selected="true" id="unknown" value="unknown"/>
</selection>
</question>
</group>
</group>
</screen>POST /capture
This command is used when a case (this mean an Input Interface) does already exist, and all information for one SourceType (see Input Interface document for more details about a SourceType) shall be captured or modified. When the case does not exist beforehand, use the command createAndCapture
Note: Errors are noted in the errorDescriptions of the result JSON-Map
| Path | Type | Description |
|---|---|---|
|
|
the language of the capturing |
|
|
the used sourceType |
|
|
The id of the used case |
|
|
The subsystem id of the used case |
|
|
SB1='false'; SB2='true' |
|
|
0 |
| Path | Type | Description |
|---|---|---|
|
|
API call path |
|
|
If call is completed successfully, then status is set to 0, otherwise it is set to 'WARNING'(=1) or 'OPERATION FAILED'(=2) or 'FATAL ERROR'(=3) |
|
|
Tf call is completed successfully, then status is set to 'OK', otherwise it is set to 'WARNING' or 'OPERATION FAILED' or 'FATAL ERROR' |
|
|
List of errorDescriptions in a JSON response |
|
|
the first screen to present. JSON-Map of the XML description in the screenbuilder SB1/SB2 documentation |
|
|
Empty on this call |
|
|
Empty on this call |
sample request
POST /capture HTTP/1.1
Content-Type: application/json;charset=UTF-8
Content-Length: 143
Host: localhost:8080
{
"language" : "en",
"sourceType" : 5,
"groupScreens" : true,
"caseId" : "TestCase",
"subId" : "Demo",
"loggingArea" : "0"
}sample response (in this case a SB2 screen)
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 5887
{
"path" : "/capture",
"status" : 0,
"statusText" : "OK",
"errorDescriptions" : [ ],
"jsonContent" : {
"screen" : {
"person" : {
"personName" : "MEier",
"orientation" : "LTR",
"item" : {
"personName" : "MEier",
"current" : true,
"question" : [ {
"textInput" : {
"editable" : true,
"language" : "en",
"id" : 209,
"rows" : 1,
"error" : false,
"mandatory" : true,
"value" : {
"id" : 2972,
"value" : "Bank clerk"
},
"searchable" : 2139
},
"catyID" : 209,
"id" : "X_1#_100#3_793_209",
"text" : {
"text" : "What is your current occupation?",
"error" : false
},
"cotyID" : 12,
"order" : 1
}, {
"catyID" : 127,
"selection" : {
"editable" : true,
"name" : "occupational_status",
"id" : 127,
"error" : false,
"mandatory" : true,
"value" : [ {
"id" : 2,
"value" : "Apprentice"
}, {
"id" : 10,
"value" : "Civil Servant"
}, {
"id" : 11,
"value" : "Employee",
"selected" : true
}, {
"id" : 6,
"value" : "House Person"
}, {
"id" : 0,
"value" : "Not employed"
}, {
"id" : 7,
"value" : "Retired"
}, {
"id" : 3,
"value" : "Self employed"
}, {
"id" : 5,
"value" : "Student"
}, {
"id" : 4,
"value" : "Worker"
}, {
"id" : 1,
"value" : "Other"
} ]
},
"id" : "X_1#_100#3_793_127",
"text" : {
"text" : "What is your occupational status?",
"error" : false
},
"cotyID" : 12,
"order" : 2
}, {
"catyID" : 135,
"numberInput" : {
"unit" : {
"name" : "£/Year",
"id" : 1
},
"maxVal" : 999999999,
"minVal" : 0,
"maxNumberDecimals" : 0,
"editable" : true,
"id" : 135,
"error" : false,
"mandatory" : true,
"value" : {
"id" : 1261,
"value" : 30000
}
},
"id" : "X_1#_101#3_863_135",
"text" : {
"text" : "What is your annual income?",
"error" : false
},
"cotyID" : 12,
"order" : 3
}, {
"catyID" : 72,
"selection" : {
"editable" : true,
"name" : "occupational_hazards_x (y/n)",
"id" : 72,
"error" : false,
"mandatory" : true,
"value" : [ {
"id" : 0,
"value" : "No",
"selected" : true
}, {
"id" : 1,
"value" : "Yes"
} ]
},
"id" : "X_1#_102#3_72",
"text" : {
"text" : "Does your job involve hazardous duties?",
"error" : false
},
"cotyID" : 27,
"order" : 4
}, {
"catyID" : 311,
"selection" : {
"editable" : true,
"name" : "pursuit_x (y/n)",
"id" : 311,
"error" : false,
"mandatory" : true,
"value" : [ {
"id" : 0,
"value" : "No",
"selected" : true
}, {
"id" : 1,
"value" : "Yes"
} ]
},
"id" : "X_1#_103#3_311",
"text" : {
"text" : "Have you any intention to participate in any hazardous sport or leisure activity,&cr; for example Aviation, Caving/Potholing, Climbing, Diving, Horse-riding, Motorsports, Mountaineering, Yachting?",
"error" : false
},
"cotyID" : 27,
"order" : 5
}, {
"catyID" : 267,
"selection" : {
"editable" : true,
"name" : "foreign_travel_x (y/n)",
"id" : 267,
"error" : false,
"mandatory" : true,
"value" : [ {
"id" : 0,
"value" : "No",
"selected" : true
}, {
"id" : 1,
"value" : "Yes"
} ]
},
"id" : "X_1#_104#3_267",
"text" : {
"text" : "Other than holidays of less than 3 months, have you any intention of going outside&cr; UK, Channel Islands or Isle of Man?",
"error" : false
},
"cotyID" : 27,
"order" : 6
} ],
"name" : "Non-health details MEier",
"consistent" : true,
"personID" : 1,
"id" : "_100",
"order" : 1,
"group" : "X_1"
},
"language" : "en",
"personID" : 1
}
}
},
"byteContent" : null,
"textContent" : null
}POST /captureXML
This command is used when a case (this mean an Input Interface) does already exist, and all information for one SourceType (see Input Interface document for more details about a SourceType) shall be captured or modified. When the case does not exist beforehand, use the command createAndCapture (XML-Version)
Note: Errors are noted in an operationResult with errors in the XML-String
| Path | Type | Description |
|---|---|---|
|
|
the language of the capturing |
|
|
the used sourceType |
|
|
The id of the used case |
|
|
The subsystem id of the used case |
|
|
0 |
|
|
SB1='false'; SB2='true' |
| Path | Type | Description |
|---|---|---|
|
|
The screen to be presented. It is in form of an XML string. |
sample request
POST /captureXML HTTP/1.1
Content-Type: application/json;charset=UTF-8
Content-Length: 143
Host: localhost:8080
{
"language" : "en",
"sourceType" : 5,
"groupScreens" : true,
"caseId" : "TestCase",
"subId" : "Demo",
"loggingArea" : "0"
}sample response (in this case a SB2 screen)
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/xml;charset=UTF-8
Content-Length: 4878
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
<?xml version="1.0" encoding="UTF-8"?>
<screen>
<person language="en" orientation="LTR" personName="MEier" personID="1">
<item current="true" personName="MEier" consistent="true" personID="1" order="1" id="_100" name="Non-health details MEier" group="X_1">
<question catyID="209" id="X_1#_100#3_793_209" order="1" cotyID="12">
<textInput language="en" mandatory="true" id="209" rows="1" error="false" editable="true" searchable="2139">
<value id="2972" value="Bank clerk"/>
</textInput>
<text text="What is your current occupation?" error="false"/>
</question>
<question catyID="127" id="X_1#_100#3_793_127" order="2" cotyID="12">
<selection mandatory="true" id="127" editable="true" name="occupational_status" error="false">
<value id="2" value="Apprentice"/>
<value id="10" value="Civil Servant"/>
<value selected="true" id="11" value="Employee"/>
<value id="6" value="House Person"/>
<value id="0" value="Not employed"/>
<value id="7" value="Retired"/>
<value id="3" value="Self employed"/>
<value id="5" value="Student"/>
<value id="4" value="Worker"/>
<value id="1" value="Other"/>
</selection>
<text text="What is your occupational status?" error="false"/>
</question>
<question catyID="135" id="X_1#_101#3_863_135" order="3" cotyID="12">
<numberInput maxVal="999999999" mandatory="true" id="135" maxNumberDecimals="0" minVal="0" error="false" editable="true">
<value id="1261" value="30000"/>
<unit name="£/Year" id="1"/>
</numberInput>
<text text="What is your annual income?" error="false"/>
</question>
<question catyID="72" id="X_1#_102#3_72" order="4" cotyID="27">
<selection mandatory="true" id="72" editable="true" name="occupational_hazards_x (y/n)" error="false">
<value selected="true" id="0" value="No"/>
<value id="1" value="Yes"/>
</selection>
<text text="Does your job involve hazardous duties?" error="false"/>
</question>
<question catyID="311" id="X_1#_103#3_311" order="5" cotyID="27">
<selection mandatory="true" id="311" editable="true" name="pursuit_x (y/n)" error="false">
<value selected="true" id="0" value="No"/>
<value id="1" value="Yes"/>
</selection>
<text text="Have you any intention to participate in any hazardous sport or leisure activity,&cr; for example Aviation, Caving/Potholing, Climbing, Diving, Horse-riding, Motorsports, Mountaineering, Yachting?" error="false"/>
</question>
<question catyID="267" id="X_1#_104#3_267" order="6" cotyID="27">
<selection mandatory="true" id="267" editable="true" name="foreign_travel_x (y/n)" error="false">
<value selected="true" id="0" value="No"/>
<value id="1" value="Yes"/>
</selection>
<text text="Other than holidays of less than 3 months, have you any intention of going outside&cr; UK, Channel Islands or Isle of Man?" error="false"/>
</question>
</item>
</person>
</screen>POST /captureWithHashXML
This command is used when a case (this mean an Input Interface, usually the Technical Data) does already exist, and all information for one SourceType (see Input Interface document for more details about a SourceType) shall be captured or modified. Additionally, an SHA3-256-Hash and a timestamp need to be passed so that the contents of this POST-call are secured against manipulation.
Note: Errors are noted in an operationResult with errors in the XML-String
| Path | Type | Description |
|---|---|---|
|
|
the language of the capturing |
|
|
the used sourceType |
|
|
The id of the used case |
|
|
The subsystem id of the used case |
|
|
SB1='false'; SB2='true' |
|
|
0 |
|
|
hashValue |
|
|
timestamp |
| Path | Type | Description |
|---|---|---|
|
|
The screen to be presented. It is in form of an XML string. |
sample request
POST /captureWithHashXML HTTP/1.1
Content-Type: application/json;charset=UTF-8
Content-Length: 274
Host: localhost:8080
{
"language" : "en",
"sourceType" : 5,
"groupScreens" : true,
"caseId" : "TestCase",
"subId" : "Demo",
"loggingArea" : "0",
"hash" : "67c99cd1eb915ac09feda4b64fe30a0966c6775bd58710bc7117a54b19ee5145",
"timestamp" : "2023-11-02T18:35:31.814269600Z"
}sample request body
{
"language" : "en",
"sourceType" : 5,
"groupScreens" : true,
"caseId" : "TestCase",
"subId" : "Demo",
"loggingArea" : "0",
"hash" : "67c99cd1eb915ac09feda4b64fe30a0966c6775bd58710bc7117a54b19ee5145",
"timestamp" : "2023-11-02T18:35:31.814269600Z"
}sample response (in this case a SB2 screen)
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/xml;charset=UTF-8
Content-Length: 4878
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
<?xml version="1.0" encoding="UTF-8"?>
<screen>
<person language="en" orientation="LTR" personName="MEier" personID="1">
<item current="true" personName="MEier" consistent="true" personID="1" order="1" id="_100" name="Non-health details MEier" group="X_1">
<question catyID="209" id="X_1#_100#3_793_209" order="1" cotyID="12">
<textInput language="en" mandatory="true" id="209" rows="1" error="false" editable="true" searchable="2139">
<value id="2972" value="Bank clerk"/>
</textInput>
<text text="What is your current occupation?" error="false"/>
</question>
<question catyID="127" id="X_1#_100#3_793_127" order="2" cotyID="12">
<selection mandatory="true" id="127" editable="true" name="occupational_status" error="false">
<value id="2" value="Apprentice"/>
<value id="10" value="Civil Servant"/>
<value selected="true" id="11" value="Employee"/>
<value id="6" value="House Person"/>
<value id="0" value="Not employed"/>
<value id="7" value="Retired"/>
<value id="3" value="Self employed"/>
<value id="5" value="Student"/>
<value id="4" value="Worker"/>
<value id="1" value="Other"/>
</selection>
<text text="What is your occupational status?" error="false"/>
</question>
<question catyID="135" id="X_1#_101#3_863_135" order="3" cotyID="12">
<numberInput maxVal="999999999" mandatory="true" id="135" maxNumberDecimals="0" minVal="0" error="false" editable="true">
<value id="1261" value="30000"/>
<unit name="£/Year" id="1"/>
</numberInput>
<text text="What is your annual income?" error="false"/>
</question>
<question catyID="72" id="X_1#_102#3_72" order="4" cotyID="27">
<selection mandatory="true" id="72" editable="true" name="occupational_hazards_x (y/n)" error="false">
<value selected="true" id="0" value="No"/>
<value id="1" value="Yes"/>
</selection>
<text text="Does your job involve hazardous duties?" error="false"/>
</question>
<question catyID="311" id="X_1#_103#3_311" order="5" cotyID="27">
<selection mandatory="true" id="311" editable="true" name="pursuit_x (y/n)" error="false">
<value selected="true" id="0" value="No"/>
<value id="1" value="Yes"/>
</selection>
<text text="Have you any intention to participate in any hazardous sport or leisure activity,&cr; for example Aviation, Caving/Potholing, Climbing, Diving, Horse-riding, Motorsports, Mountaineering, Yachting?" error="false"/>
</question>
<question catyID="267" id="X_1#_104#3_267" order="6" cotyID="27">
<selection mandatory="true" id="267" editable="true" name="foreign_travel_x (y/n)" error="false">
<value selected="true" id="0" value="No"/>
<value id="1" value="Yes"/>
</selection>
<text text="Other than holidays of less than 3 months, have you any intention of going outside&cr; UK, Channel Islands or Isle of Man?" error="false"/>
</question>
</item>
</person>
</screen>sample response body
<?xml version="1.0" encoding="UTF-8"?>
<screen>
<person language="en" orientation="LTR" personName="MEier" personID="1">
<item current="true" personName="MEier" consistent="true" personID="1" order="1" id="_100" name="Non-health details MEier" group="X_1">
<question catyID="209" id="X_1#_100#3_793_209" order="1" cotyID="12">
<textInput language="en" mandatory="true" id="209" rows="1" error="false" editable="true" searchable="2139">
<value id="2972" value="Bank clerk"/>
</textInput>
<text text="What is your current occupation?" error="false"/>
</question>
<question catyID="127" id="X_1#_100#3_793_127" order="2" cotyID="12">
<selection mandatory="true" id="127" editable="true" name="occupational_status" error="false">
<value id="2" value="Apprentice"/>
<value id="10" value="Civil Servant"/>
<value selected="true" id="11" value="Employee"/>
<value id="6" value="House Person"/>
<value id="0" value="Not employed"/>
<value id="7" value="Retired"/>
<value id="3" value="Self employed"/>
<value id="5" value="Student"/>
<value id="4" value="Worker"/>
<value id="1" value="Other"/>
</selection>
<text text="What is your occupational status?" error="false"/>
</question>
<question catyID="135" id="X_1#_101#3_863_135" order="3" cotyID="12">
<numberInput maxVal="999999999" mandatory="true" id="135" maxNumberDecimals="0" minVal="0" error="false" editable="true">
<value id="1261" value="30000"/>
<unit name="£/Year" id="1"/>
</numberInput>
<text text="What is your annual income?" error="false"/>
</question>
<question catyID="72" id="X_1#_102#3_72" order="4" cotyID="27">
<selection mandatory="true" id="72" editable="true" name="occupational_hazards_x (y/n)" error="false">
<value selected="true" id="0" value="No"/>
<value id="1" value="Yes"/>
</selection>
<text text="Does your job involve hazardous duties?" error="false"/>
</question>
<question catyID="311" id="X_1#_103#3_311" order="5" cotyID="27">
<selection mandatory="true" id="311" editable="true" name="pursuit_x (y/n)" error="false">
<value selected="true" id="0" value="No"/>
<value id="1" value="Yes"/>
</selection>
<text text="Have you any intention to participate in any hazardous sport or leisure activity,&cr; for example Aviation, Caving/Potholing, Climbing, Diving, Horse-riding, Motorsports, Mountaineering, Yachting?" error="false"/>
</question>
<question catyID="267" id="X_1#_104#3_267" order="6" cotyID="27">
<selection mandatory="true" id="267" editable="true" name="foreign_travel_x (y/n)" error="false">
<value selected="true" id="0" value="No"/>
<value id="1" value="Yes"/>
</selection>
<text text="Other than holidays of less than 3 months, have you any intention of going outside&cr; UK, Channel Islands or Isle of Man?" error="false"/>
</question>
</item>
</person>
</screen>sample response (in this case a SB2 screen)
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/xml;charset=UTF-8
Content-Length: 4878
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
<?xml version="1.0" encoding="UTF-8"?>
<screen>
<person language="en" orientation="LTR" personName="MEier" personID="1">
<item current="true" personName="MEier" consistent="true" personID="1" order="1" id="_100" name="Non-health details MEier" group="X_1">
<question catyID="209" id="X_1#_100#3_793_209" order="1" cotyID="12">
<textInput language="en" mandatory="true" id="209" rows="1" error="false" editable="true" searchable="2139">
<value id="2972" value="Bank clerk"/>
</textInput>
<text text="What is your current occupation?" error="false"/>
</question>
<question catyID="127" id="X_1#_100#3_793_127" order="2" cotyID="12">
<selection mandatory="true" id="127" editable="true" name="occupational_status" error="false">
<value id="2" value="Apprentice"/>
<value id="10" value="Civil Servant"/>
<value selected="true" id="11" value="Employee"/>
<value id="6" value="House Person"/>
<value id="0" value="Not employed"/>
<value id="7" value="Retired"/>
<value id="3" value="Self employed"/>
<value id="5" value="Student"/>
<value id="4" value="Worker"/>
<value id="1" value="Other"/>
</selection>
<text text="What is your occupational status?" error="false"/>
</question>
<question catyID="135" id="X_1#_101#3_863_135" order="3" cotyID="12">
<numberInput maxVal="999999999" mandatory="true" id="135" maxNumberDecimals="0" minVal="0" error="false" editable="true">
<value id="1261" value="30000"/>
<unit name="£/Year" id="1"/>
</numberInput>
<text text="What is your annual income?" error="false"/>
</question>
<question catyID="72" id="X_1#_102#3_72" order="4" cotyID="27">
<selection mandatory="true" id="72" editable="true" name="occupational_hazards_x (y/n)" error="false">
<value selected="true" id="0" value="No"/>
<value id="1" value="Yes"/>
</selection>
<text text="Does your job involve hazardous duties?" error="false"/>
</question>
<question catyID="311" id="X_1#_103#3_311" order="5" cotyID="27">
<selection mandatory="true" id="311" editable="true" name="pursuit_x (y/n)" error="false">
<value selected="true" id="0" value="No"/>
<value id="1" value="Yes"/>
</selection>
<text text="Have you any intention to participate in any hazardous sport or leisure activity,&cr; for example Aviation, Caving/Potholing, Climbing, Diving, Horse-riding, Motorsports, Mountaineering, Yachting?" error="false"/>
</question>
<question catyID="267" id="X_1#_104#3_267" order="6" cotyID="27">
<selection mandatory="true" id="267" editable="true" name="foreign_travel_x (y/n)" error="false">
<value selected="true" id="0" value="No"/>
<value id="1" value="Yes"/>
</selection>
<text text="Other than holidays of less than 3 months, have you any intention of going outside&cr; UK, Channel Islands or Isle of Man?" error="false"/>
</question>
</item>
</person>
</screen>curl tequest
$ curl 'http://localhost:8080/captureWithHashXML' -i -X POST \
-H 'Content-Type: application/json;charset=UTF-8' \
-d '{
"language" : "en",
"sourceType" : 5,
"groupScreens" : true,
"caseId" : "TestCase",
"subId" : "Demo",
"loggingArea" : "0",
"hash" : "67c99cd1eb915ac09feda4b64fe30a0966c6775bd58710bc7117a54b19ee5145",
"timestamp" : "2023-11-02T18:35:31.814269600Z"
}'POST /captureWithHash
This command is used when a case (this mean an Input Interface, usually the Technical Data) does already exist, and all information for one SourceType (see Input Interface document for more details about a SourceType) shall be captured or modified. Additionally, an SHA3-256-Hash and a timestamp need to be passed so that the contents of this POST-call are secured against manipulation.
Note: Errors are noted in an operationResult with errors in the JSON body
| Path | Type | Description |
|---|---|---|
|
|
the language of the capturing |
|
|
the used sourceType |
|
|
The id of the used case |
|
|
The subsystem id of the used case |
|
|
SB1='false'; SB2='true' |
|
|
0 |
|
|
hashValue |
|
|
timestamp |
| Path | Type | Description |
|---|---|---|
|
|
API call path |
|
|
If call is completed successfully, then status is set to 0, otherwise it is set to 'WARNING'(=1) or 'OPERATION FAILED'(=2) or 'FATAL ERROR'(=3) |
|
|
Tf call is completed successfully, then status is set to 'OK', otherwise it is set to 'WARNING' or 'OPERATION FAILED' or 'FATAL ERROR' |
|
|
List of errorDescriptions in a JSON response |
|
|
the first screen to present. JSON-Map of the XML description in the screenbuilder SB1/SB2 documentation |
|
|
Empty on this call |
|
|
Empty on this call |
sample request
POST /captureWithHash HTTP/1.1
Content-Type: application/json;charset=UTF-8
Content-Length: 274
Host: localhost:8080
{
"language" : "en",
"sourceType" : 5,
"groupScreens" : true,
"caseId" : "TestCase",
"subId" : "Demo",
"loggingArea" : "0",
"hash" : "fcec3c1712d42a08ac677445807815c75cfebe32b61af63772eeca3f7f1e603b",
"timestamp" : "2023-11-02T18:35:31.351519900Z"
}sample request body
{
"language" : "en",
"sourceType" : 5,
"groupScreens" : true,
"caseId" : "TestCase",
"subId" : "Demo",
"loggingArea" : "0",
"hash" : "fcec3c1712d42a08ac677445807815c75cfebe32b61af63772eeca3f7f1e603b",
"timestamp" : "2023-11-02T18:35:31.351519900Z"
}sample response (in this case a SB2 screen)
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 5895
{
"path" : "/captureWithHash",
"status" : 0,
"statusText" : "OK",
"errorDescriptions" : [ ],
"jsonContent" : {
"screen" : {
"person" : {
"personName" : "MEier",
"orientation" : "LTR",
"item" : {
"personName" : "MEier",
"current" : true,
"question" : [ {
"textInput" : {
"editable" : true,
"language" : "en",
"id" : 209,
"rows" : 1,
"error" : false,
"mandatory" : true,
"value" : {
"id" : 2972,
"value" : "Bank clerk"
},
"searchable" : 2139
},
"catyID" : 209,
"id" : "X_1#_100#3_793_209",
"text" : {
"text" : "What is your current occupation?",
"error" : false
},
"cotyID" : 12,
"order" : 1
}, {
"catyID" : 127,
"selection" : {
"editable" : true,
"name" : "occupational_status",
"id" : 127,
"error" : false,
"mandatory" : true,
"value" : [ {
"id" : 2,
"value" : "Apprentice"
}, {
"id" : 10,
"value" : "Civil Servant"
}, {
"id" : 11,
"value" : "Employee",
"selected" : true
}, {
"id" : 6,
"value" : "House Person"
}, {
"id" : 0,
"value" : "Not employed"
}, {
"id" : 7,
"value" : "Retired"
}, {
"id" : 3,
"value" : "Self employed"
}, {
"id" : 5,
"value" : "Student"
}, {
"id" : 4,
"value" : "Worker"
}, {
"id" : 1,
"value" : "Other"
} ]
},
"id" : "X_1#_100#3_793_127",
"text" : {
"text" : "What is your occupational status?",
"error" : false
},
"cotyID" : 12,
"order" : 2
}, {
"catyID" : 135,
"numberInput" : {
"unit" : {
"name" : "£/Year",
"id" : 1
},
"maxVal" : 999999999,
"minVal" : 0,
"maxNumberDecimals" : 0,
"editable" : true,
"id" : 135,
"error" : false,
"mandatory" : true,
"value" : {
"id" : 1261,
"value" : 30000
}
},
"id" : "X_1#_101#3_863_135",
"text" : {
"text" : "What is your annual income?",
"error" : false
},
"cotyID" : 12,
"order" : 3
}, {
"catyID" : 72,
"selection" : {
"editable" : true,
"name" : "occupational_hazards_x (y/n)",
"id" : 72,
"error" : false,
"mandatory" : true,
"value" : [ {
"id" : 0,
"value" : "No",
"selected" : true
}, {
"id" : 1,
"value" : "Yes"
} ]
},
"id" : "X_1#_102#3_72",
"text" : {
"text" : "Does your job involve hazardous duties?",
"error" : false
},
"cotyID" : 27,
"order" : 4
}, {
"catyID" : 311,
"selection" : {
"editable" : true,
"name" : "pursuit_x (y/n)",
"id" : 311,
"error" : false,
"mandatory" : true,
"value" : [ {
"id" : 0,
"value" : "No",
"selected" : true
}, {
"id" : 1,
"value" : "Yes"
} ]
},
"id" : "X_1#_103#3_311",
"text" : {
"text" : "Have you any intention to participate in any hazardous sport or leisure activity,&cr; for example Aviation, Caving/Potholing, Climbing, Diving, Horse-riding, Motorsports, Mountaineering, Yachting?",
"error" : false
},
"cotyID" : 27,
"order" : 5
}, {
"catyID" : 267,
"selection" : {
"editable" : true,
"name" : "foreign_travel_x (y/n)",
"id" : 267,
"error" : false,
"mandatory" : true,
"value" : [ {
"id" : 0,
"value" : "No",
"selected" : true
}, {
"id" : 1,
"value" : "Yes"
} ]
},
"id" : "X_1#_104#3_267",
"text" : {
"text" : "Other than holidays of less than 3 months, have you any intention of going outside&cr; UK, Channel Islands or Isle of Man?",
"error" : false
},
"cotyID" : 27,
"order" : 6
} ],
"name" : "Non-health details MEier",
"consistent" : true,
"personID" : 1,
"id" : "_100",
"order" : 1,
"group" : "X_1"
},
"language" : "en",
"personID" : 1
}
}
},
"byteContent" : null,
"textContent" : null
}sample response body
{
"path" : "/captureWithHash",
"status" : 0,
"statusText" : "OK",
"errorDescriptions" : [ ],
"jsonContent" : {
"screen" : {
"person" : {
"personName" : "MEier",
"orientation" : "LTR",
"item" : {
"personName" : "MEier",
"current" : true,
"question" : [ {
"textInput" : {
"editable" : true,
"language" : "en",
"id" : 209,
"rows" : 1,
"error" : false,
"mandatory" : true,
"value" : {
"id" : 2972,
"value" : "Bank clerk"
},
"searchable" : 2139
},
"catyID" : 209,
"id" : "X_1#_100#3_793_209",
"text" : {
"text" : "What is your current occupation?",
"error" : false
},
"cotyID" : 12,
"order" : 1
}, {
"catyID" : 127,
"selection" : {
"editable" : true,
"name" : "occupational_status",
"id" : 127,
"error" : false,
"mandatory" : true,
"value" : [ {
"id" : 2,
"value" : "Apprentice"
}, {
"id" : 10,
"value" : "Civil Servant"
}, {
"id" : 11,
"value" : "Employee",
"selected" : true
}, {
"id" : 6,
"value" : "House Person"
}, {
"id" : 0,
"value" : "Not employed"
}, {
"id" : 7,
"value" : "Retired"
}, {
"id" : 3,
"value" : "Self employed"
}, {
"id" : 5,
"value" : "Student"
}, {
"id" : 4,
"value" : "Worker"
}, {
"id" : 1,
"value" : "Other"
} ]
},
"id" : "X_1#_100#3_793_127",
"text" : {
"text" : "What is your occupational status?",
"error" : false
},
"cotyID" : 12,
"order" : 2
}, {
"catyID" : 135,
"numberInput" : {
"unit" : {
"name" : "£/Year",
"id" : 1
},
"maxVal" : 999999999,
"minVal" : 0,
"maxNumberDecimals" : 0,
"editable" : true,
"id" : 135,
"error" : false,
"mandatory" : true,
"value" : {
"id" : 1261,
"value" : 30000
}
},
"id" : "X_1#_101#3_863_135",
"text" : {
"text" : "What is your annual income?",
"error" : false
},
"cotyID" : 12,
"order" : 3
}, {
"catyID" : 72,
"selection" : {
"editable" : true,
"name" : "occupational_hazards_x (y/n)",
"id" : 72,
"error" : false,
"mandatory" : true,
"value" : [ {
"id" : 0,
"value" : "No",
"selected" : true
}, {
"id" : 1,
"value" : "Yes"
} ]
},
"id" : "X_1#_102#3_72",
"text" : {
"text" : "Does your job involve hazardous duties?",
"error" : false
},
"cotyID" : 27,
"order" : 4
}, {
"catyID" : 311,
"selection" : {
"editable" : true,
"name" : "pursuit_x (y/n)",
"id" : 311,
"error" : false,
"mandatory" : true,
"value" : [ {
"id" : 0,
"value" : "No",
"selected" : true
}, {
"id" : 1,
"value" : "Yes"
} ]
},
"id" : "X_1#_103#3_311",
"text" : {
"text" : "Have you any intention to participate in any hazardous sport or leisure activity,&cr; for example Aviation, Caving/Potholing, Climbing, Diving, Horse-riding, Motorsports, Mountaineering, Yachting?",
"error" : false
},
"cotyID" : 27,
"order" : 5
}, {
"catyID" : 267,
"selection" : {
"editable" : true,
"name" : "foreign_travel_x (y/n)",
"id" : 267,
"error" : false,
"mandatory" : true,
"value" : [ {
"id" : 0,
"value" : "No",
"selected" : true
}, {
"id" : 1,
"value" : "Yes"
} ]
},
"id" : "X_1#_104#3_267",
"text" : {
"text" : "Other than holidays of less than 3 months, have you any intention of going outside&cr; UK, Channel Islands or Isle of Man?",
"error" : false
},
"cotyID" : 27,
"order" : 6
} ],
"name" : "Non-health details MEier",
"consistent" : true,
"personID" : 1,
"id" : "_100",
"order" : 1,
"group" : "X_1"
},
"language" : "en",
"personID" : 1
}
}
},
"byteContent" : null,
"textContent" : null
}sample response (in this case a SB2 screen)
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 5895
{
"path" : "/captureWithHash",
"status" : 0,
"statusText" : "OK",
"errorDescriptions" : [ ],
"jsonContent" : {
"screen" : {
"person" : {
"personName" : "MEier",
"orientation" : "LTR",
"item" : {
"personName" : "MEier",
"current" : true,
"question" : [ {
"textInput" : {
"editable" : true,
"language" : "en",
"id" : 209,
"rows" : 1,
"error" : false,
"mandatory" : true,
"value" : {
"id" : 2972,
"value" : "Bank clerk"
},
"searchable" : 2139
},
"catyID" : 209,
"id" : "X_1#_100#3_793_209",
"text" : {
"text" : "What is your current occupation?",
"error" : false
},
"cotyID" : 12,
"order" : 1
}, {
"catyID" : 127,
"selection" : {
"editable" : true,
"name" : "occupational_status",
"id" : 127,
"error" : false,
"mandatory" : true,
"value" : [ {
"id" : 2,
"value" : "Apprentice"
}, {
"id" : 10,
"value" : "Civil Servant"
}, {
"id" : 11,
"value" : "Employee",
"selected" : true
}, {
"id" : 6,
"value" : "House Person"
}, {
"id" : 0,
"value" : "Not employed"
}, {
"id" : 7,
"value" : "Retired"
}, {
"id" : 3,
"value" : "Self employed"
}, {
"id" : 5,
"value" : "Student"
}, {
"id" : 4,
"value" : "Worker"
}, {
"id" : 1,
"value" : "Other"
} ]
},
"id" : "X_1#_100#3_793_127",
"text" : {
"text" : "What is your occupational status?",
"error" : false
},
"cotyID" : 12,
"order" : 2
}, {
"catyID" : 135,
"numberInput" : {
"unit" : {
"name" : "£/Year",
"id" : 1
},
"maxVal" : 999999999,
"minVal" : 0,
"maxNumberDecimals" : 0,
"editable" : true,
"id" : 135,
"error" : false,
"mandatory" : true,
"value" : {
"id" : 1261,
"value" : 30000
}
},
"id" : "X_1#_101#3_863_135",
"text" : {
"text" : "What is your annual income?",
"error" : false
},
"cotyID" : 12,
"order" : 3
}, {
"catyID" : 72,
"selection" : {
"editable" : true,
"name" : "occupational_hazards_x (y/n)",
"id" : 72,
"error" : false,
"mandatory" : true,
"value" : [ {
"id" : 0,
"value" : "No",
"selected" : true
}, {
"id" : 1,
"value" : "Yes"
} ]
},
"id" : "X_1#_102#3_72",
"text" : {
"text" : "Does your job involve hazardous duties?",
"error" : false
},
"cotyID" : 27,
"order" : 4
}, {
"catyID" : 311,
"selection" : {
"editable" : true,
"name" : "pursuit_x (y/n)",
"id" : 311,
"error" : false,
"mandatory" : true,
"value" : [ {
"id" : 0,
"value" : "No",
"selected" : true
}, {
"id" : 1,
"value" : "Yes"
} ]
},
"id" : "X_1#_103#3_311",
"text" : {
"text" : "Have you any intention to participate in any hazardous sport or leisure activity,&cr; for example Aviation, Caving/Potholing, Climbing, Diving, Horse-riding, Motorsports, Mountaineering, Yachting?",
"error" : false
},
"cotyID" : 27,
"order" : 5
}, {
"catyID" : 267,
"selection" : {
"editable" : true,
"name" : "foreign_travel_x (y/n)",
"id" : 267,
"error" : false,
"mandatory" : true,
"value" : [ {
"id" : 0,
"value" : "No",
"selected" : true
}, {
"id" : 1,
"value" : "Yes"
} ]
},
"id" : "X_1#_104#3_267",
"text" : {
"text" : "Other than holidays of less than 3 months, have you any intention of going outside&cr; UK, Channel Islands or Isle of Man?",
"error" : false
},
"cotyID" : 27,
"order" : 6
} ],
"name" : "Non-health details MEier",
"consistent" : true,
"personID" : 1,
"id" : "_100",
"order" : 1,
"group" : "X_1"
},
"language" : "en",
"personID" : 1
}
}
},
"byteContent" : null,
"textContent" : null
}curl tequest
$ curl 'http://localhost:8080/captureWithHash' -i -X POST \
-H 'Content-Type: application/json;charset=UTF-8' \
-d '{
"language" : "en",
"sourceType" : 5,
"groupScreens" : true,
"caseId" : "TestCase",
"subId" : "Demo",
"loggingArea" : "0",
"hash" : "fcec3c1712d42a08ac677445807815c75cfebe32b61af63772eeca3f7f1e603b",
"timestamp" : "2023-11-02T18:35:31.351519900Z"
}'POST /userAction
This api is called as a reply, when the COMPASS servers last response was a screen
Note: Errors are noted in the errorDescriptions of the result JSON-Map
| Path | Type | Description |
|---|---|---|
|
|
Screencommand, see ScreenBuilder docu |
|
|
the screen id on which the question exists |
|
|
The id of the used case |
|
|
The subsystem id of the used case |
|
|
0 |
|
|
an list of answers |
|
|
the questionId of answer |
|
|
a list of values for the answer |
|
|
the id of the value |
|
|
the value itself |
|
|
the unit of the value |
| Path | Type | Description |
|---|---|---|
|
|
API call path |
|
|
If call is completed successfully, then status is set to 0, otherwise it is set to 'WARNING'(=1) or 'OPERATION FAILED'(=2) or 'FATAL ERROR'(=3) |
|
|
Tf call is completed successfully, then status is set to 'OK', otherwise it is set to 'WARNING' or 'OPERATION FAILED' or 'FATAL ERROR' |
|
|
If call is completed successfully, then status is set to 0, otherwise it is set to 'WARNING'(=1) or 'OPERATION FAILED'(=2) or 'FATAL ERROR'(=3) |
|
|
List of errorDescriptions in a JSON response |
|
|
the screen to present. JSON-Map of the XML description in the screenbuilder SB1/SB2 documentation |
|
|
Empty on this call |
|
|
Empty on this call |
sample request
POST /userAction HTTP/1.1
Content-Type: application/json;charset=UTF-8
Content-Length: 304
Host: localhost:8080
{
"screenCommand" : "_100",
"screenId" : "_100",
"caseId" : "TestCase",
"subId" : "Demo",
"loggingArea" : "0",
"answers" : [ {
"questionId" : "X_1#_100#3_793_209",
"values" : [ {
"id" : "3489",
"value" : "Software designer",
"unit" : ""
} ]
} ]
}sample response
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 5897
{
"path" : "/userAction",
"status" : 0,
"statusText" : "OK",
"errorDescriptions" : [ ],
"jsonContent" : {
"screen" : {
"person" : {
"personName" : "MEier",
"orientation" : "LTR",
"item" : {
"personName" : "MEier",
"current" : true,
"question" : [ {
"textInput" : {
"editable" : true,
"language" : "en",
"id" : 209,
"rows" : 1,
"error" : false,
"mandatory" : true,
"value" : {
"id" : 2972,
"value" : "Software designer"
},
"searchable" : 2139
},
"catyID" : 209,
"id" : "X_1#_100#3_793_209",
"text" : {
"text" : "What is your current occupation?",
"error" : false
},
"cotyID" : 12,
"order" : 1
}, {
"catyID" : 127,
"selection" : {
"editable" : true,
"name" : "occupational_status",
"id" : 127,
"error" : false,
"mandatory" : true,
"value" : [ {
"id" : 2,
"value" : "Apprentice"
}, {
"id" : 10,
"value" : "Civil Servant"
}, {
"id" : 11,
"value" : "Employee",
"selected" : true
}, {
"id" : 6,
"value" : "House Person"
}, {
"id" : 0,
"value" : "Not employed"
}, {
"id" : 7,
"value" : "Retired"
}, {
"id" : 3,
"value" : "Self employed"
}, {
"id" : 5,
"value" : "Student"
}, {
"id" : 4,
"value" : "Worker"
}, {
"id" : 1,
"value" : "Other"
} ]
},
"id" : "X_1#_100#3_793_127",
"text" : {
"text" : "What is your occupational status?",
"error" : false
},
"cotyID" : 12,
"order" : 2
}, {
"catyID" : 135,
"numberInput" : {
"unit" : {
"name" : "£/Year",
"id" : 1
},
"maxVal" : 999999999,
"minVal" : 0,
"maxNumberDecimals" : 0,
"editable" : true,
"id" : 135,
"error" : false,
"mandatory" : true,
"value" : {
"id" : 1261,
"value" : 30000
}
},
"id" : "X_1#_101#3_863_135",
"text" : {
"text" : "What is your annual income?",
"error" : false
},
"cotyID" : 12,
"order" : 3
}, {
"catyID" : 72,
"selection" : {
"editable" : true,
"name" : "occupational_hazards_x (y/n)",
"id" : 72,
"error" : false,
"mandatory" : true,
"value" : [ {
"id" : 0,
"value" : "No",
"selected" : true
}, {
"id" : 1,
"value" : "Yes"
} ]
},
"id" : "X_1#_102#3_72",
"text" : {
"text" : "Does your job involve hazardous duties?",
"error" : false
},
"cotyID" : 27,
"order" : 4
}, {
"catyID" : 311,
"selection" : {
"editable" : true,
"name" : "pursuit_x (y/n)",
"id" : 311,
"error" : false,
"mandatory" : true,
"value" : [ {
"id" : 0,
"value" : "No",
"selected" : true
}, {
"id" : 1,
"value" : "Yes"
} ]
},
"id" : "X_1#_103#3_311",
"text" : {
"text" : "Have you any intention to participate in any hazardous sport or leisure activity,&cr; for example Aviation, Caving/Potholing, Climbing, Diving, Horse-riding, Motorsports, Mountaineering, Yachting?",
"error" : false
},
"cotyID" : 27,
"order" : 5
}, {
"catyID" : 267,
"selection" : {
"editable" : true,
"name" : "foreign_travel_x (y/n)",
"id" : 267,
"error" : false,
"mandatory" : true,
"value" : [ {
"id" : 0,
"value" : "No",
"selected" : true
}, {
"id" : 1,
"value" : "Yes"
} ]
},
"id" : "X_1#_104#3_267",
"text" : {
"text" : "Other than holidays of less than 3 months, have you any intention of going outside&cr; UK, Channel Islands or Isle of Man?",
"error" : false
},
"cotyID" : 27,
"order" : 6
} ],
"name" : "Non-health details MEier",
"consistent" : true,
"personID" : 1,
"id" : "_100",
"order" : 1,
"group" : "X_1"
},
"language" : "en",
"personID" : 1
}
}
},
"byteContent" : null,
"textContent" : null
}POST /userActionXML
This api is called as a reply, when the COMPASS servers last response was a screen (XML-Version)
Note: Errors are noted in an operationResult with errors in the XML-String
| Path | Type | Description |
|---|---|---|
|
|
Screencommand, see ScreenBuilder docu |
|
|
the screen id on which the question exists |
|
|
The id of the used case |
|
|
The subsystem id of the used case |
|
|
0 |
|
|
an list of answers |
|
|
the questionId of answer |
|
|
a list of values for the answer |
|
|
the id of the value |
|
|
the value itself |
|
|
the unit of the value |
| Path | Type | Description |
|---|---|---|
|
|
The screen to be presented. It is in form of an XML string. |
sample request
POST /userActionXML HTTP/1.1
Content-Type: application/json;charset=UTF-8
Content-Length: 304
Host: localhost:8080
{
"screenCommand" : "_100",
"screenId" : "_100",
"caseId" : "TestCase",
"subId" : "Demo",
"loggingArea" : "0",
"answers" : [ {
"questionId" : "X_1#_100#3_793_209",
"values" : [ {
"id" : "3489",
"value" : "Software designer",
"unit" : ""
} ]
} ]
}sample response
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/xml;charset=UTF-8
Content-Length: 4885
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
<?xml version="1.0" encoding="UTF-8"?>
<screen>
<person language="en" orientation="LTR" personName="MEier" personID="1">
<item current="true" personName="MEier" consistent="true" personID="1" order="1" id="_100" name="Non-health details MEier" group="X_1">
<question catyID="209" id="X_1#_100#3_793_209" order="1" cotyID="12">
<textInput language="en" mandatory="true" id="209" rows="1" error="false" editable="true" searchable="2139">
<value id="2972" value="Software designer"/>
</textInput>
<text text="What is your current occupation?" error="false"/>
</question>
<question catyID="127" id="X_1#_100#3_793_127" order="2" cotyID="12">
<selection mandatory="true" id="127" editable="true" name="occupational_status" error="false">
<value id="2" value="Apprentice"/>
<value id="10" value="Civil Servant"/>
<value selected="true" id="11" value="Employee"/>
<value id="6" value="House Person"/>
<value id="0" value="Not employed"/>
<value id="7" value="Retired"/>
<value id="3" value="Self employed"/>
<value id="5" value="Student"/>
<value id="4" value="Worker"/>
<value id="1" value="Other"/>
</selection>
<text text="What is your occupational status?" error="false"/>
</question>
<question catyID="135" id="X_1#_101#3_863_135" order="3" cotyID="12">
<numberInput maxVal="999999999" mandatory="true" id="135" maxNumberDecimals="0" minVal="0" error="false" editable="true">
<value id="1261" value="30000"/>
<unit name="£/Year" id="1"/>
</numberInput>
<text text="What is your annual income?" error="false"/>
</question>
<question catyID="72" id="X_1#_102#3_72" order="4" cotyID="27">
<selection mandatory="true" id="72" editable="true" name="occupational_hazards_x (y/n)" error="false">
<value selected="true" id="0" value="No"/>
<value id="1" value="Yes"/>
</selection>
<text text="Does your job involve hazardous duties?" error="false"/>
</question>
<question catyID="311" id="X_1#_103#3_311" order="5" cotyID="27">
<selection mandatory="true" id="311" editable="true" name="pursuit_x (y/n)" error="false">
<value selected="true" id="0" value="No"/>
<value id="1" value="Yes"/>
</selection>
<text text="Have you any intention to participate in any hazardous sport or leisure activity,&cr; for example Aviation, Caving/Potholing, Climbing, Diving, Horse-riding, Motorsports, Mountaineering, Yachting?" error="false"/>
</question>
<question catyID="267" id="X_1#_104#3_267" order="6" cotyID="27">
<selection mandatory="true" id="267" editable="true" name="foreign_travel_x (y/n)" error="false">
<value selected="true" id="0" value="No"/>
<value id="1" value="Yes"/>
</selection>
<text text="Other than holidays of less than 3 months, have you any intention of going outside&cr; UK, Channel Islands or Isle of Man?" error="false"/>
</question>
</item>
</person>
</screen>POST /checkCompleteness
This command is used when an existing case (an input interface) should be checked for completeness regarding a specific SourceType. “Completeness” in the sense that all mandatory fields have been answered and all plausibility rules have been satisfied. This can be used when technical data has changed, and before starting a new capture cycle you want to check whether it is required at all.
Note: Errors are noted in the errorDescriptions of the result JSON-Map
| Path | Type | Description |
|---|---|---|
|
|
the language of the capturing |
|
|
the used sourceType |
|
|
The id of the used case |
|
|
The subsystem id of the used case |
|
|
SB1='false'; SB2='true' |
|
|
0 |
| Path | Type | Description |
|---|---|---|
|
|
API call path |
|
|
If call is completed successfully, then status is set to 0, otherwise it is set to 'WARNING'(=1) or 'OPERATION FAILED'(=2) or 'FATAL ERROR'(=3) |
|
|
Tf call is completed successfully, then status is set to 'OK', otherwise it is set to 'WARNING' or 'OPERATION FAILED' or 'FATAL ERROR' |
|
|
List of errorDescriptions in a JSON response |
|
|
Empty on this call |
|
|
Empty on this call |
|
|
Empty on this call |
sample request
POST /checkCompleteness HTTP/1.1
Content-Type: application/json;charset=UTF-8
Content-Length: 145
Host: localhost:8080
{
"language" : "en",
"sourceType" : 5,
"groupScreens" : false,
"caseId" : "TestCase",
"subId" : "Demo",
"loggingArea" : null
}sample response
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 183
{
"path" : "/checkCompleteness",
"status" : 0,
"statusText" : "OK",
"errorDescriptions" : [ ],
"jsonContent" : null,
"byteContent" : null,
"textContent" : null
}POST /checkCompletenessXML
This command is used when an existing case (an input interface) should be checked for completeness regarding a specific SourceType. “Completeness” in the sense that all mandatory fields have been answered and all plausibility rules have been satisfied. This can be used when technical data has changed, and before starting a new capture cycle you want to check whether it is required at all. (XML-Version)
Note: Errors are noted in an operationResult with errors in the XML-String
| Path | Type | Description |
|---|---|---|
|
|
the language of the capturing |
|
|
the used sourceType |
|
|
The id of the used case |
|
|
The subsystem id of the used case |
|
|
0 |
|
|
SB1='false'; SB2='true' |
| Path | Type | Description |
|---|---|---|
|
|
The returned OperationResult for this operation by COMPASS. It is in form of an XML string. |
sample request
POST /checkCompletenessXML HTTP/1.1
Content-Type: application/json;charset=UTF-8
Content-Length: 145
Host: localhost:8080
{
"language" : "en",
"sourceType" : 5,
"groupScreens" : false,
"caseId" : "TestCase",
"subId" : "Demo",
"loggingArea" : null
}sample response
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/xml;charset=UTF-8
Content-Length: 75
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
<?xml version="1.0" encoding="UTF-8"?>
<operationResult returnCode="0"/>GET /getHashForCase
Returns an SHA3-256-Hash for URL and parameters to secure URL against manipulation
Note: Errors are noted in the errorDescriptions of the result JSON-Map
| Parameter | Description |
|---|---|
|
The subsystem id of the used case |
|
The id of the used case |
|
Id of the SourceType |
|
The timestamp until therequest is validp |
| Path | Type | Description |
|---|---|---|
|
|
API call path |
|
|
If call is completed successfully, then status is set to 0, otherwise it is set to 'WARNING'(=1) or 'OPERATION FAILED'(=2) or 'FATAL ERROR'(=3) |
|
|
Tf call is completed successfully, then status is set to 'OK', otherwise it is set to 'WARNING' or 'OPERATION FAILED' or 'FATAL ERROR' |
|
|
List of errorDescriptions in a JSON response |
|
|
hashValue |
|
|
Empty on this call |
|
|
Empty on this call |
sample request
GET /getHashForCase?subId=Demo&caseId=TestCase&srctype=4×tamp=2023-11-02T18%3A35%3A37.499357900Z HTTP/1.1
Content-Type: application/json;charset=UTF-8
Host: localhost:8080sample response
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 263
{
"path" : "/getHashForCase",
"status" : 0,
"statusText" : "OK",
"errorDescriptions" : [ ],
"jsonContent" : {
"Hash" : "685dcd0ebffe48f19e84adafabd1c6d45a3070b4b21220208a8a563ad3000c91"
},
"byteContent" : null,
"textContent" : null
}Result manipulation API
When a case with its screens is fully captured the case can be assessed and the result can be transferred to the calling system. Optionally, the result converted to the simpler NIResult-Format.
GET /assessment
This command is used when an existing case shall be assessed by COMPASS
Note: Errors are noted in the errorDescriptions of the result JSON-Map
| Parameter | Description |
|---|---|
|
the caseId of the case to assesss |
|
the subId of the case to assesss |
|
the lamguage of the case to assesss |
|
the loggingArea |
| Path | Type | Description |
|---|---|---|
|
|
API call path |
|
|
If call is completed successfully, then status is set to 0, otherwise it is set to 'WARNING'(=1) or 'OPERATION FAILED'(=2) or 'FATAL ERROR'(=3) |
|
|
Tf call is completed successfully, then status is set to 'OK', otherwise it is set to 'WARNING' or 'OPERATION FAILED' or 'FATAL ERROR' |
|
|
List of errorDescriptions in a JSON response |
|
|
Empty on this call |
|
|
Empty on this call |
|
|
Empty on this call |
sample request
GET /assessment?caseId=TestCase&subId=Demo&language=en&loggingArea=0 HTTP/1.1
Host: localhost:8080sample response
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 175
{
"path" : "/assessment",
"status" : 0,
"statusText" : "OK",
"errorDescriptions" : [ ],
"jsonContent" : { },
"byteContent" : null,
"textContent" : null
}GET /assessmentXML
This command is used when an existing case shall be assessed by COMPASS (XML-Version)
Note: Errors are noted in an operationResult with errors in the XML-String
| Parameter | Description |
|---|---|
|
the caseId of the case to assesss |
|
the subId of the case to assesss |
|
the language of the case to assesss |
|
the loggingArea |
| Path | Type | Description |
|---|---|---|
|
|
The returned OperationResult for this operation by COMPASS. It is in form of an XML string. |
sample request
GET /assessmentXML?caseId=TestCase&subId=Demo&language=en&loggingArea=0 HTTP/1.1
Host: localhost:8080sample response
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/xml;charset=UTF-8
Content-Length: 220
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
<?xml version="1.0" encoding="UTF-8"?>
<operationResult returnCode="0">
<resultDestinationReference>
<databaseReference subId="Demo" id="TestCase"/>
</resultDestinationReference>
</operationResult>GET /transferResultFromDB
Gets the JSON-Result from the result Database
Note: Errors are noted in the errorDescriptions of the result JSON-Map
| Parameter | Description |
|---|---|
|
the caseId of the result to transfer |
|
the caseId of the result to transfer |
|
the language of the case |
| Path | Type | Description |
|---|---|---|
|
|
API call path |
|
|
If call is completed successfully, then status is set to 0, otherwise it is set to 'WARNING'(=1) or 'OPERATION FAILED'(=2) or 'FATAL ERROR'(=3) |
|
|
Tf call is completed successfully, then status is set to 'OK', otherwise it is set to 'WARNING' or 'OPERATION FAILED' or 'FATAL ERROR' |
|
|
List of errorDescriptions in a JSON response |
|
|
the result of the case |
|
|
Empty on this call |
|
|
Empty on this call |
sample request
GET /transferResultFromDB?caseId=TestCase&subId=Demo&language=en HTTP/1.1
Content-Type: application/json;charset=UTF-8
Host: localhost:8080sample response
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 8748
{
"path" : "/transferResultFromDB",
"status" : 0,
"statusText" : "OK",
"errorDescriptions" : [ ],
"jsonContent" : {
"VersionID" : 1085,
"Locale" : "en",
"CSP" : 0,
"ResultLevelId" : 1,
"CaseRisk" : [ {
"RiskTypeIdName" : "Overall risk",
"ResultLevelId" : 1,
"RiskTypeId" : 21,
"Id" : "01",
"ResultLevelIdName" : "standard"
}, {
"RiskTypeIdName" : "Application risk",
"ResultLevelId" : 1,
"RiskTypeId" : 24,
"Id" : "0101",
"ResultLevelIdName" : "standard"
}, {
"RiskTypeIdName" : "PH Risk",
"ResultLevelId" : 1,
"RiskTypeId" : 23,
"Id" : "0102",
"ResultLevelIdName" : "standard"
}, {
"RiskTypeIdName" : "AP risk",
"ResultLevelId" : 1,
"RiskTypeId" : 22,
"Id" : "0103",
"ResultLevelIdName" : "standard"
}, {
"RiskTypeIdName" : "Sum Needs assessment",
"ResultLevelId" : 1,
"CaseResult" : {
"ResultLevelId" : 1,
"CaseResultAttribute" : [ {
"ResultAttributeTypeId" : 0,
"AttributeValue" : {
"DBRefValue" : {
"Locale" : "en",
"Id" : 533,
"Name" : "amount applied for below need"
}
},
"ResultAttributeTypeIdName" : "text"
}, {
"ResultAttributeTypeId" : 3,
"AttributeValue" : {
"SingleValue" : {
"Value" : 420.0,
"UnitName" : "£/Month",
"Unit" : 3
}
},
"ResultAttributeTypeIdName" : "Annual benefit"
} ],
"Id" : 1,
"ResultTypeId" : 52,
"ResultLevelIdName" : "standard",
"ResultTypeIdName" : "hint with annual benefit"
},
"RiskTypeId" : 60,
"RiskText" : "Sum-Limit IP own/similar",
"Id" : "01030403",
"ResultLevelIdName" : "standard"
}, {
"RiskTypeIdName" : "Benefit risk",
"ResultLevelId" : 1,
"RiskTypeId" : 36,
"Id" : "0104",
"ResultLevelIdName" : "standard"
}, {
"RiskTypeIdName" : "Event risk",
"ResultLevelId" : 1,
"RiskTypeId" : 9,
"Id" : "010401",
"ResultLevelIdName" : "standard"
}, {
"RiskTypeIdName" : "Medical risk",
"ResultLevelId" : 1,
"RiskTypeId" : 25,
"Id" : "01040101",
"ResultLevelIdName" : "standard"
}, {
"RiskTypeIdName" : "Occupation risk",
"ResultLevelId" : 1,
"RiskTypeId" : 3,
"Id" : "01040102",
"ResultLevelIdName" : "standard"
}, {
"RiskTypeIdName" : "Non-Medical risk",
"ResultLevelId" : 1,
"RiskTypeId" : 13,
"Id" : "01040103",
"ResultLevelIdName" : "standard"
}, {
"RiskTypeIdName" : "Financial assessment",
"ResultLevelId" : 1,
"RiskTypeId" : 12,
"Id" : "01040104",
"ResultLevelIdName" : "standard"
}, {
"RiskTypeIdName" : "Financial POS inquiry",
"ResultLevelId" : 1,
"RiskTypeId" : 67,
"Id" : "01040105",
"ResultLevelIdName" : "standard"
} ],
"RiskCaseObjectRelation" : [ {
"To" : 0,
"From" : "01"
}, {
"To" : 0,
"From" : "0101"
}, {
"To" : 5,
"From" : "0102"
}, {
"To" : 0,
"From" : "0102"
}, {
"To" : 3,
"From" : "0103"
}, {
"To" : 0,
"From" : "0103"
}, {
"To" : 1002,
"From" : "01030403"
}, {
"To" : 0,
"From" : "01030403"
}, {
"To" : 3,
"From" : "01030403"
}, {
"To" : 6,
"From" : "0104"
}, {
"To" : 0,
"From" : "0104"
}, {
"To" : 3,
"From" : "010401"
}, {
"To" : 7,
"From" : "010401"
}, {
"To" : 0,
"From" : "010401"
}, {
"To" : 6,
"From" : "010401"
}, {
"To" : 3,
"From" : "01040101"
}, {
"To" : 7,
"From" : "01040101"
}, {
"To" : 0,
"From" : "01040101"
}, {
"To" : 6,
"From" : "01040101"
}, {
"To" : 3,
"From" : "01040102"
}, {
"To" : 7,
"From" : "01040102"
}, {
"To" : 0,
"From" : "01040102"
}, {
"To" : 6,
"From" : "01040102"
}, {
"To" : 3,
"From" : "01040103"
}, {
"To" : 7,
"From" : "01040103"
}, {
"To" : 0,
"From" : "01040103"
}, {
"To" : 6,
"From" : "01040103"
}, {
"To" : 3,
"From" : "01040104"
}, {
"To" : 7,
"From" : "01040104"
}, {
"To" : 0,
"From" : "01040104"
}, {
"To" : 6,
"From" : "01040104"
}, {
"To" : 3,
"From" : "01040105"
}, {
"To" : 7,
"From" : "01040105"
}, {
"To" : 0,
"From" : "01040105"
}, {
"To" : 6,
"From" : "01040105"
} ],
"NumberOfChangeAssessCycles" : 1,
"Benefit" : {
"TypeId" : 0,
"TypeIdName" : "Benefit",
"CaseAttribute" : [ {
"TypeId" : 11,
"TypeIdName" : "benefit-type",
"CaseAttributeValue" : {
"DBRefValue" : {
"Id" : 10,
"Name" : "IP own"
}
}
}, {
"TypeId" : 108,
"TypeIdName" : "name (benefit)",
"CaseAttributeValue" : {
"StringValue" : {
"Value" : "IP"
}
}
}, {
"TypeId" : 383,
"TypeIdName" : "DERIVED Benefit-type internal",
"CaseAttributeValue" : {
"DBRefValue" : {
"Id" : 10,
"Name" : "IP own"
}
}
} ],
"Id" : 6
},
"EventPayment" : {
"TypeId" : 1,
"TypeIdName" : "Insurance event payment",
"CaseAttribute" : {
"TypeId" : 161,
"TypeIdName" : "Eventtype",
"CaseAttributeValue" : {
"DBRefValue" : {
"Id" : 0,
"Name" : "Disability own/similar"
}
}
},
"Id" : 7
},
"CaseObject" : [ {
"TypeId" : 22,
"TypeIdName" : "DERIVED Benefitgroup Application",
"CaseAttribute" : {
"TypeId" : 770,
"TypeIdName" : "benefit group",
"CaseAttributeValue" : {
"DBRefValue" : {
"Id" : 7,
"Name" : "IP own/similar"
}
}
},
"Id" : 1002
}, {
"TypeId" : 25,
"TypeIdName" : "Application",
"CaseAttribute" : {
"TypeId" : 0,
"TypeIdName" : "application-ID",
"CaseAttributeValue" : {
"StringValue" : {
"Value" : "FS"
}
}
},
"Id" : 0
}, {
"TypeId" : 27,
"TypeIdName" : "AP",
"CaseAttribute" : [ {
"TypeId" : 307,
"TypeIdName" : "id_no (person)",
"CaseAttributeValue" : {
"StringValue" : {
"Value" : 1
}
}
}, {
"TypeId" : 44,
"TypeIdName" : "name",
"CaseAttributeValue" : {
"StringValue" : {
"Value" : "MEier"
}
}
}, {
"TypeId" : 61,
"TypeIdName" : "nationality",
"CaseAttributeValue" : {
"DBRefValue" : {
"Locale" : "en",
"Key" : "GB",
"Name" : "United Kingdom"
}
}
} ],
"Id" : 3
}, {
"Identifies" : 3,
"TypeId" : 28,
"TypeIdName" : "PH",
"CaseAttribute" : [ {
"TypeId" : 307,
"TypeIdName" : "id_no (person)",
"CaseAttributeValue" : {
"StringValue" : {
"Value" : 1
}
}
}, {
"TypeId" : 44,
"TypeIdName" : "name",
"CaseAttributeValue" : {
"StringValue" : {
"Value" : "MEier"
}
}
}, {
"TypeId" : 61,
"TypeIdName" : "nationality",
"CaseAttributeValue" : {
"DBRefValue" : {
"Locale" : "en",
"Key" : "GB",
"Name" : "United Kingdom"
}
}
} ],
"Id" : 5
} ],
"AssessmentDate" : 20231101193537,
"ResultLevelIdName" : "standard",
"NumberOfSourceChanges" : 89,
"PolicyCanBeIssued" : "Yes",
"VersionName" : "RuleManager UK 6.0 18.06.2020",
"Id" : "FS"
},
"byteContent" : null,
"textContent" : null
}GET /transferResultFromDBXML
GET the XML Result from the result DB (XML-Version)
Note: Errors are noted in an operationResult with errors in the XML-String
| Parameter | Description |
|---|---|
|
the caseId of the result to transfer |
|
the subId of the result to transfer |
|
the language of the case |
| Path | Type | Description |
|---|---|---|
|
|
The returned OperationResult for this operation by COMPASS. It is in form of an XML string. |
sample request
GET /transferResultFromDBXML?caseId=TestCase&subId=Demo&language=en HTTP/1.1
Host: localhost:8080sample response
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/xml;charset=UTF-8
Content-Length: 12660
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
<?xml version="1.0" encoding="UTF-8"?>
<operationResult returnCode="0">
<resultDestinationReference>
<directResultReference>
<Result ResultLevelIdName="standard" NumberOfChangeAssessCycles="1" PolicyCanBeIssued="Yes" VersionName="RuleManager UK 6.0 18.06.2020" CSP="0" AssessmentDate="20231101193537" Id="FS" VersionID="1085" Locale="en" ResultLevelId="1" NumberOfSourceChanges="89">
<CaseObject Id="1002" TypeId="22" TypeIdName="DERIVED Benefitgroup Application">
<CaseAttribute TypeId="770" TypeIdName="benefit group">
<CaseAttributeValue>
<DBRefValue Name="IP own/similar" Id="7"/>
</CaseAttributeValue>
</CaseAttribute>
</CaseObject>
<CaseObject Id="0" TypeId="25" TypeIdName="Application">
<CaseAttribute TypeId="0" TypeIdName="application-ID">
<CaseAttributeValue>
<StringValue Value="FS"/>
</CaseAttributeValue>
</CaseAttribute>
</CaseObject>
<CaseObject Id="3" TypeId="27" TypeIdName="AP">
<CaseAttribute TypeId="307" TypeIdName="id_no (person)">
<CaseAttributeValue>
<StringValue Value="1"/>
</CaseAttributeValue>
</CaseAttribute>
<CaseAttribute TypeId="44" TypeIdName="name">
<CaseAttributeValue>
<StringValue Value="MEier"/>
</CaseAttributeValue>
</CaseAttribute>
<CaseAttribute TypeId="61" TypeIdName="nationality">
<CaseAttributeValue>
<DBRefValue Name="United Kingdom" Key="GB" Locale="en"/>
</CaseAttributeValue>
</CaseAttribute>
</CaseObject>
<CaseObject TypeIdName="PH" Id="5" TypeId="28" Identifies="3">
<CaseAttribute TypeId="307" TypeIdName="id_no (person)">
<CaseAttributeValue>
<StringValue Value="1"/>
</CaseAttributeValue>
</CaseAttribute>
<CaseAttribute TypeId="44" TypeIdName="name">
<CaseAttributeValue>
<StringValue Value="MEier"/>
</CaseAttributeValue>
</CaseAttribute>
<CaseAttribute TypeId="61" TypeIdName="nationality">
<CaseAttributeValue>
<DBRefValue Name="United Kingdom" Key="GB" Locale="en"/>
</CaseAttributeValue>
</CaseAttribute>
</CaseObject>
<Benefit Id="6" TypeId="0" TypeIdName="Benefit">
<CaseAttribute TypeId="11" TypeIdName="benefit-type">
<CaseAttributeValue>
<DBRefValue Name="IP own" Id="10"/>
</CaseAttributeValue>
</CaseAttribute>
<CaseAttribute TypeId="108" TypeIdName="name (benefit)">
<CaseAttributeValue>
<StringValue Value="IP"/>
</CaseAttributeValue>
</CaseAttribute>
<CaseAttribute TypeId="383" TypeIdName="DERIVED Benefit-type internal">
<CaseAttributeValue>
<DBRefValue Name="IP own" Id="10"/>
</CaseAttributeValue>
</CaseAttribute>
</Benefit>
<EventPayment Id="7" TypeId="1" TypeIdName="Insurance event payment">
<CaseAttribute TypeId="161" TypeIdName="Eventtype">
<CaseAttributeValue>
<DBRefValue Name="Disability own/similar" Id="0"/>
</CaseAttributeValue>
</CaseAttribute>
</EventPayment>
<CaseRisk RiskTypeIdName="Overall risk" ResultLevelIdName="standard" RiskTypeId="21" Id="01" ResultLevelId="1"/>
<RiskCaseObjectRelation To="0" From="01"/>
<CaseRisk RiskTypeIdName="Application risk" ResultLevelIdName="standard" RiskTypeId="24" Id="0101" ResultLevelId="1"/>
<RiskCaseObjectRelation To="0" From="0101"/>
<CaseRisk RiskTypeIdName="PH Risk" ResultLevelIdName="standard" RiskTypeId="23" Id="0102" ResultLevelId="1"/>
<RiskCaseObjectRelation To="5" From="0102"/>
<RiskCaseObjectRelation To="0" From="0102"/>
<CaseRisk RiskTypeIdName="AP risk" ResultLevelIdName="standard" RiskTypeId="22" Id="0103" ResultLevelId="1"/>
<RiskCaseObjectRelation To="3" From="0103"/>
<RiskCaseObjectRelation To="0" From="0103"/>
<CaseRisk RiskText="Sum-Limit IP own/similar" RiskTypeIdName="Sum Needs assessment" ResultLevelIdName="standard" RiskTypeId="60" Id="01030403" ResultLevelId="1">
<CaseResult ResultLevelIdName="standard" ResultTypeIdName="hint with annual benefit" Id="1" ResultLevelId="1" ResultTypeId="52">
<CaseResultAttribute ResultAttributeTypeIdName="text" ResultAttributeTypeId="0">
<AttributeValue>
<DBRefValue Name="amount applied for below need" Id="533" Locale="en"/>
</AttributeValue>
</CaseResultAttribute>
<CaseResultAttribute ResultAttributeTypeIdName="Annual benefit" ResultAttributeTypeId="3">
<AttributeValue>
<SingleValue UnitName="£/Month" Value="420.0" Unit="3"/>
</AttributeValue>
</CaseResultAttribute>
</CaseResult>
</CaseRisk>
<RiskCaseObjectRelation To="1002" From="01030403"/>
<RiskCaseObjectRelation To="0" From="01030403"/>
<RiskCaseObjectRelation To="3" From="01030403"/>
<CaseRisk RiskTypeIdName="Benefit risk" ResultLevelIdName="standard" RiskTypeId="36" Id="0104" ResultLevelId="1"/>
<RiskCaseObjectRelation To="6" From="0104"/>
<RiskCaseObjectRelation To="0" From="0104"/>
<CaseRisk RiskTypeIdName="Event risk" ResultLevelIdName="standard" RiskTypeId="9" Id="010401" ResultLevelId="1"/>
<RiskCaseObjectRelation To="3" From="010401"/>
<RiskCaseObjectRelation To="7" From="010401"/>
<RiskCaseObjectRelation To="0" From="010401"/>
<RiskCaseObjectRelation To="6" From="010401"/>
<CaseRisk RiskTypeIdName="Medical risk" ResultLevelIdName="standard" RiskTypeId="25" Id="01040101" ResultLevelId="1"/>
<RiskCaseObjectRelation To="3" From="01040101"/>
<RiskCaseObjectRelation To="7" From="01040101"/>
<RiskCaseObjectRelation To="0" From="01040101"/>
<RiskCaseObjectRelation To="6" From="01040101"/>
<CaseRisk RiskTypeIdName="Occupation risk" ResultLevelIdName="standard" RiskTypeId="3" Id="01040102" ResultLevelId="1"/>
<RiskCaseObjectRelation To="3" From="01040102"/>
<RiskCaseObjectRelation To="7" From="01040102"/>
<RiskCaseObjectRelation To="0" From="01040102"/>
<RiskCaseObjectRelation To="6" From="01040102"/>
<CaseRisk RiskTypeIdName="Non-Medical risk" ResultLevelIdName="standard" RiskTypeId="13" Id="01040103" ResultLevelId="1"/>
<RiskCaseObjectRelation To="3" From="01040103"/>
<RiskCaseObjectRelation To="7" From="01040103"/>
<RiskCaseObjectRelation To="0" From="01040103"/>
<RiskCaseObjectRelation To="6" From="01040103"/>
<CaseRisk RiskTypeIdName="Financial assessment" ResultLevelIdName="standard" RiskTypeId="12" Id="01040104" ResultLevelId="1"/>
<RiskCaseObjectRelation To="3" From="01040104"/>
<RiskCaseObjectRelation To="7" From="01040104"/>
<RiskCaseObjectRelation To="0" From="01040104"/>
<RiskCaseObjectRelation To="6" From="01040104"/>
<CaseRisk RiskTypeIdName="Financial POS inquiry" ResultLevelIdName="standard" RiskTypeId="67" Id="01040105" ResultLevelId="1"/>
<RiskCaseObjectRelation To="3" From="01040105"/>
<RiskCaseObjectRelation To="7" From="01040105"/>
<RiskCaseObjectRelation To="0" From="01040105"/>
<RiskCaseObjectRelation To="6" From="01040105"/>
</Result>
</directResultReference>
</resultDestinationReference>
</operationResult>GET /deleteResult
This command is used when an existing Output/Result Interface should be removed (deleted) from the database.
Note: Errors are noted in the errorDescriptions of the result JSON-Map
| Parameter | Description |
|---|---|
|
the caseId of the result to delete |
|
the subId of the result to delete |
|
the loggingArea |
| Path | Type | Description |
|---|---|---|
|
|
API call path |
|
|
If call is completed successfully, then status is set to 0, otherwise it is set to 'WARNING'(=1) or 'OPERATION FAILED'(=2) or 'FATAL ERROR'(=3) |
|
|
Tf call is completed successfully, then status is set to 'OK', otherwise it is set to 'WARNING' or 'OPERATION FAILED' or 'FATAL ERROR' |
|
|
List of errorDescriptions in a JSON response |
|
|
Empty on this call |
|
|
Empty on this call |
|
|
Empty on this call |
sample request
GET /deleteResult?caseId=TestCase&subId=Demo&loggingArea=0 HTTP/1.1
Host: localhost:8080sample response
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 177
{
"path" : "/deleteResult",
"status" : 0,
"statusText" : "OK",
"errorDescriptions" : [ ],
"jsonContent" : { },
"byteContent" : null,
"textContent" : null
}GET /deleteResultXML
This command is used when an existing Output/Result Interface should be removed (deleted) from the database. (XML-Version)
Note: Errors are noted in an operationResult with errors in the XML-String
| Parameter | Description |
|---|---|
|
the caseId of the result to delete |
|
the subId of the result to delete |
|
the loggingArea |
| Path | Type | Description |
|---|---|---|
|
|
The returned OperationResult for this operation by COMPASS. It is in form of an XML string. |
sample request
GET /deleteResultXML?caseId=TestCase&subId=Demo&loggingArea=0 HTTP/1.1
Host: localhost:8080sample response
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/xml;charset=UTF-8
Content-Length: 75
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
<?xml version="1.0" encoding="UTF-8"?>
<operationResult returnCode="0"/>GET /convertResult
This command is used when an existing Result Interface should be converted to the format NIResult. The converted NIResult as a JSON-Map is returned.
Note: Errors are noted in the errorDescriptions of the result JSON-Map
| Parameter | Description |
|---|---|
|
the caseId of the result to convert |
|
the subId of the result to convert |
|
loggingArea |
| Path | Type | Description |
|---|---|---|
|
|
API call path |
|
|
If call is completed successfully, then status is set to 0, otherwise it is set to 'WARNING'(=1) or 'OPERATION FAILED'(=2) or 'FATAL ERROR'(=3) |
|
|
Tf call is completed successfully, then status is set to 'OK', otherwise it is set to 'WARNING' or 'OPERATION FAILED' or 'FATAL ERROR' |
|
|
List of errorDescriptions in a JSON response |
|
|
the result in the NIResult representation |
|
|
Empty on this call |
|
|
Empty on this call |
sample request
GET /convertResult?caseId=TestCase&subId=Demo&loggingArea=0 HTTP/1.1
Host: localhost:8080sample response
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 5836
{
"path" : "/convertResult",
"status" : 0,
"statusText" : "OK",
"errorDescriptions" : [ ],
"jsonContent" : {
"NIResult" : {
"csp" : 1,
"assessmentDate" : "2023-11-01T19:35:33+01:00",
"resultLevelId" : 1,
"numberOfSourceChanges" : 89,
"locale" : "en",
"versionName" : "RuleManager UK 6.0 18.06.2020",
"numberOfChangeAssessCycles" : 1,
"versionID" : 1085,
"resultLevelIdName" : "standard",
"application" : {
"typeIdName" : "Application",
"resultLevelIdName" : "standard",
"resultLevelId" : 1,
"caseAttribute" : {
"typeIdName" : "application-ID",
"typeId" : 0,
"value" : "FS"
},
"person" : {
"resultLevelIdName" : "standard",
"resultLevelId" : 1,
"caseAttribute" : [ {
"typeIdName" : "name",
"typeId" : 44,
"value" : "MEier"
}, {
"typeIdName" : "id_no (person)",
"typeId" : 307,
"value" : 1
}, {
"typeIdName" : "nationality",
"typeId" : 61,
"locale" : "en",
"value" : "United Kingdom",
"key" : "GB"
} ],
"caseObject" : {
"typeIdName" : "DERIVED Benefitgroup Application",
"caseAttribute" : {
"typeIdName" : "benefit group",
"typeId" : 770,
"id" : 7,
"value" : "IP own/similar"
},
"typeId" : 22,
"caseRisk" : {
"riskText" : "Sum-Limit IP own/similar",
"resultLevelIdName" : "standard",
"resultLevelId" : 1,
"riskTypeId" : 60,
"riskTypeIdName" : "Sum Needs assessment",
"caseResult" : {
"resultAttribute" : [ {
"typeIdName" : "text",
"typeId" : 0,
"id" : 533,
"locale" : "en",
"value" : "amount applied for below need"
}, {
"typeIdName" : "Annual benefit",
"unit" : 3,
"unitName" : "£/Month",
"typeId" : 3,
"value" : 420.0
} ],
"resultLevelIdName" : "standard",
"resultTypeId" : 52,
"resultTypeIdName" : "hint with annual benefit",
"resultLevelId" : 1,
"id" : 1
},
"id" : "01030403"
}
},
"tariff" : {
"typeIdName" : "Benefit",
"caseAttribute" : [ {
"typeIdName" : "benefit-type",
"typeId" : 11,
"id" : 10,
"value" : "IP own"
}, {
"typeIdName" : "DERIVED Benefit-type internal",
"typeId" : 383,
"id" : 10,
"value" : "IP own"
}, {
"typeIdName" : "Eventtype",
"typeId" : 161,
"id" : 0,
"value" : "Disability own/similar"
}, {
"typeIdName" : "name (benefit)",
"typeId" : 108,
"value" : "IP"
} ],
"typeId" : 0,
"caseRisk" : [ {
"resultLevelIdName" : "standard",
"resultLevelId" : 1,
"riskTypeId" : 12,
"riskTypeIdName" : "Financial assessment",
"id" : "01040104"
}, {
"resultLevelIdName" : "standard",
"resultLevelId" : 1,
"riskTypeId" : 67,
"riskTypeIdName" : "Financial POS inquiry",
"id" : "01040105"
}, {
"resultLevelIdName" : "standard",
"resultLevelId" : 1,
"riskTypeId" : 3,
"riskTypeIdName" : "Occupation risk",
"id" : "01040102"
}, {
"resultLevelIdName" : "standard",
"resultLevelId" : 1,
"riskTypeId" : 25,
"riskTypeIdName" : "Medical risk",
"id" : "01040101"
}, {
"resultLevelIdName" : "standard",
"resultLevelId" : 1,
"riskTypeId" : 13,
"riskTypeIdName" : "Non-Medical risk",
"id" : "01040103"
}, {
"resultLevelIdName" : "standard",
"resultLevelId" : 1,
"riskTypeId" : 36,
"riskTypeIdName" : "Benefit risk",
"id" : "0104"
} ]
},
"caseRisk" : [ {
"resultLevelIdName" : "standard",
"resultLevelId" : 1,
"riskTypeId" : 23,
"riskTypeIdName" : "PH Risk",
"id" : "0102"
}, {
"resultLevelIdName" : "standard",
"resultLevelId" : 1,
"riskTypeId" : 22,
"riskTypeIdName" : "AP risk",
"id" : "0103"
} ],
"type" : "PH-AP"
},
"typeId" : 25,
"caseRisk" : {
"resultLevelIdName" : "standard",
"resultLevelId" : 1,
"riskTypeId" : 24,
"riskTypeIdName" : "Application risk",
"id" : "0101"
}
},
"id" : "FS",
"caseRisk" : {
"resultLevelIdName" : "standard",
"resultLevelId" : 1,
"riskTypeId" : 21,
"riskTypeIdName" : "Overall risk",
"id" : "01"
},
"policyCanBeIssued" : true
}
},
"byteContent" : null,
"textContent" : null
}GET /convertResultXML
This command is used when an existing Result Interface should be converted to the format NIResult. The converted NIResult as a XML-String is returned. (XML-Version)
Note: Errors are noted in an operationResult with errors in the XML-String
| Parameter | Description |
|---|---|
|
the caseId of the result to convert |
|
the subId of the result to convert |
|
the loggingArea |
| Path | Type | Description |
|---|---|---|
|
|
The returned OperationResult for this operation by COMPASS. It is in form of an XML string. |
sample request
GET /convertResultXML?caseId=TestCase&subId=Demo&loggingArea=0 HTTP/1.1
Host: localhost:8080sample response
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/xml;charset=UTF-8
Content-Length: 4171
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
<?xml version="1.0" encoding="UTF-8"?>
<operationResult returnCode="0">
<resultDestinationReference>
<directResultReference>
<NIResult assessmentDate="2023-11-01T19:35:33+01:00" csp="1" id="FS" locale="en" numberOfChangeAssessCycles="1" numberOfSourceChanges="89" policyCanBeIssued="true" resultLevelId="1" resultLevelIdName="standard" versionID="1085" versionName="RuleManager UK 6.0 18.06.2020">
<application resultLevelId="1" resultLevelIdName="standard" typeId="25" typeIdName="Application">
<caseAttribute typeId="0" typeIdName="application-ID" value="FS"/>
<person type="PH-AP" resultLevelId="1" resultLevelIdName="standard">
<caseAttribute typeId="44" typeIdName="name" value="MEier"/>
<caseAttribute typeId="307" typeIdName="id_no (person)" value="1"/>
<caseAttribute key="GB" locale="en" typeId="61" typeIdName="nationality" value="United Kingdom"/>
<tariff typeId="0" typeIdName="Benefit">
<caseAttribute id="10" typeId="11" typeIdName="benefit-type" value="IP own"/>
<caseAttribute id="10" typeId="383" typeIdName="DERIVED Benefit-type internal" value="IP own"/>
<caseAttribute id="0" typeId="161" typeIdName="Eventtype" value="Disability own/similar"/>
<caseAttribute typeId="108" typeIdName="name (benefit)" value="IP"/>
<caseRisk id="01040105" resultLevelId="1" resultLevelIdName="standard" riskTypeId="67" riskTypeIdName="Financial POS inquiry"/>
<caseRisk id="01040103" resultLevelId="1" resultLevelIdName="standard" riskTypeId="13" riskTypeIdName="Non-Medical risk"/>
<caseRisk id="01040104" resultLevelId="1" resultLevelIdName="standard" riskTypeId="12" riskTypeIdName="Financial assessment"/>
<caseRisk id="01040101" resultLevelId="1" resultLevelIdName="standard" riskTypeId="25" riskTypeIdName="Medical risk"/>
<caseRisk id="01040102" resultLevelId="1" resultLevelIdName="standard" riskTypeId="3" riskTypeIdName="Occupation risk"/>
<caseRisk id="0104" resultLevelId="1" resultLevelIdName="standard" riskTypeId="36" riskTypeIdName="Benefit risk"/>
</tariff>
<caseObject typeId="22" typeIdName="DERIVED Benefitgroup Application">
<caseAttribute id="7" typeId="770" typeIdName="benefit group" value="IP own/similar"/>
<caseRisk id="01030403" resultLevelId="1" resultLevelIdName="standard" riskText="Sum-Limit IP own/similar" riskTypeId="60" riskTypeIdName="Sum Needs assessment">
<caseResult id="1" resultLevelId="1" resultLevelIdName="standard" resultTypeId="52" resultTypeIdName="hint with annual benefit">
<resultAttribute id="533" locale="en" typeId="0" typeIdName="text" value="amount applied for below need"/>
<resultAttribute typeId="3" typeIdName="Annual benefit" unit="3" unitName="£/Month" value="420.0"/>
</caseResult>
</caseRisk>
</caseObject>
<caseRisk id="0103" resultLevelId="1" resultLevelIdName="standard" riskTypeId="22" riskTypeIdName="AP risk"/>
<caseRisk id="0102" resultLevelId="1" resultLevelIdName="standard" riskTypeId="23" riskTypeIdName="PH Risk"/>
</person>
<caseRisk id="0101" resultLevelId="1" resultLevelIdName="standard" riskTypeId="24" riskTypeIdName="Application risk"/>
</application>
<caseRisk id="01" resultLevelId="1" resultLevelIdName="standard" riskTypeId="21" riskTypeIdName="Overall risk"/>
</NIResult>
</directResultReference>
</resultDestinationReference>
</operationResult>Printing API
The printing API is used to print the application or the result for further use
POST /printApplication
Print the application Form in XML, HTML or PDF
Note: Errors are noted in the errorDescriptions of the result JSON-Map
| Path | Type | Description |
|---|---|---|
|
|
the language of the capturing |
|
|
the used sourceType |
|
|
The id of the used case |
|
|
The subsystem id of the used case |
|
|
SB1='false'; SB2='true' |
|
|
SB1 use 'PDF' 'XML' or 'HTML'; SB2 use 'XML' or 'PDF' |
|
|
the loggingArea |
| Path | Type | Description |
|---|---|---|
|
|
API call path |
|
|
If call is completed successfully, then status is set to 0, otherwise it is set to 'WARNING'(=1) or 'OPERATION FAILED'(=2) or 'FATAL ERROR'(=3) |
|
|
Tf call is completed successfully, then status is set to 'OK', otherwise it is set to 'WARNING' or 'OPERATION FAILED' or 'FATAL ERROR' |
|
|
List of errorDescriptions in a JSON response |
|
|
Empty on this call |
|
|
if the textType is 'PDF' the byteContent is a base64 encoding of the resulting PDF |
|
|
if the textType is 'XML' or 'HTML' the textContent is resulting 'XML' or 'HTML' |
sample request
POST /printApplication HTTP/1.1
Content-Type: application/json;charset=UTF-8
Content-Length: 161
Host: localhost:8080
{
"caseId" : "TestCase",
"subId" : "Demo",
"sourceType" : 5,
"group" : false,
"language" : "en",
"textType" : "HTML",
"loggingArea" : "0"
}sample response
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 16232
{
"path" : "/printApplication",
"status" : 0,
"statusText" : "OK",
"errorDescriptions" : [ ],
"jsonContent" : null,
"byteContent" : null,
"textContent" : "<html>\r\n <head>\r\n <META content=\"text/html; charset=UNICODE\" http-equiv=\"Content-Type\">\r\n <meta content=\"text/html;charset=Unicode\" http-equiv=\"Content-Type\">\r\n <title>\r\n\t\t\t\t\tCompass - CasePrint\r\n\t\t\t\t</title>\r\n </head>\r\n <body>\r\n <ul style=\"list-style-type:none; color:red; font-weight:bold;font-family:Arial Unicode MS,Wide Latin;font-size:small\">\r\n <h2>Application FS</h2>\r\n <li>\r\n <table border=\"0\">\r\n <tr>\r\n <td>\r\n <ul style=\"list-style-type:none; color:red; font-weight:bold;font-family:Arial Unicode MS,Wide Latin;font-size:small\">\r\n <h2>AP MEier</h2>\r\n <li>\r\n <table border=\"0\">\r\n <tr>\r\n <td>\r\n <table xmlns:xalan=\"http://xml.apache.org/xslt\">\r\n <tr>\r\n <td valign=\"top\">\r\n <table>\r\n <td align=\"left\" valign=\"top\">\r\n <table border=\"0\" cellpadding=\"0\" cellspacing=\"0\" height=\"0%\" rules=\"none\" width=\"100%\">\r\n <tr valign=\"top\">\r\n <td align=\"left\" valign=\"top\">\r\n <table border=\"0\" cellpadding=\"0\" cellspacing=\"0\" height=\"0%\" rules=\"none\" width=\"100%\">\r\n <tr valign=\"top\">\r\n <td align=\"left\" valign=\"top\">\r\n <table border=\"0\" cellpadding=\"0\" cellspacing=\"0\" height=\"0%\" rules=\"none\" width=\"100%\">\r\n <tr valign=\"top\">\r\n <td align=\"left\" valign=\"middle\">What is your current occupation?</td>\r\n </tr>\r\n <tr valign=\"top\">\r\n <td align=\"left\" valign=\"top\">\r\n\t\t\t\t\t\t\r\n\t\t\t\t\t\t\t\r\n\t\t\t\t\t\t\t\r\n\t\t\t\t\t\t\r\n\t\t\t\t\t\t<input class=\"inputFieldsStd\" disabled=\"true\" name=\"_2#2972\" readonly=\"yes\" size=\"40\" type=\"text\" value=\"Bank clerk\">\r\n\t\t\t\t\t</td>\r\n </tr>\r\n <tr valign=\"top\">\r\n <td align=\"left\" valign=\"middle\">What is your occupational status?</td>\r\n </tr>\r\n <tr valign=\"top\">\r\n <td align=\"left\" valign=\"middle\">\r\n\t\t\t\t\t\t\r\n\t\t\t\t\t\t\t\r\n\t\t\t\t\t\t\t\r\n\t\t\t\t\t\t\r\n\t\t\t\t\t\t<select class=\"inputFieldsStd\" disabled=\"true\" name=\"_3##s\" size=\"1\">\r\n\t\t\t\t\t\t\t\r\n\t\t\t\t\t\t\t\r\n\t\t\t\t\t\t\t<option>Apprentice</option>\r\n\t\t\t\t\t\t\t<option>Civil Servant</option>\r\n\t\t\t\t\t\t\t<option selected=\"true\">Employee</option>\r\n\t\t\t\t\t\t\t<option>House Person</option>\r\n\t\t\t\t\t\t\t<option>Not employed</option>\r\n\t\t\t\t\t\t\t<option>Retired</option>\r\n\t\t\t\t\t\t\t<option>Self employed</option>\r\n\t\t\t\t\t\t\t<option>Student</option>\r\n\t\t\t\t\t\t\t<option>Worker</option>\r\n\t\t\t\t\t\t\t<option>Other</option>\r\n\t\t\t\t\t\t</select>\r\n\t\t\t\t\t</td>\r\n </tr>\r\n <tr valign=\"top\"></tr>\r\n </table>\r\n </td>\r\n </tr>\r\n <tr valign=\"top\"></tr>\r\n </table>\r\n </td>\r\n </tr>\r\n <tr valign=\"top\"></tr>\r\n </table>\r\n </td>\r\n </table>\r\n </td>\r\n </tr>\r\n </table>\r\n <table>\r\n <tr>\r\n <td valign=\"top\">\r\n <table>\r\n <td align=\"left\" valign=\"top\">\r\n <table border=\"0\" cellpadding=\"0\" cellspacing=\"0\" height=\"0%\" rules=\"none\" width=\"100%\">\r\n <tr valign=\"top\">\r\n <td align=\"left\" valign=\"top\">\r\n <table border=\"0\" cellpadding=\"0\" cellspacing=\"0\" height=\"0%\" rules=\"none\" width=\"100%\">\r\n <tr valign=\"top\">\r\n <td align=\"left\" valign=\"top\">\r\n <table border=\"0\" cellpadding=\"0\" cellspacing=\"0\" height=\"0%\" rules=\"none\" width=\"100%\">\r\n <tr valign=\"top\">\r\n <td align=\"left\" valign=\"middle\">What is your annual income?</td><td align=\"left\" valign=\"middle\">\r\n\t\t\t\t\t\t\r\n\t\t\t\t\t\t\t\r\n\t\t\t\t\t\t\t\r\n\t\t\t\t\t\t\r\n\t\t\t\t\t\t<input class=\"inputFieldsStd\" disabled=\"true\" maxlength=\"8\" name=\"_7#135\" readonly=\"false\" size=\"8\" type=\"text\" value=\"30000\"> £/Year <input name=\"_7##u\" type=\"hidden\" value=\"1\">\r\n\t\t\t\t\t</td>\r\n </tr>\r\n <tr valign=\"top\"></tr>\r\n </table>\r\n </td>\r\n </tr>\r\n <tr valign=\"top\"></tr>\r\n </table>\r\n </td>\r\n </tr>\r\n <tr valign=\"top\"></tr>\r\n </table>\r\n </td>\r\n </table>\r\n </td>\r\n </tr>\r\n </table>\r\n <table>\r\n <tr>\r\n <td valign=\"top\">\r\n <table>\r\n <td align=\"left\" valign=\"top\">\r\n <table border=\"0\" cellpadding=\"0\" cellspacing=\"0\" height=\"0%\" rules=\"none\" width=\"100%\">\r\n <tr valign=\"top\">\r\n <td align=\"left\" valign=\"middle\">Does your job involve hazardous duties?</td>\r\n </tr>\r\n <tr valign=\"top\">\r\n <td align=\"left\" valign=\"middle\">\r\n\t\t\t\t\r\n\t\t\t\t\t\r\n\t\t\t\t\t\r\n\t\t\t\t\r\n\t\t\t\t\r\n\t\t\t\t\t\r\n\t\t\t\t\t\r\n\t\t\t\t\t<input checked=\"true\" disabled=\"true\" name=\"_8##s\" type=\"radio\" value=\"0#No\">No</input>\r\n\t\t\t\t\t<input disabled=\"true\" name=\"_8##s\" type=\"radio\" value=\"1#Yes\">Yes</input>\r\n\t\t\t\t\r\n\t\t\t</td>\r\n </tr>\r\n <tr valign=\"top\"></tr>\r\n </table>\r\n </td>\r\n </table>\r\n </td>\r\n </tr>\r\n </table>\r\n <table>\r\n <tr>\r\n <td valign=\"top\">\r\n <table>\r\n <td align=\"left\" valign=\"top\">\r\n <table border=\"0\" cellpadding=\"0\" cellspacing=\"0\" height=\"0%\" rules=\"none\" width=\"100%\">\r\n <tr valign=\"top\">\r\n <td align=\"left\" valign=\"middle\">Have you any intention to participate in any hazardous sport or leisure activity,\r\n <br>\r\n for example Aviation, Caving/Potholing, Climbing, Diving, Horse-riding, Motorsports, Mountaineering, Yachting?</td><td align=\"left\" valign=\"middle\">\r\n\t\t\t\t\r\n\t\t\t\t\t\r\n\t\t\t\t\t\r\n\t\t\t\t\r\n\t\t\t\t\r\n\t\t\t\t\t\r\n\t\t\t\t\t\r\n\t\t\t\t\t<input checked=\"true\" disabled=\"true\" name=\"_11##s\" type=\"radio\" value=\"0#No\">No</input>\r\n\t\t\t\t\t<input disabled=\"true\" name=\"_11##s\" type=\"radio\" value=\"1#Yes\">Yes</input>\r\n\t\t\t\t\r\n\t\t\t</td>\r\n </tr>\r\n <tr valign=\"top\"></tr>\r\n </table>\r\n </td>\r\n </table>\r\n </td>\r\n </tr>\r\n </table>\r\n <table>\r\n <tr>\r\n <td valign=\"top\">\r\n <table>\r\n <td align=\"left\" valign=\"top\">\r\n <table border=\"0\" cellpadding=\"0\" cellspacing=\"0\" height=\"0%\" rules=\"none\" width=\"100%\">\r\n <tr valign=\"top\">\r\n <td align=\"left\" valign=\"middle\">Other than holidays of less than 3 months, have you any intention of going outside\r\n <br>\r\n UK, Channel Islands or Isle of Man?</td><td align=\"left\" valign=\"middle\">\r\n\t\t\t\t\r\n\t\t\t\t\t\r\n\t\t\t\t\t\r\n\t\t\t\t\r\n\t\t\t\t\r\n\t\t\t\t\t\r\n\t\t\t\t\t\r\n\t\t\t\t\t<input checked=\"true\" disabled=\"true\" name=\"_14##s\" type=\"radio\" value=\"0#No\">No</input>\r\n\t\t\t\t\t<input disabled=\"true\" name=\"_14##s\" type=\"radio\" value=\"1#Yes\">Yes</input>\r\n\t\t\t\t\r\n\t\t\t</td>\r\n </tr>\r\n <tr valign=\"top\"></tr>\r\n </table>\r\n </td>\r\n </table>\r\n </td>\r\n </tr>\r\n </table>\r\n </td>\r\n </tr>\r\n </table>\r\n </li>\r\n </ul>\r\n </td>\r\n </tr>\r\n </table>\r\n </li>\r\n </ul>\r\n </body>\r\n</html>\r\n"
}POST /printResult
Print the result in HTML
Note: Errors are noted in the errorDescriptions of the result JSON-Map
| Path | Type | Description |
|---|---|---|
|
|
the language of the capturing |
|
|
The id of the used case |
|
|
The subsystem id of the used case |
|
|
userType, see SB documentation |
|
|
the loggingArea |
| Path | Type | Description |
|---|---|---|
|
|
API call path |
|
|
If call is completed successfully, then status is set to 0, otherwise it is set to 'WARNING'(=1) or 'OPERATION FAILED'(=2) or 'FATAL ERROR'(=3) |
|
|
Tf call is completed successfully, then status is set to 'OK', otherwise it is set to 'WARNING' or 'OPERATION FAILED' or 'FATAL ERROR' |
|
|
List of errorDescriptions in a JSON response |
|
|
Empty on this call |
|
|
Empty on this call |
|
|
the HTML representation of the result |
sample request
POST /printResult HTTP/1.1
Content-Type: application/json;charset=UTF-8
Content-Length: 120
Host: localhost:8080
{
"caseId" : "TestCase",
"subId" : "Demo",
"userType" : "1001",
"language" : "en",
"loggingArea" : "0"
}sample response
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 3264
{
"path" : "/printResult",
"status" : 0,
"statusText" : "OK",
"errorDescriptions" : [ ],
"jsonContent" : null,
"byteContent" : null,
"textContent" : "<html><HEAD><TITLE>Result FS</TITLE></HEAD><BODY TEXT=\"#000000\" BGCOLOR=\"#DDDDDD\" LINK=\"#000000\" VLINK=\"#666666\" ALINK=\"#666666\"><A name=\"top1\"><FONT color=\"#DDDDDD\">.</FONT></A><br></br><center><H1><FONT FACE=\"Arial Unicode MS\">Case FS</FONT></H1><H2><FONT FACE=\"Arial Unicode MS\">Policy can be issued</FONT></H2><H3><FONT FACE=\"Arial Unicode MS\">Assessed on Nov 1, 2023 at 7:35:37 PM</FONT></H3><H5><FONT FACE=\"Arial Unicode MS\">Number of assessments with case modifications: 1</FONT></H5></center><hr size=\"2\"></hr><table width=\"96%\"><col width=\"88%\"><col width=\"12%\"><tr><td><table style=\"border: solid #000000 1px;margin-left:0.2cm\" width=\"96%\"><tr><td><FONT FACE=\"Arial Unicode MS\"><FONT SIZE=\"-1\"><A HREF=\"#linkH0\"><img src=\".\\Level1-ball.gif\"></img></A> <A HREF=\"#linkH0\">Overall result Application FS: standard</A><br></br><A HREF=\"#linkH1\"><img src=\".\\Level1-ball.gif\"></img></A> <A HREF=\"#linkH1\">Person result AP MEier: standard</A><br></br><A HREF=\"#linkH2\"><img src=\".\\Level1-ball.gif\"></img></A> <A HREF=\"#linkH2\">Benefit IP - Disability own/similar AP MEier: standard</A><br></br></FONT></FONT></td></tr></table></td><td><FONT FACE=\"Arial Unicode MS\"><FONT SIZE=\"-2\">Explanations:<br></br><img src=\".\\Level1-ball.gif\">Standard</img src><br></br><img src=\".\\Level2-ball.gif\">Offer</img src><br></br><img src=\".\\Level3-ball.gif\">Refer</img src><br></br><img src=\".\\Level4-ball.gif\">Decline</img src><br></br><img src=\".\\Level0-ball.gif\">Else</img src><br></br></FONT></FONT></td></tr></table><hr size=\"2\"></hr> <!-- new Risk --><br></br><table style=\"border: solid #000000 1px;margin-left:0.2cm\" width=\"98%\"><tr><td><FONT FACE=\"Arial Unicode MS\"><FONT SIZE=\"+1\"><A name=\"linkH0\">Overall result Application FS: standard</A></FONT></FONT></td></tr></table> <p></p><br></br><A href=\"#top1\"><img src=\".\\top_home.gif\" width=\"28\" height=\"14\" border=\"0\"></img></A><hr size=\"2\"></hr> <!-- new Risk --><br></br><table style=\"border: solid #000000 1px;margin-left:0.2cm\" width=\"98%\"><tr><td><FONT FACE=\"Arial Unicode MS\"><FONT SIZE=\"+1\"><A name=\"linkH1\">Person result AP MEier: standard</A></FONT></FONT></td></tr></table> <p></p><table style=\"border: solid #000000 1px;margin-left:0.2cm\" width=\"98%\"><tr><td><FONT FACE=\"Arial Unicode MS\"><B>Hint Annual benefit</B><FONT SIZE=\"-1\"><ul><li>Sum-Limit IP own/similar: 420 £/Month<br></br> amount applied for below need</li></ul></FONT></FONT></td></tr></table><br></br><A href=\"#top1\"><img src=\".\\top_home.gif\" width=\"28\" height=\"14\" border=\"0\"></img></A><hr size=\"2\"></hr> <!-- new Risk --><br></br><table style=\"border: solid #000000 1px;margin-left:0.2cm\" width=\"98%\"><tr><td><FONT FACE=\"Arial Unicode MS\"><FONT SIZE=\"+1\"><A name=\"linkH2\">Benefit IP - Disability own/similar AP MEier: standard</A></FONT></FONT></td></tr></table> <p></p><br></br><A href=\"#top1\"><img src=\".\\top_home.gif\" width=\"28\" height=\"14\" border=\"0\"></img></A></BODY></html>"
}Search API
POST /search
The search engine assigns a COMPASS key to a term entered by a user. When the term exists in the COMPASS data, the key for this term is returned; otherwise a set of possibly matching terms with their keys is returned.
Search API calls can be done in the screenbuilder loop, two.
Note: returns and empty list if nothing is found or an invalid database is used
| Path | Type | Description |
|---|---|---|
|
|
Language, in which the search shall be performed |
|
|
Numerical ID of the database to be searched: Country-DB (Foreign Travel/Nationality) 2141 Occupation-DB 2139 Branches of industry-DB 2123 Disorder-DB 2128 Pursuit-DB 2108 Drug-DB 2158 Insurance company-DB 2127 |
|
|
Specifies, whether in a search result all found terms are being returned, or if the hierarchy-entries are being filtered. This is of special interest in the occupations- and the disorders DB, as in those databases hierarchy entries are no real disorders or occupations, but disorder-groups or occupation-groups. For all other databases this parameter should be set to "false". If the attribute is missing, “false” will be assumed. false: All results are being returned true: Hierarchy terms are filtered |
|
|
Defines the strategy used to identify words as similar or identical. The strategy "sameWords" identifies terms as equal, when all word parts of searchString are found in the candidate. E.g. the searchString “director, managing” will be identified with the entry “managing director”. Currently only “sameWords” is allowed, thus “sameWords” will be assumed if the attribute is missing. |
|
|
Limits the amount of found candidates of a search, if the search did not find a perfect match. If the attribute is missing the value “150” will be assumed. |
|
|
Values between 1 and 1000 Specifies a “quality” of the search, i.e. found candidates have to satisfy this quality. "1" means that nearly no similarities have to be found, and "1000" means that only exact matches are being returned. The number of found word parts defines the “similarity”. A term is more “similar” to another term when more word parts from one are contained in the other term. Sensible values are around 250 to 500. When this value is too low, several useless candidates will be offered, otherwise, if the value is too high, a search with a misspelled word will not return the expected term. You can use this value to control the number of candidates: E.g. call the search engine with strict criteria, and if all candidates are rejected, a second search with less strict criteria gives a wider set of possible matches. If the attribute is missing, the quality “300” will be assumed |
|
|
The term, for which the key is searched. |
|
|
the loggingArea |
| Path | Type | Description |
|---|---|---|
|
|
list of candidates |
|
|
Value between 0 and 1000 Specifies the degree of similarity of the candidate with the searchString. A direct match has the quality 1000. The lower the value, the less the similarity between the searchTerm and text. This attribute is always filled. |
|
|
Name of the candidate in the database. This attribute is always filled. |
|
|
COMPASS key for the found candidate term. This key is not always being returned, as some searchable databases do not use keys. |
|
|
Internal ID of the found term. This ID can be used when populating the input interface of COMPASS. This attribute is always filled. |
sample request
POST /search HTTP/1.1
Content-Type: application/json;charset=UTF-8
Content-Length: 181
Host: localhost:8080
{
"searchDB" : 2141,
"language" : "en",
"filter" : true,
"identityMatch" : "",
"maxResults" : 150,
"minQuality" : 300,
"token" : "ha",
"loggingArea" : "0"
}sample response
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 815
{
"candidates" : [ {
"quality" : "443",
"text" : "Haiti",
"key" : "RH",
"id" : "1159"
}, {
"quality" : "443",
"text" : "Hanoi",
"key" : "VN-1",
"id" : "2094"
}, {
"quality" : "427",
"text" : "Havana",
"key" : "C-0",
"id" : "1798"
}, {
"quality" : "427",
"text" : "Hawaii",
"key" : "USA-11",
"id" : "2075"
}, {
"quality" : "427",
"text" : "Harare",
"key" : "ZW-1",
"id" : "2135"
}, {
"quality" : "416",
"text" : "Hamburg",
"key" : "D-0",
"id" : "1829"
}, {
"quality" : "399",
"text" : "The Hague",
"key" : "NL-1",
"id" : "1974"
}, {
"quality" : "356",
"text" : "Hashemite Kingdom of Jordan",
"key" : "JOR-1",
"id" : "1925"
} ]
}Utility API
These API calls can be used to determine some information from the COMPASS Knowledge Database e.g. the possible SourceTypes or a list of CSP-Sets
GET /sourceTypeList
Returns a list of all SourceTypes in the System
| Path | Type | Description |
|---|---|---|
|
|
list of sourceTypes |
|
|
name of a SourceTypr |
|
|
id of the SourceType |
|
|
is a technical SourceType |
|
|
is a SB2 SourceType |
sample request
GET /sourceTypeList HTTP/1.1
Host: localhost:8080sample response
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 634
{
"sourceTypes" : [ {
"name" : "Health details",
"id" : "1",
"sb2SourceType" : false,
"caseGenerating" : false
}, {
"name" : "Non-health details",
"id" : "2",
"sb2SourceType" : false,
"caseGenerating" : false
}, {
"name" : "Non-health details NEW SB2",
"id" : "5",
"sb2SourceType" : true,
"caseGenerating" : false
}, {
"name" : "Health details NEW SB2",
"id" : "6",
"sb2SourceType" : true,
"caseGenerating" : false
}, {
"name" : "Technical data",
"id" : "100",
"sb2SourceType" : false,
"caseGenerating" : true
} ]
}GET /sourceTypeList (I18N)
Returns a list of all SourceTypes in the System, I18N notation
| Path | Type | Description |
|---|---|---|
|
|
list of sourceTypes |
|
|
i18N |
|
|
is a technical SourceType |
|
|
is a SB2 SourceType |
sample request
GET /sourceTypeList?i18n=true HTTP/1.1
Host: localhost:8080sample response
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 1574
{
"sourceTypes" : [ {
"idI18N" : {
"id" : 1,
"groupId" : 32,
"timestamp" : "20200306145946",
"userName" : "ROOT_POS",
"i18n" : {
"de" : "",
"en" : "Health details",
"fr" : ""
}
},
"sb2SourceType" : false,
"caseGenerating" : false
}, {
"idI18N" : {
"id" : 2,
"groupId" : 32,
"timestamp" : "20200306145952",
"userName" : "ROOT_POS",
"i18n" : {
"de" : "",
"en" : "Non-health details",
"fr" : ""
}
},
"sb2SourceType" : false,
"caseGenerating" : false
}, {
"idI18N" : {
"id" : 5,
"groupId" : 32,
"timestamp" : "20200306163933",
"userName" : "ROOT_POS",
"i18n" : {
"de" : "",
"en" : "Non-health details NEW SB2",
"fr" : ""
}
},
"sb2SourceType" : true,
"caseGenerating" : false
}, {
"idI18N" : {
"id" : 6,
"groupId" : 32,
"timestamp" : "20200306172735",
"userName" : "ROOT_POS",
"i18n" : {
"de" : "",
"en" : "Health details NEW SB2",
"fr" : ""
}
},
"sb2SourceType" : true,
"caseGenerating" : false
}, {
"idI18N" : {
"id" : 100,
"groupId" : 32,
"timestamp" : "20200825174744",
"userName" : "ROOT_POS",
"i18n" : {
"de" : "",
"en" : "Technical data",
"fr" : ""
}
},
"sb2SourceType" : false,
"caseGenerating" : true
} ]
}GET /cspList
Returns a list of all company specific parameters sets (CSP-Sets) in the system.
| Path | Type | Description |
|---|---|---|
|
|
list of CSP-sets |
|
|
i18N - ID and name(s) of a CSP-set |
Sample request
GET /cspList HTTP/1.1sample response
HTTP/1.1 200 OK
{
"csps":[ {
"id":"1",
"name":"Default settings"
}, {
"id":"35",
"name":"Default settings (Copy)"
}
]
}GET /version
Returns the Version of API, the Systemname and the version string of the knowledge data
| Path | Type | Description |
|---|---|---|
|
|
The API Version of the COMPASS REST Service |
|
|
git hash of the running software version |
|
|
git brach of the running software version |
|
|
build time of the running software version |
|
|
COMPASS SystemName |
|
|
Version String of the COMPASS Data |
|
|
CompassService version |
sample request
GET /version HTTP/1.1
Host: localhost:8080sample response
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 235
{
"apiVersion" : "1.0",
"versionHash" : "72e849a",
"buildBranch" : "91430-hash",
"buildTime" : "2023-11-01T19:34:31",
"systemName" : "rm60",
"compassData" : "RuleManager UK 6.0 18.06.2020",
"serviceVersion" : ""
}GET /documentation
Returns this documentation as one html page
sample request
GET /documentation HTTP/1.1
Host: localhost:8080References
-
[1] GettingStarted.pdf
-
[2] screenbuilderInterface.pdf
-
[3] screenbuilderInterface2.0.pdf
-
[4] Compass Service - CreateCaseInDB.pdf