The following table describes the message string in the web service response when the web service executes successfully. In all of these cases:
- The success Boolean will be set to true in the web service response
- The HTTP status code will be 200.
The scenarios described in the following table are typical, expected outcomes.
Web Service Execution Messages - Success Messages
|
Web service |
Scenario |
Message String |
|
postIdentity |
A successful add or update of a posted Source + Native ID. |
The identity has been successfully posted. |
|
nativeIdQuery |
The identity requested exists in the Universal Identity platform and was retrieved. |
Identity found! |
|
nativeIdQuery |
The identity requested does NOT exist in the Universal Identity platform and thus was not retrieved. In this example, the identity requested was from source=verato.source.a with nativeId=12345. |
Could not find entity with nativeId 12345 and source verato.source.a |
|
identityIdQuery |
The identity requested exists in the Universal Identity platform and was retrieved. |
The “message” string is empty, but the JSON content includes an “identity” object. |
|
identityIdQuery |
The identity requested does NOT exist in the Universal Identity platform and thus was not retrieved. |
The “message” string is empty, and the JSON content does NOT include an “identity” object. |
|
identityIdQuery |
The identity requested exists in the Universal Identity, but the requesting user does not have permission to view data from any of the sources that make up the identity. |
The “message” string is empty, and the JSON content does NOT include an “identity” object. |
|
demographicsQuery |
An identity was found matching to the input demographics above the match threshold, and the requesting user has permission to view data from one or more sources that make up the identity. |
Identity found! |
|
demographicsQuery |
No identity was found matching to the input demographics above the match threshold. |
No identity found. |
|
demographicsQuery |
An identity exists that matches above the match threshold, but the requesting user does not have permission to view data from any of the sources that make up the identity. |
No identity found. |
|
deleteSourceIdentity |
The Source + Native ID from the web service request input was successfully deleted. |
The “message” string is empty, but the JSON content indicates whether a Link ID was modified (other Source + Native ID records still exist in the Link ID) or a Link ID was deleted (the Link ID only contained the Source + Native ID that was deleted). |
|
deleteSourceIdentity |
The Source + Native ID from the web service request did not exist in the Universal Identity platform. |
The “message” string is empty, and the JSON content does not specify that a Link ID was modified OR deleted, since there was nothing to modify or delete. |
|
linkIdentities, unlinkIdentities, mergeIdentities, unmergeIdentities |
The requested link/unlink/merge/unmerge action was completed. |
The “message” string is empty, but the JSON content indicates the outcome of the link/unlink/merge/unmerge action. |
|
searchNotifications |
The notification messages, if any exist for the time range requested, were returned in the response. |
The “message” string is empty, but the JSON content includes the relevant information about the retrieved notification messages. |