New Result Interface
Introduction
This document describes the new result interface NIResult and its components. It is a XML interface that contains the COMPASS assessment result for life insurance applications.
The existing Result interface Result (the term Result in courier font is used all through this documentation to denote the “old” result interface) contains the COMPASS assessment of an application. The new result interface is generated from the Result interface, reordering items, and getting rid of some elements to simplify the structure. Thus the new result interface is easier to read, but comes with certain restrictions: Not every Result can be converted into a NIResult (see Restrictions of the new result interface).
Besides the description of the structure and its elements (see XML elements), you will find in Processing the NIResult interface recommendations of how to extract relevant information from NIResult.
Related documentation
As the new result interface is based on the existing result interface, the document Result Interface
For the generation of a NIResult refer to the COMPASS APIs Overview, checking for the operation convertResult .
Terminology
In the following chapters these terms will be used repeatedly:
-
caseObject -
caseAttribute -
caseResult -
resultAttribute -
caseRisk
All these terms are described in detail further on in this documentation, but it helps having a rough idea of what they stand for:
-
caseObjectscorrespond to theCaseObjectsof the existingResultinterface. Special XML elements have been defined for certain types ofcaseObjects:-
application: corresponds to the application -
person: corresponds to a person (AP or PH) -
tariff: corresponds to a benefit and the corresponding event -
disorder: corresponds to a disorder -
disorderConsolidated: corresponds to a consolidated disorder -
pursuit: corresponds to a pursuit -
foreignTravel: corresponds to a trip abroad -
drug: corresponds to a drug -
etc.
-
All caseObjects (and its subtypes above) contain at least one caseAttribute and can contain caseRisks and further caseObjects.
-
caseAttributesdescribe attributes of the currentcaseObject. -
caseRiskscorrespond to theCaseRisksin theResultinterface. They group the assessment resultscaseResultsfor the currentcaseObject. -
caseResultscorrespond to theCaseResultsin theResultinterface. AcaseResultdescribes an assessment result (like a loading, a hint, a referral). It containsresultAttributes, which depending on the result-type contain more information. ThecaseResultcan contain XML elementsmissingInformation(describes missing information) andexplanation(explaining the result). -
resultAttributescorrespond to theCaseResultAttributesin theResultinterface. They contain further information for theircaseResult. E.g. the amount of the loading. -
The root-element is
NIResult. It contains XML attributes and exactly 2 types of XML elements:-
application -
caseRisk:representing the overall assessment result for the application
-
-
The nested structure of
caseObjectsand its subtypes is of special interest:
-applicationexists exactly once, and as a child ofNIResult
-personelements do only appear as child elements ofapplication
-tariffelements can only appear as child elements ofperson-
all further special subtypes can only appear below a
tariff
-
-
The risk hierarchy (see Result-Interface) describes the path that Compass follows during the assessment. First the detailed risk (e.g. the risk of a single medical disorder, or the occupation) is assessed, and based on this the more complex risks, like the combination of disorders, and finally the risks for a particular benefit, or an assured person. On top of everything stands the overall risk, which is based on all other risk results. For each of those risks COMPASS places one
caseRiskelement into theNIResultinterface. ThiscaseRiskcontains the actual result for the current risk. Should the result be NORMAL (or Standard) then thecaseRiskis being omitted from theNIResultinterface. This is valid for allcaseObjectswith exception of those of typeperson,applicationandtariff: these 3 specialcaseObjectsalways contain acaseRisk.
Main differences to the Result interface
Nested caseObject structure
caseObjects are nested in the new result interface. As described in Terminology, an application element contains person elements. The person elements contain tariff elements, which again contain other special elements (disorder, pursuit, etc.).
The CaseRisk elements from the Result interface are placed via RiskCaseObjectRelations into a particular context (a set of CaseObjects). In the new result interface the caseRisks are in that position that corresponds to the path of related caseObjects. Thus the RiskCaseObjectRelations are omitted in the new result interface.
This comes at a price: CaseObjects appear only once in the old Result interface. In the NIResult, however, CaseObjects can appear multiple times, namely whenever they are needed as a reference.
Elimination of the CaseAttribute-CaseAttributeValue-Value structure
These three XML elements that contain each other are in the new result interface merged into the element CaseAttribute.
Example:
before:
<CaseAttribute TypeId="44" TypeIdName="name">
<CaseAttributeValue>
<StringValue Value="Smith"></StringValue>
</CaseAttributeValue>
</CaseAttribute>
new:
<caseAttribute typeId="44" typeIdName="name" value="Smith">
</caseAttribute>
In analogy the structure CaseResultAttribute-AttributeValue-Value is now represented by the single element resultAttribute.
policyCanBeIssued attribute
The result interface Result did contain an attribute policyCanBeIssued, which is no longer part of the NIResult. Its value was deduced from the resultLevelId- attribute of the Result, and can be similarly deduced from the resultLevelId- attribute of the NIResult in the following way:
policyCanBeIssued=”true” ←→ resultLevelId ∊ {1,4,7}
policyCanBeIssued=”false” ←→ resultLevelId ∊ {0,2,3,5,6}
Restrictions of the new result interface
The new result interface NIResult is generated, or converted, from the Result interface.
For the, COMPASS provides the API convertResult.
In case the operation is not successful, the server returns a returnCode="3":
<response><operationResult returnCode="3">
<errorDescription errorText="... " errorCode="128">
</errorDescription>
</operationResult></response>
Reasons for a failure to convert:
- A Benefit element with more than one EventPayment exists.
The new result interface NIResult
How to get a NIResult
The new result interface is an XML String that is being generated by the convertResult operation.
The purpose of this operation is to convert a Result into a NIResult, which is either written to a file, or returned to the calling instance via a directResultReference. A NIResult is not being written into the COMPASS databases. There are no further API commands that work with a NIResult interface.
XML elements
The new result interface is a XML String. The components of the interface (see XSD) are described in this chapter.
The assessment result is basically described by three element types:
-
Risks with their results (
caseRiskswithcaseResults) -
Case objects (
caseObjects)
The further processing of the result interfaces requires collaboration between IT and underwriting/Business. The underwriters define the amount of information they want to see or present to the customer, and the IT department should extract and present/process this information.
NIResult
The root XML element NIResult contains the following XML elements that are being explained later in this document:
-
Any number of
caseRisks -
Exactly one
applicationelement
XML attributes of NIResult
| Name | Description |
|---|---|
|
See |
|
See |
|
See |
|
See |
|
See |
|
See |
|
See |
|
Contains date and time of the assessment in the format ISO 8601[1]: YYYY-MM-DDT-hh:mm:ss+hh:mm |
|
See |
|
See |
|
See |
|
See |
|
Technical information |
|
Technical information |
Example:
<NIResult assessmentDate="2016-06-09T13:40:03+02:00" id="Tess_NI_07" locale="en"
numberOfChangeAssessCycles="1" numberOfSourceChanges="16"
resultLevelIdName="refer" resultLevelId="5"
versionName="GCR_UK 5.0 -12.12.2017">
<application>
…
</application>
<CaseRisk id="01" resultLevelIdName="refer"
riskTypeId="21" riskTypeIdName="overall risk">
</CaseRisk>
</NIResult>
caseObject and subtypes
A caseObject represents a set of information that can be considered as an object with attributes. This can be a medical disorder, a pursuit, a benefit, an assured person or a policy holder.
The following subtypes of caseObject exist: application, person, tariff, disorder, disorderConsolidated, pursuit, foreignTravel, drug, doctor, occupationalHazard.
These elements have been introduced only for readability of the interface. From their content they are identical in most aspects to the generic caseObject. Real caseObjects have the 2 additional attributes typeId/typeIdName that describe the type of the caseObject.
| Name | Description |
|---|---|
|
ID of the |
|
Name of the |
|
|
|
ID of the ResultLevel for this |
|
Name of the ResultLevel described by |
All caseObjects contain the following XML elements:
-
1..N
caseAttribute -
0..N
caseRisk -
0..N
caseObject
Example:
The XML below has the following structure (caseAttributes were omitted):
-
tariff-
disorderConsolidated-
disorder-
caseRisk
-
-
-
caseRisk -
caseRisk
-
Explanation: the caseObject of type tariff contains a caseObject of type disorderConsolidated and two caseRisks. The disorderConsolidated element contains a caseObject of type disorder and no caseRisk. The element disorder contains one caseRisk.
XML:
<tariff>
<caseAttribute typeId="11" typeIdName="Benefittype " value="IP" />
<caseAttribute typeId="108" typeIdName="Benefit name " value="Income protection" />
<caseAttribute typeId="161" typeIdName="Eventtype " value="Disability own occ" />
<disorderConsolidated>
<caseAttribute typeId="115" typeIdName="Disorder-ID" value="Meniscus" value2="M23.3-005" />
<disorder>
<caseAttribute typeId="115" typeIdName="Disorder-ID" value="Meniscus" value2="M23.3-005" />
<caseRisk id="0105010101010202" resultLevelIdName="Offer" riskText="Disorder Meniscus"
riskTypeId="20" riskTypeIdName="Disorder according to DB ">
<caseResult id="5" resultLevelIdName="Offer"
resultTypeIdName="Exclusion clause" suppressedById="4" suppressedByType="Consolidated">
<resultAttribute typeId="11" typeIdName="Exclusion clause" value="Exclusion of knee" />
</caseResult>
</caseRisk>
</disorder>
</disorderConsolidated>
<caseRisk id="010501" resultLevelIdName="Offer" riskTypeId="9" riskTypeIdName="Event risk" />
<caseRisk id="0105" resultLevelIdName="Offer" riskTypeId="36" riskTypeIdName="Benefit risk" />
</tariff>
caseRisk
The XML element caseRisk can contain caseResult elements.
The caseRisk element of the Result interface has the following attributes:
| Name | Description |
|---|---|
|
See |
|
See |
|
See |
|
See |
|
See |
|
See |
Example:
<caseRisk id="0105010101010202" resultLevelIdName="Offer" resultLevelId="0"
riskText="Disorder Meniscus"
riskTypeId="20" riskTypeIdName="Disorder according to DB">
<caseResult
. . .
</caseResult>
</caseRisk>
caseResult
The XML element caseResult can contain the following XML elements that are described in the following subchapters:
-
resultAttribute -
missingInfo -
explanation
caseResults contain an assessment result, like a loading, a declinature, an exclusion, etc. Details to such a result are described in its resultAttributes. In addition there can be explanations, which describes the reason for this result.
Missing answers from the client, which are important for the assessment, are being described as a missingInfo element.
Thus a caseResult element contains any number and combination of the abovenamed 3 XML elements. The number of allowed resultAttributes depends on the type of the result (ResultType; see resultTypeId below).
The caseResult XML element can have the following attributes:
| Name | Description |
|---|---|
|
Unique identifier of the |
|
See |
|
Name for |
|
ID of the ResultLevel of the current |
|
Name for |
|
Optional: ID of the |
|
Optional attribute; possible values: Consolidated or Subsumed |
Example:
<caseRisk id="0105010101" resultLevelIdName="Offer" resultLevelId="0"
riskText="Disorder Meniscus"
riskTypeId="20" riskTypeIdName="Disorder according to DB">
<caseResult id="5"
resultLevelIdName="Offer" resultLevelId="0"
resultTypeIdName="Exclusion clause" resultTypeId="26"
suppressedById="4" suppressedByType="Consolidated">
<resultAttribute typeId="11"
typeIdName="Exclusion clause"
value="Exclusion of knee"/>
</caseResult>
</caseRisk>
missingInfo
A missingInfo element refers to a question that is crucial for the assessment, but has not been answered by the customer. The missingInfo contains no further XML elements. It has the following attributes:
| Name | Description |
|---|---|
|
ID of the question/CaseAttributeType that has to be answered for a full and final assessment. |
|
Name of the question defined by |
As the missingInfo element appears inside of the hierarchy, it should be clear to which object, benefit and person it belongs.
Section Example for caseRisk, caseResult, missingInfo and explanation shows a XML example in which a missingInfo appears.
explanation
An explanation is basically a text explaining more in detail why or how the current result has been created. They are identical to the Explanation in the Result interface. An explanation contains no further elements, and its attributes are:
| Name | Description |
|---|---|
|
See |
|
See |
|
The textual explanation |
Example for caseRisk, caseResult, missingInfo and explanation
<caseRisk id="010403" resultLevelIdName="Missing Information" resultLevelId="3"
riskTypeId="4" riskTypeIdName="AIDS risk">
<caseResult id="3" resultLevelIdName="Missing Information" resultLevelId="3"
resultTypeIdName="request from client" resultTypeId="46">
<explanation text="at-risk age group" />
<explanation text="marital status: single" />
<explanation text="AP male" />
<missingInfo caseAttributeTypeIdName="Post code" />
</caseResult>
</caseRisk>
caseAttribute and resultAttribute
Every caseObject contains at least one caseAttribute. caseAttributes contain the answers from the client, about him/herself, a disorder, a pursuit, etc. They describe the object (caseObject) in which they are located.
resultAttributes describe a result (a caseResult). resultAttributes are created during the assessment of the application.
Both XML elements wrap a value, which can be a number, a text, a selection, a date, etc.
The elements caseAttribute and resultAttribute have several XML attributes, which can appear depending on whether it is a caseAttribute or a resultAttribute. The possible values are listed further down. First a list of all possible XML attributes:
| Name | Description |
|---|---|
|
ID of the attribute type. For a |
|
Name of the type defined by |
|
Optional: ID of the value |
|
Optional: language in der format de, nlBE or en |
|
Optional: internal ID of a unit |
|
Optional: name of unit |
|
Optional: a value |
|
Optional: additional value |
|
Optional: key for a value |
|
Optional: a date in the format YYYY-MM-DD |
|
Optional: a date in the format YYYY-MM-DD |
|
Optional: a text which describes a duration |
Always present are typeId and typeIdName. Depending on the existing attributes a parsing and the display of a value has to happen.
A value can be:
a text, a number, a selection value, a date, a period of time, a reference to another CaseObject, or a list of values. A list can contain values of all types; e.g. a list of numbers, or a list of selection values..
Text:
| XML attribute | Description |
|---|---|
|
Contains the text |
Example:
<caseAttribute typeId="0" typeIdName="Application-ID" value="Tess_NI_08"/>
Reference to a caseObject
| XML attribute | Description |
|---|---|
|
Contains the name or ID of the |
Example:
<resultAttribute typeId="19" typeIdName="Person" value="Mister X"/>
A number
| XML attribute | Description |
|---|---|
|
Contains the number |
unit |
Contains the ID of the unit (optional) |
|
Contains the name for unit (as such: optional) |
Example:
<resultAttribute typeId="3" typeIdName="Pension"
unit="1" unitName="EUR/Year" value="5333.0"/>
<resultAttribute typeId="4" typeIdName="Extramortality"
unit="12" unitName="%" value="25.0"/>
Hypertonia (complex numerical value)
| XML attribute | Description |
|---|---|
|
Contains a number (here the diastolic value) |
unit |
Contains the ID of the unit |
|
Contains the name for unit |
|
Contains a second number (here the systolic value) |
Example:
<caseAttribute typeId="66669" typeIdName="Blood pressure values" unit="1001" unitName="mm Hg" value="80" value2="120"/>
Date
This value type will currently not appear in a NIResult. We include it here for completeness reasons.
| XML attribute | Description |
|---|---|
|
Contains a date in format YYYY-MM-DD |
Examples, in which part of the date are unknown:
• <caseAttribute typeId="66666" typeIdName="Dummydate" value="2016-12-30"/>
• <caseAttribute typeId="66666" typeIdName="Dummydate" value="2016-??-30"/>
• <caseAttribute typeId="66666" typeIdName="Dummydate" value="2016-??-??"/>
Period of time
This value type will currently not appear in a NIResult. We include it here for completeness reasons. the following 3 attributes do not have to all be there.
| XML attribute | Description |
|---|---|
|
Contains a date in format YYYY-MM-DD |
|
Contains a date in format YYYY-MM-DD |
|
Optional: a text which describes a duration |
Example:
<caseAttribute duration="4 Week(s)" from="2001-08-01" to="2001-09-01" typeId="66668" typeIdName="Dummy-PeriodValue"/>
A selection value
The XML attribute come from the DBRefValue, as it is defined in the input interface. The diverse combinations of attributes are explained in detail in the input interface documentation.
| XML attribute | Description |
|---|---|
|
Corresponds to the attribute |
|
Corresponds to the attribute |
|
Corresponds to the attribute |
|
Corresponds to the attribute |
Examples:
<caseAttribute typeId="61" typeIdName="Nationality" key="D" locale="en" value="Germany"/>
<resultAttribute typeId="0" typeIdName="Text" id="101" locale="en" value="Disorder was not found"/>
Lists
A caseAttribute that contains a list of values (all of the same type) has no further attributes (other than the 2 mandatory ones) and contains its list-values as further caseAttributes.
A resultAttribute that contains a list of values (all of the same type) has no further attributes (other than the 2 mandatory ones) and contains its list-values as further resultAttributes.
Examples:
<caseAttribute typeId="66672" typeIdName="Dummy-Text-list ">
<caseAttribute value="1"/>
<caseAttribute value="3"/>
<caseAttribute value="2"/>
</caseAttribute>
<resultAttribute typeId="27" typeIdName="Disorders">
<resultAttribute value="Heart attack"/>
<resultAttribute value="Liver resection"/>
</resultAttribute>
Empty list:
<resultAttribute typeId="27" typeIdName="Disorders"/>
Processing the NIResult interface
The new result interface NIResult is being generated from the interface Result, and as such cannot contain more information as its source. The information has been reordered, which simplifies the evaluation process.
Certain knowledge that was important for the understanding of the Result interface is still important for the interpretation of the NIResult. These topics are described in brief here. For a more detailed description check the document Result-Interface:
-
The risk hierarchy
-
ResultLevel
-
ResultType with its ResultLevel and its ResultAttributeTypes
The risk hierarchy is of less importance, as the risks are no longer stored in an analogue way. They are now presented in a hierarchy defined by nested caseObjects. Nevertheless it is beneficiary to know about the risk hierarchy; in particular when evaluating caseRisks.
ResultLevels allow the rough distinction of results in classes (levels). For about 18 years COMPASS has handled the following ResultLevels, ordered by severity:
ID 1 |
standard |
no risk |
ID 4 |
borderline standard |
insignificant risk; is being ignored |
ID 7 |
substandard, but acceptable |
risk existent, but already compensated |
ID 0 |
Offer |
risk can be compensated; make customer an offer |
ID 3 |
request information |
certain information for a final assessment is missing |
ID 5 |
refer |
risk should be handled by underwriter |
ID 2 |
postpone |
risk should be postponed |
ID 6 |
decline |
risk should be declined |
ResultTypes represent the results that are available to an underwriter. The most usual ones are standard, loadings, exclusion clauses, postponements and declinature. Compass knows several more ResultTypes, which have to be processed when evaluating the NIResult.
For instance there are the following ResultTypes:
-
Loading in percent
-
Loading in per mille
-
Exclusion clause
-
Sum reduction
-
Termination age etc.
which are all types of the ResultLevel offer.
Each of these results contains further information:
- a loading needs to know the amount;
- an exclusion needs the wording of the clause;
- a sum reduction needs to know the reduced sum;
- a reduction of the termination age should suggest a new termination age; etc.
I.e. depending on the ResultType different attributes are required: sometimes it is a number, other times an exclusion clause; etc. The allowed types are described by ResultAttributeTypes, which are linked to a ResultType.
Overall assessment result
The overall result of an assessment can be found at 2 places in the NIResult:
-
<NIResult … resultLevelIdName="refer" resultLevelId="5" >
-
In the child
caseRiskof theNIResultelement
In COMPASS risks are being propagated bottom-up. I.e. for a specific risk X the result will mostly be equal or worse than the worst result of the sub-risks. Or in other words: When the overall result is refer, we can assume with a high probability that a sub-risk has also been assessed as refer (and none as decline).
The attribute resultLevelId="0", "3", "5", "2" or "6" means that the policy should not be issued without further action.
When this attribute is "1", "4" or "7", we can assume that all sub-risks are also standard or that there are only insignificant risks that can be waived (e.g. a small loading of 10%).
When the overall result is not standard a more detailed analysis should follow:
a) Check assessments for each benefit or for each involved person: it could be that one benefit is not accepted, but all others are fine. See Result for a person and Result for a benefit for the detailed result for a person or a benefit.
b) Should the overall resultLevelIdName be offer, it is important to search for the reason, so that an offer can be made to the customer
c) Should the resultLevelIdName be request information, it is recommended to check what is missing, so that the customer can be told what is still missing (mostly additional documents, or missing answers)
In every situation it is important to know the details, and to study the result by assured person and/or by benefit. This is being described in the following chapters.
Result for a person
An application (application) can contain several assured persons (1..N person elements). There are 3 types of persons, which are differentiated by the attribute type:
-
AP - assured person
-
PH - policy holder
-
PH-AP - person is AP and PH
Each AP can have 1 or more benefits (1..N tariff elements). The tariff element contains the assessment result for the benefit, and is handled in the next chapter.
A person element has always two attributes (caseAttributes) that describe the person:
<caseAttribute typeId="44" typeIdName="name" value="Smith"></caseAttribute>
and
<caseAttribute typeId="307" typeIdName="person ID" value="1234567"></caseAttribute>
A person element has an attribute ResultLevel (technically: resultLevelId and resultlevelIdName). This value corresponds to the worst ResultLevel of the sub-risks.
Sub-risks are the following:
- one risk per benefit (see Result for a benefit)
- caseRisks, which are direct child elements to person:
here there are two special risks:
- AP risk: the benefit-independent risk of the AP (only for persons that are AP)
- PH risk: the benefit-independent risk of the PH (only for persons that are PH)
- risks, which are in further caseObjects that are direct child elements of person
In any case, existing caseRisks should be analysed. See Analysing a caseRisk.
Should the ResultLevel of a person be standard, no detailed analysis is required, and the person result including all benefits can be considered as standard.
Result for a benefit
The tariff element contains all details about the assessment for one benefit.
For the identification of the benefit the tariff contains the following attributes (caseAttributes):
<caseAttribute typeId="108" typeIdName="benefit name" value="Vita">
</caseAttribute>
<caseAttribute id="0" typeId="11" typeIdName="benefit type" value="Life">
</caseAttribute>
<caseAttribute id="0" typeId="383" typeIdName="internal benefit type" value="Life">
</caseAttribute>
and
<caseAttribute id="2" typeId="161" typeIdName="Event type " value="Death">
</caseAttribute>
A tariff element is merged from the original elements Benefit and EventPayment found in the Result interface. This is possible, as there is a 1:1 relation between Benefit and EventPayment (see Restrictions of the new result interface).
As such the tariff element has inherited two CaseRisks from the Benefit risk and from the Event risk. Example:
<caseRisk id="0104" resultLevelId="5" resultLevelIdName="refer" riskTypeId="36" riskTypeIdName="Benefit risk">…</caseRisk>
<caseRisk id="010401" resultLevelId="5" resultLevelIdName="refer" riskTypeId="9" riskTypeIdName="Event risk">…</caseRisk>
The caseRisk with the Benefit risk is always present, and reflects in its ResultLevel a rough classification of the benefit assessment. When this ResultLevel is standard, a detailed analysis of the tariff element is not required.
Should the Event risk be different from the Benefit risk, the Event risk caseRisk is also present in the NIResult.
Furthermore the tariff element can contain diverse caseObjects (including the derived types disorder, drug, foreignTravel, pursuit, etc.), with their caseRisks.
The context for a caseRisk is given by the hierarchy of parent caseObjects.
Example: a caseRisk in a pursuit element contains the assessment for the current pursuit, benefit and person found in the upper hierarchy.
Analysing a caseRisk
To analyse a caseRisk means evaluating its attributes and all included instances of caseResult.
The attributes worth mentioning are riskText and riskTypeIdName, which are identical as in the Result interface. Those attributes contain information about the risk (see Result Interface) in which the results were created (e.g. in the risk over-/underweight).
In addition each caseResult has to be analysed:
-
Identify the ResultType (
resultTypeId) of thecaseResult. The follow-up should occur depending on the ResultType. -
Collect the ResultAttributes for this ResultType. From these
resultAttributescollect their values (value,value2, unit, etc.) -
Find
missingInfoobjects in thecaseResult. AmissingInfodescribes questions that have not been answered. Only a few ResultTypes allowmissingInfoobjects. -
Should the goal be a display of the full result,
explanationobjects in thecaseResultare of interest and should be evaluated. They contain basically a text giving adetailled explanation of the result. -
Depending on the attribute
suppressedByit can be decided if the current result should be evaluated or not. Typically suppressed results are of interest only for those who are interested in the full result. -
Depending on the ResultType/ResultLevel and the purpose of the result analysis the following actions are possible (small selection only here)
-
Request further documents
-
Display of the whole result
-
Recalculation of the premium
-
Policy print
-
Produce an offer, specifying the exclusion clauses
-
Produce a decline-letter
-
caseObjects and subtypes
Every caseObject is of a specific type. Certain types have been singled out, and they have got their own XML elements (e.g. pursuit, disorder, person, … ; see Terminology). Those CaseObjects that are not one of the special sub-types have two XML attributes typeId and typeIdName, which describe the exact type:
Example:
<caseObject typeId="12" typeIdName="Occupation">
<caseAttribute key="135477" locale="en"
typeId="209" typeIdName="Occupation-ID" value="Engineer">
</caseAttribute>
<caseRisk> …. </caseRisk>
</caseObject>
In most situations these caseObject elements are in the NIResult, because they have produced a non-standard result. As such it is important to look for the caseRisk in the caseObject, and process it.
Each CaseObject (and each sub-CaseObject) contains at least one attribute which describes it. For example:
|
|
|
|
|
|
|
|
XSD
The deployed XSD defines the possible structures of the new result interface in the XML It is suggested to use this XSD as a basis for the generation of classes.