The EntityTypeName (e.g., PERSON) for the type of Identity described by the Source and Target
A GUID or alphanumeric ID which uniquely identifies the data representing the
canonical record in the underlying local system for the Source Entity to be merged
A GUID or alphanumeric ID which uniquely identifies the data representing the
canonical record in the underlying local system for the Target Entity to be merged
A GUID or alphanumeric ID which uniquely identifies the local system and its associated
CBR. Note: A HIN is considered a local system by the IXS service. This SourceId
represents that of both the Target and Source Entity
An alphanumeric code used to describe why a IXS record was merged.
Specific meanings of specific codes is implementation dependent and this
is intended for use in a human readable display
The EntityTypeName (e.g., PERSON) for the type of Identity described by the Source and Target
A GUID or alphanumeric ID which uniquely identifies the data representing the
canonical record in the underlying local system for the Source Entity to be unmerged
A GUID or alphanumeric ID which uniquely identifies the data representing the
canonical record in the underlying local system for the Target Entity to be unmerged
A GUID or alphanumeric ID which uniquely identifies the local system and its associated
CBR. Note: A HIN is considered a local system by the IXS service. This SourceId
represents that of both the Target and Source Entity
An alphanumeric code used to describe why a IXS record was unmerged.
Specific meanings of specific codes is implementation dependent and this
is intended for use in a human readable display
The EntityTypeName (e.g., PERSON) for the type of Identity described by the Source and Target
A GUID or alphanumeric ID which uniquely identifies the data representing the
canonical record in the underlying local system for the Source Entity to be linked
A GUID or alphanumeric ID which uniquely identifies the local system and its associated CBR.
Note: A HIN is considered a local system by the IXS service. This SourceId represents
that of the SourceEntity
A GUID or alphanumeric ID which uniquely identifies the data representing the
canonical record in the underlying local system for the Target Entity to be linked
A GUID or alphanumeric ID which uniquely identifies the local system and its associated
CBR. Note: A HIN is considered a local system by the IXS service. This SourceId
represents that of both the Target and Source Entity
An alphanumeric code used to describe why a IXS record was linked.
Specific meanings of specific codes is implementation dependent and this
is intended for use in a human readable display
The EntityTypeName (e.g., PERSON) for the type of Identity described by the Source and Target
A GUID or alphanumeric ID which uniquely identifies the data representing the
canonical record in the underlying local system for the Source Entity to be unlinked
A GUID or alphanumeric ID which uniquely identifies the local system and its associated CBR.
Note: A HIN is considered a local system by the IXS service.
A GUID or alphanumeric ID which uniquely identifies the data representing the
canonical record in the underlying local system for the Target Entity to be unlinked
A GUID or alphanumeric ID which uniquely identifies the local system and its associated
CBR. Note: A HIN is considered a local system by the IXS service.
An alphanumeric code used to describe why a IXS record was Unlinked.
Specific meanings of specific codes is implementation dependent and this
is intended for use in a human readable display
A boolean flag representing the success or failure of the API operation. True
indicates that the operation was successful and false indicates a non-successful
operation
An array of the status-condition structure
The state of the IXS for the operation undertaken
A 4 digit numeric code representation of the outcome of the API operation.
A statusCode instance has two dimensions. First, each statusCode is unique and
represents a single specific condition that may occur within the IXS. Second, statusCodes
are numeric and their range will indicate a class of conditions that has occurred.
For example, status-codes in the range of 1000-1999 indicate a successful operation.
A more detailed description of the condition that occurred.
An alpha-numeric message describing the outcome of the API operation.
An enumeration that indicates the severity of the status-code returned.
This operation provides the means to create an explicit linking between the source and target
record IDs in the IXS repository.
Status Conditions Returned
Code Severity Message
1010 Info Entities successfully linked
2020 Error Source Entity Referenced does not exist in the IXS
2021 Error Target Entity Referenced does not exist in the IXS
2022 Error Reason Code is not in a valid format or does not exist in the IXS
2009 Error The Entity Type identified by ‘%1’ does not exist in the IXS
This operation provides the means for explicitly breaking the link between the source and target
record IDs in the IXS repository.
Status Conditions Returned
Code Severity Message
1011 Info Entities successfully unlinked
2020 Error Source Entity Referenced does not exist in the IXS
2021 Error Target Entity Referenced does not exist in the IXS
2022 Error Reason Code is not in a valid format or does not exist in the IXS
2009 Error The Entity Type identified by ‘%1’ does not exist in the IXS
This operation marks the record as “active” in the IXS repository, effectively marking it as logically un-deleted.
Status Conditions Returned
Code Severity Message
1014 Info Entity successfully activated
2007 Error Entity Referenced does not exist in the IXS
2002 Error The Trait identified by ‘%1’ does not exist in the IXS
2022 Error Reason Code is not in a valid format or does not exist in the IXS
2009 Error The Entity Type identified by ‘%1’ does not exist in the IXS
This operation marks the record as “inactive” in the IXS repository, effectively marking it
available for Get() or List() operations at the entity level but not from the IXS repository.
Status Conditions Returned
Code Severity Message
1015 Info Entity successfully deactivated
2002 Error The Trait identified by ‘%1’ does not exist in the IXS
2007 Error Entity Referenced does not exist in the IXS
2022 Error Reason Code is not in a valid format or does not exist in the IXS
2009 Error The Entity Type identified by ‘%1’ does not exist in the IXS
This operation provides the means to explicitly consolidate IXS member records in the IXS
repository. The source record is effectively merged into the target, leaving only the resulting
target record in the IXS repository. Identifying attributes in the target which are empty are filled
from the source, and existing attributes in the target remain AS-IS. The source record is
inactivated in the IXS repository at the successful end of this operation.
Status Conditions Returned
Code Severity Message
1012 Info Entities successfully merged
2020 Error Source Entity Referenced does not exist in the IXS
2021 Error Target Entity Referenced does not exist in the IXS
2022 Error Reason Code is not in a valid format or does not exist in the IXS
2009 Error The Entity Type identified by ‘%1’ does not exist in the IXS
This operation provides the means to explicitly unconsolidate a pair of IXS member
records in the IXS repository. The source record is effectively unmerged from the target,
leaving both the source and the target record unassociated in the IXS repository .
If possible, implementers should clear identifying Traits in the target identity which
were previously empty prior to the origional merge operation. The identifying Traits
in the source identity should be returned to the state they were in prior to the
mergeEntities operation.
Status Conditions Returned
Code Severity Message
1013 Info Entities successfully unmerged
2020 Error Source Entity Referenced does not exist in the IXS
2021 Error Target Entity Referenced does not exist in the IXS
2022 Error Reason Code is not in a valid format or does not exist in the IXS
2009 Error The Entity Type identified by ‘%1’ does not exist in the IXS
Entity Identification Service (IXS): Administration Interface