The SOA_ENTITY_RELATIONSHIPS_BY_STRENGTH_REQUEST input
document contains the request and search criteria to obtain all best-path
relationships to all related entities where the paths originate from
a specific entity identified either by entity ID or by the external
ID and data source code of a composite identity where the relationship
paths have a strength that is no less than the specified relationship
strength. The results of this Web services input document are returned
to the calling application in a SOA_ENTITY_RELATIONSHIPS_BY_STRENGTH_RESPONSE
document.
These UMF tags comprise the ROOT segment for the SOA_ENTITY_RELATIONSHIPS_BY_STRENGTH_REQUEST
input document:
- ENTITY_ID
- Identifies the entity from which the relationship path should
originate. This tag should not be provided if the DSRC_CODE or DSRC_ACCT
tags are provided.
- Required? Yes, if DSRC_ACCT is not provided.
- DSRC_ACCT
- Identifies an identity record (within a specific data source)
of the entity from which the relationship path should originate. This
tag should not be provided if the ENTITY_ID tag is provided. This
tag should always be accompanied by the DSRC_CODE tag.
- Required? Yes, if ENTITY_ACCT is not provided.
- DSRC_CODE
- Identifies the data source for the identity record of the entity
from which the relationship path should originate. This tag should
not be provided if the ENTITY_ID tag is provided. This tag should
always be accompanied by the DSRC_ACCT tag.
- Required? Yes, if the DSRC_ACCT tag is provided.
- MIN_STRENGTH
- Specifies the minimum relationship path strength for the relationship
paths. The value must be a floating point number that is strictly
greater-than zero.
- Required? Yes
- DEPTH
- Indicates the level of detail for the response. If not specified,
then FULL is assumed. The recognized value is FULL.
- Required? No
The SOAP-RPC equivalent of the SOA_ENTITY_RELATIONSHIPS_BY_STRENGTH_REQUEST
input document and the SOA_ENTITY_RELATIONSHIPS_BY_STRENGTH_RESPONSE
output document is the getRelationshipByEntityAndStrength method.
Example OA_ENTITY_RELATIONSHIPS_BY_STRENGTH_REQUEST
input document
Note: This example is formatted for readability
and does not follow the required one line per UMF record format.
<SOA_ENTITY_RELATIONSHIPS_BY_STRENGTH_REQUEST>
<ENTITY_ID>1234567</ENTITY_ID>
<MIN_STRENGTH>88.5</MIN_STRENGTH>
<DEPTH>STANDARD</DEPTH>
</SOA_ENTITY_RELATIONSHIPS_BY_STRENGTH_REQUEST>
Example 2:
<SOA_ENTITY_RELATIONSHIPS_BY_STRENGTH_REQUEST>
<DSRC_CODE>EMPL</DSRC_CODE>
<DSRC_ACCT>0982</DSRC_ACCT>
<MIN_STRENGTH>3</MIN_STRENGTH>
<DEPTH>STANDARD</DEPTH>
</SOA_ENTITY_RELATIONSHIPS_BY_STRENGTH_REQUEST>
Example SOA_RELATIONSHIP_BETWEEN_ENTITIES_REQUEST
output document
This example SOA_RELATIONSHIP_BETWEEN_ENTITIES_REQUEST
output document requests the details of the best relationship between
the two entities, if they relate at all.
<SOA_RELATIONSHIP_BETWEEN_ENTITIES_RESPONSE>
<REL_PATH>
<FROM_ENTITY_ID>111222333</FROM_ENTITY_ID>
<TO_ENTITY_ID>222333444</TO_ENTITY_ID>
<PATH_STRENGTH>65.3</PATH_STRENGTH>
<SEP_DEGREES>3</SEP_DEGREES>
<RELATIONSHIP>
<FROM_ENTITY_ID>111222333</FROM_ENTITY_ID>
<TO_ENTITY_ID>888333111</TO_ENTITY_ID>
</RELATIONSHIP>
<RELATIONSHIP>
<FROM_ENTITY_ID>888333111</FROM_ENTITY_ID>
<TO_ENTITY_ID>999222444</TO_ENTITY_ID>
</RELATIONSHIP>
<RELATIONSHIP>
<FROM_ENTITY_ID>999222444</FROM_ENTITY_ID>
<TO_ENTITY_ID>222333444</TO_ENTITY_ID>
</RELATIONSHIP>
</REL_PATH>
<SYS_CREATE_DT>2008-06-26 05:18:55</SYS_CREATE_DT>
</SOA_RELATIONSHIP_BETWEEN_ENTITIES_RESPONSE>
Output document elements:
- REL_PATH
- This segment is not provided if no such relationship paths exist.
Otherwise, one of these segments is provided for each relationship
path from the specified entity that is less-than or equal-to the specified
maximum number of degrees of separation. This is a standard SOA relationship
path segment..
- Required? No.
- SYS_CREATE_DT
- Timestamp of when the output message was generated.
- Required? Yes.
Table 1. Error segmentsMessage ID |
Cause |
CWUAE####E |
The specified entity is not recognized. (TBD==>actual
error codes to be determined during implementation and provided to
ID***). |
CWUAE####E |
Input document tags are malformed. For example,
required tags are missing or there are mismatched tags. |
Depth settings for each element in the returned array are
identical to those identified for getRelationshipBetweenEntities for
the individual relationship path returned.