POST call to begin an XML Import process. Note: Only one import process can be run at a time. If an import is requested before the previous import has completed, an error will be returned with the currently running import ID.
Fields:
| apiKey | Required: Secret Code used to authenticate the call and identify the OEM. For more information on generating your secret API Key, please refer to Appendix A, API Key generation. |
| xmlFileName | Required: The name of the xml file that has been transferred via FTP to the appropriate location for processing. |
| literatureArchiveFileName | Optional: Literature zip file name. The file should include all the literatures listed in the xml file in their appropriate folders. The zip file should be transferred by FTP along with the XML document. |
| imageArchiveFileName | Optional: Image zip file name. The file should include the images listed in the xml file in their appropriate folders. The zip file should be transferred by FTP along with the XML document. |
Sample URL:
https://xmlimport.datamanager.arinet.com/api/Process
Sample JSON request:
{
“apiKey”: ” 992dc0e2-b8b0-4f9e-a4cd-19eb9fc19fa8″,
“xmlFileName”: “XMLFullExample.xml”,
“literatureArchiveFileName”: “Literature.zip”,
“imageArchiveFileName”: “Images.zip”
}
Return Codes:
| 200 | If a successful import has begun, the call will return a unique import ID (GUID), which can be used to look up the Progress of the import (using /api/Progress call below) while it is running, or the Report details (using /api/Report call below) once the import has completed.
Sample response: “3c9ea84e-60fe-4ec6-baa2-1e3fef9203d8” |
| 401 | Unauthorized. This means the apiKey used does not have access to make these calls. |
| 500 | Unexpected error. |