IM Relationship Resolution Information Center, Version 4.2

SOA_IDENTITIES_FOR_ENTITY_REQUEST input document

The SOA_IDENTITIES_FOR_ENTITY_REQUEST input document contains the request and search criteria to obtain the details of all identities that comprise a specific entity that is identified by an entity ID or by the external ID and data source code of one of its composite identities. The results of this Web services input document are returned to the calling application in a SOA_IDENTITIES_FOR_ENTITY_RESPONSE output document.

These UMF tags comprise the ROOT segment for the SOA_IDENTITIES_FOR_ENTITY_REQUEST input document:
ENTITY_ID
Entity ID UMF tag that is required if the DSRC_ACCT and DSRC_CODE UMF tags are not present, because it references and identifies the specific entity ID for which the identities are being requested.
DSRC_ACCT
Data source reference UMF tag that is required if the DSRC_CODE UMF tag is present and ENTITY_ID UMF tag is missing, because it references and identifies the unique ID for the entity in the data source in the system for which the identities are being requested.
DSRC_CODE
Data source reference UMF tag that is required if the DSRC_ACCT UMF tag is present and ENTITY_ID UMF tag is missing, because it references and identifies the data source in the system from where the identities are being requested.
DEPTH
Depth level UMF tag that is optional. It indicates the level of detail for the response. If not specified, then FULL is assumed. Currently, FULL is the only level available.

The SOAP-RPC equivalent of the SOA_IDENTITIES_FOR_ENTITY_REQUEST input document and the SOA_IDENTITIES_FOR_ENTITY_RESPONSE output document is the getIdentitiesForEntity method.

Example SOA_IDENTITIES_FOR_ENTITY_REQUEST input document

This example SOA_IDENTITIES_FOR_ENTITY_REQUEST query requests the details the details of all identities that comprise the entity ID value of 1234567.
Note: This example is formatted for readability and does not follow the required one line per UMF record format.
<SOA_IDENTITIES_FOR_ENTITY_REQUEST>
	<ENTITY_ID>1234567</ENTITY_ID>
	<DEPTH>FULL</DEPTH>
</SOA_IDENTITIES_FOR_ENTITY_REQUEST>
This example SOA_ENTITY_DETAIL_REQUEST query requests the details of the details of all identities that are identified by the data source value EMPL, and the unique ID for the entity in the data source value of 0982.
Note: This example is formatted for readability and does not follow the required one line per UMF record format.
<SOA_IDENTITIES_FOR_ENTITY_REQUEST>
	<DSRC_CODE>EMPL</DSRC_CODE>
  <DSRC_ACCT>0982</DSRC_ACCT>
	<DEPTH>FULL</DEPTH>
</SOA_IDENTITIES_FOR_ENTITY_REQUEST>

Example SOA_IDENTITIES_FOR_ENTITY_RESPONSE output document

This example SOA_IDENTITIES_FOR_ENTITY_RESPONSE output document returns the details the details of all identities that comprise the entity ID value identified by the SOA_IDENTITY_DETAIL_REQUEST input document.
Note: This example is formatted for readability and does not follow the required one line per UMF record format.
<SOA_IDENTITIES_FOR_ENTITY_RESPONSE>
  <IDENTITY>
	  <DSRC_ACCT_ID>12121212</DSRC_ACCT_ID>
    <DSRC_CODE>EMPLOYEE_DB</DSRC_CODE>
    <DSRC_ACCT>1223334444</DSRC_ACCT>
    <DSRC_REF>HR</DSRC_REF>
	</IDENTITY>	
  <IDENTITY>
	  <DSRC_ACCT_ID>23232323</DSRC_ACCT_ID>
    <DSRC_CODE>VENDOR_DB</DSRC_CODE>
    <DSRC_ACCT>5556663332</DSRC_ACCT>
    <DSRC_REF>VEND</DSRC_REF>
	</IDENTITY>	
</SOA_IDENTITIES_FOR_ENTITY_RESPONSE>


Feedback

Last updated: 2009