{"_id":"560025601503430d007cc75c","user":"55dd9841cafe7221002a4c62","category":{"_id":"55f036e92911b72100482cd9","version":"55dd9f4dab0e4d210045aae9","project":"55dd9f2e0efd5821000d54d9","__v":6,"pages":["56001a080c703d1900953023","56001b8bfeaf310d007dd748","56001d260c703d1900953024","560023591503430d007cc75a","560025601503430d007cc75c","56002f480c703d1900953033"],"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2015-09-09T13:40:57.710Z","from_sync":false,"order":10,"slug":"programs","title":"Programs"},"editedParams":true,"editedParams2":true,"parentDoc":null,"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"},"project":"55dd9f2e0efd5821000d54d9","__v":2,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2015-09-21T15:42:24.576Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[{"language":"csharp","code":"var url = \"/v2/programs/enrolments/processing\";\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}"},{"code":"","language":"json"},{"code":"$url = $baseUrl . “/v2/programs/enrolments/proccessing“;\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":[{"status":200,"language":"json","code":"[\n  {\n    \"id\": \"221234c3-d15b-4b9b-bccc-87b695ef4479\",\n    \"programId\": 3,\n    \"status\": \"Processing\",\n    \"dateCreated\": \"2015-01-01T00:00:00\",\n    \"contacts\": null,\n    \"addressBooks\": [\n      1,\n      2\n    ]\n  },\n  {\n    \"id\": \"55b94c35-092c-41bc-ace8-3de45631b436\",\n    \"programId\": 4,\n    \"status\": \"Processing\",\n    \"dateCreated\": \"2015-01-01T00:00:00\",\n    \"contacts\": [\n      1,\n      2\n    ],\n    \"addressBooks\": null\n  }\n]","name":""}]},"settings":"","auth":"required","params":[{"_id":"56000f150c703d190095300a","ref":"","in":"path","required":true,"desc":"The program enrolment status, which needs to be included within the URL","default":"'processing', 'finished'","type":"string","name":"Status"},{"_id":"5600272f9e7ccf0d000a1ebf","ref":"","in":"query","required":false,"desc":"The select parameter requires a number between 1 and 1000 (0 is not a valid number). You may only select a maximum of 1000 results in a single request. This parameter goes within the URL.","default":"","type":"int","name":"Select"},{"_id":"5600272f9e7ccf0d000a1ebe","ref":"","in":"query","required":false,"desc":"The skip parameter should be used in tandem with the select parameter when wanting to iterate through a whole data set. If you want to select the next 1000 records you should set the select parameter to 1000 and the skip parameter to 1000, which will return records 1001 to 2000. You should continue to do this until 0 records are returned to retrieve the whole data set. This parameter goes within the URL.","default":"","type":"int","name":"Skip"}],"url":"/v:version/programs/enrolments/[Status]?select=[Select]&skip=[Skip]"},"isReference":false,"order":5,"body":"This operation retrieves program enrolments by status.\n\nThe possible status types are:\n\n'Processing' - The enrolment is currently processing and has yet to finish\n'Finished' - The enrolment has finished processing\n'NotAvailableInThisVersion' - This feature is not available in the version of the API you're using","excerpt":"Gets program enrolments by status","slug":"get-program-enrolment-by-status","type":"endpoint","title":"Get program enrolments by status"}

getGet program enrolments by status

Gets program enrolments by status

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

Status:
required
string'processing', 'finished'
The program enrolment status, which needs to be included within the URL

Query Params

Select:
integer
The select parameter requires a number between 1 and 1000 (0 is not a valid number). You may only select a maximum of 1000 results in a single request. This parameter goes within the URL.
Skip:
integer
The skip parameter should be used in tandem with the select parameter when wanting to iterate through a whole data set. If you want to select the next 1000 records you should set the select parameter to 1000 and the skip parameter to 1000, which will return records 1001 to 2000. You should continue to do this until 0 records are returned to retrieve the whole data set. This parameter goes within the URL.

Examples


Result Format


Documentation

This operation retrieves program enrolments by status. The possible status types are: 'Processing' - The enrolment is currently processing and has yet to finish 'Finished' - The enrolment has finished processing 'NotAvailableInThisVersion' - This feature is not available in the version of the API you're using