Troubleshooting
Overview
The first thing the API endpoint does is validate the XML data against the schema. If the file does not pass validation, the API returns a relevant error message, so the response usually points you to the problem in the XML.
Tip: Validate the XML file against the schema yourself before sending it to your Interact instance. This can resolve a number of validation problems before you send the data file to Interact.
The API returns errors as JSON, for example:
{
"Message": "The request is invalid.",
"ModelState": {
"UMILogicError": ["The file is invalid compared to the schema. The element 'users' has incomplete content. List of possible elements expected: 'user'."]
}
}
The ModelState.UMILogicError field contains the error text describing the actual error. If you use a PowerShell script, the on-screen display is less tidy but still shows the relevant messages.
Common errors
| UMI message | What it means | How to resolve |
|---|---|---|
| The file is invalid compared to the schema. The required attribute 'username' is missing. | An element in the XML has a mandatory attribute called username that is missing. The attribute here is username, but this could be any mandatory attribute. |
Check the elements that should have the specified attribute (detailed in the schema). |
| The file is invalid compared to the schema. The element 'user' has incomplete content. List of possible elements expected: 'additionalfields'. | An element in the XML (here user) is missing a mandatory child element (here additionalfields). |
Check that each element has at least the required child elements. This is detailed in the schema. |
| The domain specified does not match the domain provided in the XML. | The domain attribute in the syncoptions element does not match the name of the profile source defined in Interact. |
Make sure the name of the profile source in Interact matches the domain attribute in the syncoptions element. |
| Authorization has been denied for this request. | The authentication token specified in the profile source in Interact does not match the X-ApiKey header value in the POST to the API. |
Make sure the POST request sending the XML data has an X-ApiKey header whose value matches the authentication token against the profile source in Interact. |
| The file is invalid compared to the schema. The 'UserCount' attribute is invalid - The value '' is invalid according to its datatype 'http://www.w3.org/2001/XMLSchema:integer' - The string '' is not a valid Integer value. | The schema specifies a particular data type for an attribute, but the data in the XML does not match it. Here UserCount should be an integer, but an empty string is being passed. |
Make sure all the data types are valid and match the schema. |
After a successful upload
A successful response means the file passed schema validation, not that every record imported. The file is then processed asynchronously by the UMI Processor Service. If users or groups do not appear as expected, open the profile source in Interact and check its log file and archived data file, both available from the list of profile sources, for processing errors.