{"_id":"560e9264c4e4ae0d00b42f4a","user":"55dd9841cafe7221002a4c62","parentDoc":null,"project":"55dd9f2e0efd5821000d54d9","version":{"_id":"55dd9f4dab0e4d210045aae9","__v":39,"project":"55dd9f2e0efd5821000d54d9","createdAt":"2015-08-26T11:13:17.024Z","releaseDate":"2015-08-26T11:13:17.024Z","categories":["55dd9f4dab0e4d210045aaea","55ddb5fa9067202b00ddff6f","55e0472c6bad670d0081f213","55e04764a44fae0d00214671","55e047a9a44fae0d00214672","55e047b258c5460d0076a9a7","55e95e337fc27b2d00d32cf2","55e979bda7ca823900ad549a","55edb8c18dcb210d0056900b","55f0365c8563861700a33765","55f03677d58f9b1900acf996","55f036938eeefc23001ea5de","55f036a38563861700a33767","55f036c08563861700a33769","55f036d02911b72100482cd7","55f036e92911b72100482cd9","55f036fa8563861700a3376b","55f0370ee507711900e58c69","55f0371df6101b1900c70700","55f0374f2911b72100482cdb","55f0375e2911b72100482cdc","560eb0f659cb8d0d0015cd52","560eb25239fad419002ae1e0","561fb64d4d67490d00804b2a","562b9f775a39cd0d009aff22","562ba0505a39cd0d009aff23","562ba149d56bc30d00f0cb18","562ba595f68a5f0d007b1f3b","562ba78fd56bc30d00f0cb1b","562ba8b95a39cd0d009aff27","562baadf6562140d001501d2","562bab37f68a5f0d007b1f3d","562bc1bf9ebc950d000f7523","562bc99ced4bea0d00c11dfa","562bd29c1b98640d00714520","562bd5875a39cd0d009aff60","562bdfabff2da50d002c0aaf","562be0bd5a39cd0d009aff75","57a0b476d8313e1900454439"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"2.0.0","version":"2"},"editedParams":true,"editedParams2":true,"__v":2,"category":{"_id":"55f0365c8563861700a33765","version":"55dd9f4dab0e4d210045aae9","__v":10,"pages":["560d337799bb5a0d0044f2ae","560d3c1799bb5a0d0044f2b9","560e8b1fdfdd5a2100e8efd8","560e8c31c4e4ae0d00b42f3e","560e8f5159cb8d0d0015cd21","560e8faccac9dc0d007af836","560e915739fad419002ae1a6","560e9264c4e4ae0d00b42f4a","560e954d39fad419002ae1aa","561fb03b9dc7ce0d00c38c90"],"project":"55dd9f2e0efd5821000d54d9","sync":{"url":"","isSync":false},"reference":false,"createdAt":"2015-09-09T13:38:36.012Z","from_sync":false,"order":16,"slug":"transactional-data","title":"Transactional data"},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2015-10-02T14:19:16.626Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"settings":"","examples":{"codes":[{"language":"csharp","code":"var url = \"/v2/contacts/transactional-data/import/842d81e8-c619-457f-bb77-ab6c4a17da39\";\n\nusing (var httpClient = new HttpClient())\n{\n\thttpClient.BaseAddress = new Uri(\"https://api.dotmailer.com\");\n\tvar credentials = Encoding.ASCII.GetBytes(\"username:password\");\n\thttpClient.DefaultRequestHeaders.Authorization = new AuthenticationHeaderValue(\"Basic\", Convert.ToBase64String(credentials));\n\tvar result = httpClient.GetAsync(url).Result;\n}","name":""},{"language":"json","code":""},{"code":"$url = $baseUrl . ”/v2/contacts/transactional-data/import/842d81e8-c619-457f-bb77-ab6c4a17da39\";\n$ch = curl_init();\ncurl_setopt($ch, CURLOPT_URL, $url);\ncurl_setopt($ch, CURLOPT_RETURNTRANSFER, true);\ncurl_setopt(\n\t$ch, CURLOPT_HTTPHEADER, array('Accept: application/json',\n    \t'Content-Type: application/json')\n);\ncurl_setopt($ch, CURLAUTH_BASIC, CURLAUTH_DIGEST);\ncurl_setopt(\n\t$ch, CURLOPT_USERPWD,\n    $apiUsername . ':' . $apiPassword\n);\n\t\t\t\n$response = json_decode(curl_exec($ch));","language":"php"}]},"method":"get","results":{"codes":[{"language":"json","code":"{\n  \"id\": \"842d81e8-c619-457f-bb77-ab6c4a17da39\",\n  \"status\": \"Finished\"\n}","name":"","status":200}]},"auth":"required","params":[{"_id":"560d3313ac2859170013fb14","ref":"","in":"path","required":true,"desc":"The import ID of the transactional data import, which needs to be included within the URL. The import ID is a GUID, looking something like 842d81e8-c619-457f-bb77-ab6c4a17da39.","default":"","type":"int","name":"ID"}],"url":"/v:version/contacts/transactional-data/import/[ID]"},"isReference":false,"order":2,"body":"This operation gets the progress of a transactional data import. \n\nThe possible status types are:\n\n  * 'NotStarted' - The import has been accepted, but has not yet started to process\n  * 'NotFinished' - The import has been accepted, and has started but is yet to finish\n  * 'Finished' - The import has successfully finished processing\n  * 'Failed' - The import failed processing\n  * 'NotAvailableInThisVersion' - This feature is not available in the version of the API you're using","excerpt":"Gets the import status of a previously started transactional data import","slug":"get-transactional-data-import-status","type":"endpoint","title":"Get transactional data import status"}

getGet transactional data import status

Gets the import status of a previously started transactional data import

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

ID:
required
integer
The import ID of the transactional data import, which needs to be included within the URL. The import ID is a GUID, looking something like 842d81e8-c619-457f-bb77-ab6c4a17da39.

Examples


Result Format


Documentation

This operation gets the progress of a transactional data import. The possible status types are: * 'NotStarted' - The import has been accepted, but has not yet started to process * 'NotFinished' - The import has been accepted, and has started but is yet to finish * 'Finished' - The import has successfully finished processing * 'Failed' - The import failed processing * 'NotAvailableInThisVersion' - This feature is not available in the version of the API you're using