Web Services General Message Codes

  • Web Services
  • Troubleshooting
  • UMPI

This section provides describes the web service response messages/codes you can expect to see for both successful and unsuccessful web service responses.

Each Universal MPI web service response includes some common fields that can help clients interpret the outcome of the web service call:

Field(s) Description
HTTP status code of the web service response
  • Typically a 200 value if Verato was able to complete the web service operation, even if the outcome of the completed web service is an abnormal or atypical outcome.
  • If Verato was unable to complete the web service operation, the code will typically be either 401 (in the case of an incorrect user authentication) or a 5XX code (in the case of unexpected failures).
Success Boolean value in the JSON content of the web service response
  • This value is set to true when the web service completes and the outcome is a typical or expected outcome.
  • This value is set to false if the web service outcome is an atypical outcome.

Example

When attempting to retrieve a Universal MPI identity by querying for the Source + Native ID, the identity is retrieved if it exists and not retrieved if it does not exist in the database – both of these outcomes are typical, expected outcomes, and the web service response will include success: true.

However, if the web service request is attempting to retrieve an identity from a Source for which the user does not have permission to see, the web service will not return any identity AND the web service response will include success: false, along with a warning message.

Message string in the JSON content of the web service response

This string provides additional information about what happened with the web service execution.

Errors array of strings in the JSON content of the web service response

In the future, it is possible that Verato may return multiple error or warning messages for a single web service response, in which case those would appear in the array of error strings.

Currently, if there is any content in the errors string, it is simply a repeat of the information available in the message string, so you do not need to look beyond the message string.

RetryableError Boolean value in the JSON content of the web service response

This value is a placeholder for future use.  Currently, the value returned will always be false.

In the future, this may be enhanced to indicate true in cases where the error is a temporary error that would not be repeated if the web service request was re-submitted.