{"info":{"_postman_id":"5719ada4-bd22-4de8-bfb6-1e3f2bbd8287","name":"CCD CP API","description":"<html><head></head><body><h1 id=\"the-control-panel-api\">The Control Panel API</h1>\n<p>Documentation for the general CCD Control Panel APIs</p>\n<h1 id=\"authentication\">Authentication</h1>\n<p>To authenticate with the API you will be given a <code>public key</code> and a <code>secret key</code>.</p>\n<p>You must send a time-sensitive hash with each of your requests.</p>\n<p>A hash is an SHA512 hash of your <code>secret key</code> prefixed with the current UNIX timestamp (in seconds).</p>\n<p>Javascript example:</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code>var your_secret_key = \"4a6asd0879asf07sadfs0d9fg7sdf098\";\nvar timestamp = Math.floor(Date.now() / 1000);\nvar hash = CryptoJS.SHA512(timestamp.toString() + your_secret_key));\n</code></pre><p>PHP example:</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code>&lt;?php\n$secret_key = \"4a6asd0879asf07sadfs0d9fg7sdf098\";\n$timestamp = time();\n$hash = hash('sha512', $timestamp.$secret_key);\n?&gt;\n</code></pre><p>Most API calls below will ask for the <code>timestamp</code>, <code>public_key</code>, and <code>hash</code> for your request to be granted.</p>\n<p>Please contact the CCD team if you require a new pair of keys.</p>\n</body></html>","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"The Control Panel API","slug":"the-control-panel-api"},{"content":"Authentication","slug":"authentication"}],"owner":"7882420","collectionId":"5719ada4-bd22-4de8-bfb6-1e3f2bbd8287","publishedId":"TVRj5UAZ","public":true,"customColor":{"top-bar":"333","right-sidebar":"303030","highlight":"F91F34"},"publishDate":"2020-10-08T10:42:02.000Z"},"item":[{"name":"get_recent_applications","event":[{"listen":"prerequest","script":{"id":"9c3aebd0-c7c5-4928-9acc-357032b5046b","exec":["var timestamp = Math.floor(Date.now() / 1000);\r","pm.variables.set(\"timestamp\", timestamp);\r","var hash = CryptoJS.SHA512(timestamp.toString() + pm.environment.get(\"secret_key\"));\r","pm.variables.set(\"hash\", hash.toString(CryptoJS.enc.Hex));"],"type":"text/javascript","packages":{},"requests":{}}}],"id":"844c2373-627a-40c9-ada7-3174d73d42cb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{endpoint}}/webservices/v2/ws_ap_api.php?timestamp={{the-current-timestamp}}&public_key={{public_key}}&hash={{your-generated-hash}}&mode=get_recent_applications&timestamp_from=1598914800","description":"<p>Response could include fields that are custom to this system's registration form.</p>\n<p>These will be prefixed with <code>reg_field_</code> followed by the unique ID of that field.</p>\n<p>When this occurs a <code>reg_field_map</code> array will also be included to show each registration field ID with it's corresponding field name.</p>\n","urlObject":{"path":["webservices","v2","ws_ap_api.php"],"host":["{{endpoint}}"],"query":[{"description":{"content":"<p>Current timestamp, see <a href=\"#authentication\">Authentication</a></p>\n","type":"text/plain"},"key":"timestamp","value":"{{the-current-timestamp}}"},{"description":{"content":"<p>Your public key, see <a href=\"#authentication\">Authentication</a></p>\n","type":"text/plain"},"key":"public_key","value":"{{public_key}}"},{"description":{"content":"<p>Your hash, see <a href=\"#authentication\">Authentication</a></p>\n","type":"text/plain"},"key":"hash","value":"{{your-generated-hash}}"},{"description":{"content":"<p>Request mode</p>\n","type":"text/plain"},"key":"mode","value":"get_recent_applications"},{"description":{"content":"<p>UNIX timestamp, applications created before this date won't be shown</p>\n","type":"text/plain"},"key":"timestamp_from","value":"1598914800"},{"disabled":true,"description":{"content":"<p>Defaults to false as this is a more costly operation</p>\n","type":"text/plain"},"key":"include_progress_percentage","value":"true"},{"disabled":true,"description":{"content":"<p>Retrieve only completed applications, default false</p>\n","type":"text/plain"},"key":"completed_only","value":"true"},{"disabled":true,"description":{"content":"<p>(UNIX timestamp) Retrieve only applications updated since this date</p>\n","type":"text/plain"},"key":"from_date_last_updated","value":"1765972660"}],"variable":[]}},"response":[{"id":"1a6e2430-3b6c-488e-92bd-cd3dbcc32e88","name":"get_recent_applications example","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{endpoint}}/webservices/v2/ws_ap_api.php?timestamp={{the-current-timestamp}}&public_key={{public_key}}&hash={{your-generated-hash}}&mode=get_recent_applications&timestamp_from=1598914800","host":["{{endpoint}}"],"path":["webservices","v2","ws_ap_api.php"],"query":[{"key":"timestamp","value":"{{the-current-timestamp}}","description":"Current timestamp, see [Authentication](#authentication)"},{"key":"public_key","value":"{{public_key}}","description":"Your public key, see [Authentication](#authentication)"},{"key":"hash","value":"{{your-generated-hash}}","description":"Your hash, see [Authentication](#authentication)"},{"key":"mode","value":"get_recent_applications","description":"Request mode"},{"key":"timestamp_from","value":"1598914800","description":"UNIX timestamp, applications created before this date won't be shown"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Fri, 16 Oct 2020 15:11:10 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"2101"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"PHP/7.3.23"},{"key":"X-Powered-By","value":"PleskLin"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Cache-Control","value":"s-maxage=10"},{"key":"Pragma","value":"no-cache"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n    \"code\": 1,\n    \"message\": \"Success\",\n    \"reg_field_map\": {\n        \"34166\": \"Telephone / Mobile Number\",\n        \"34167\": \"Post Code\",\n        \"34170\": \"Nationality\"\n    },\n    \"applications\": [\n        {\n            \"id\": 884,\n            \"status\": \"application_form\",\n            \"date_created\": 1602169929,\n            \"date_last_updated\": 1602179929,\n            \"date_completed\": null,\n            \"recipient_cpda_id\": \"13369\",\n            \"user_id\": 1863,\n            \"user_firstname\": \"John\",\n            \"user_surname\": \"Smith\",\n            \"user_email\": \"john.smith@gmail.com\",\n            \"view_edit_url\": \"https://portal-url.com/ap_index.php?assist_application=884\",\n            \"reg_field_34166\": \"0208 123 4567\",\n            \"reg_field_34167\": \"ub9 6bz\",\n            \"reg_field_34170\": \"GB\"\n        },\n        {\n            \"id\": 879,\n            \"status\": \"invite_pending\",\n            \"date_created\": 1600676026,\n            \"date_last_updated\": 1600686026,\n            \"date_completed\": null,\n            \"recipient_cpda_id\": \"13369\",\n            \"user_id\": 1858,\n            \"user_firstname\": \"Sally\",\n            \"user_surname\": \"Armstrong\",\n            \"user_email\": \"sally.armstrong@hotmail.co.uk\",\n            \"view_edit_url\": \"https://portal-url.com/ap_index.php?assist_application=879\",\n            \"reg_field_34166\": \"0208 123 4567\",\n            \"reg_field_34167\": \"TR4 8du\",\n            \"reg_field_34170\": \"US\"\n        }\n        // ...\n    ]\n}"}],"_postman_id":"844c2373-627a-40c9-ada7-3174d73d42cb"},{"name":"get_application_registration_fields","event":[{"listen":"prerequest","script":{"id":"345a6430-ec80-45ed-8f4a-2b5f892a6130","exec":["var timestamp = Math.floor(Date.now() / 1000);\r","pm.variables.set(\"timestamp\", timestamp);\r","var hash = CryptoJS.SHA512(timestamp.toString() + pm.environment.get(\"secret_key\"));\r","pm.variables.set(\"hash\", hash.toString(CryptoJS.enc.Hex));"],"type":"text/javascript","packages":{},"requests":{}}}],"id":"92d589c2-d35a-48cc-ad2c-665cb66004d7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{endpoint}}/webservices/v2/ws_ap_api.php?timestamp={{the-current-timestamp}}&public_key={{public_key}}&hash={{your-generated-hash}}&mode=get_application_registration_fields","description":"<p>Returns an array of registration field IDs with corresponding field names that are custom to this system's registration form.</p>\n","urlObject":{"path":["webservices","v2","ws_ap_api.php"],"host":["{{endpoint}}"],"query":[{"description":{"content":"<p>Current timestamp, see <a href=\"#authentication\">Authentication</a></p>\n","type":"text/plain"},"key":"timestamp","value":"{{the-current-timestamp}}"},{"description":{"content":"<p>Your public key, see <a href=\"#authentication\">Authentication</a></p>\n","type":"text/plain"},"key":"public_key","value":"{{public_key}}"},{"description":{"content":"<p>Your hash, see <a href=\"#authentication\">Authentication</a></p>\n","type":"text/plain"},"key":"hash","value":"{{your-generated-hash}}"},{"description":{"content":"<p>Request mode</p>\n","type":"text/plain"},"key":"mode","value":"get_application_registration_fields"}],"variable":[]}},"response":[{"id":"06e3b997-c749-480f-8f0a-8d298668e25d","name":"get_application_registration_fields","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{endpoint}}/webservices/v2/ws_ap_api.php?timestamp={{the-current-timestamp}}&public_key={{public_key}}&hash={{your-generated-hash}}&mode=get_application_registration_fields","host":["{{endpoint}}"],"path":["webservices","v2","ws_ap_api.php"],"query":[{"key":"timestamp","value":"{{the-current-timestamp}}","description":"Current timestamp, see [Authentication](#authentication)"},{"key":"public_key","value":"{{public_key}}","description":"Your public key, see [Authentication](#authentication)"},{"key":"hash","value":"{{your-generated-hash}}","description":"Your hash, see [Authentication](#authentication)"},{"key":"mode","value":"get_application_registration_fields","description":"Request mode"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Mon, 19 Oct 2020 16:24:34 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"214"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"PHP/7.3.23"},{"key":"X-Powered-By","value":"PleskLin"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Cache-Control","value":"s-maxage=10"},{"key":"Pragma","value":"no-cache"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n    \"code\": 1,\n    \"message\": \"Success\",\n    \"reg_field_map\": {\n        \"34166\": \"Telephone / Mobile Number\",\n        \"34167\": \"Post Code\",\n        \"34170\": \"Nationality\",\n    }\n}"}],"_postman_id":"92d589c2-d35a-48cc-ad2c-665cb66004d7"},{"name":"get_application_recipient_options","event":[{"listen":"prerequest","script":{"id":"345a6430-ec80-45ed-8f4a-2b5f892a6130","exec":["var timestamp = Math.floor(Date.now() / 1000);\r","pm.variables.set(\"timestamp\", timestamp);\r","var hash = CryptoJS.SHA512(timestamp.toString() + pm.environment.get(\"secret_key\"));\r","pm.variables.set(\"hash\", hash.toString(CryptoJS.enc.Hex));"],"type":"text/javascript"}}],"id":"63384156-9255-400b-9602-edae0e7cf0f1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{endpoint}}/webservices/v2/ws_ap_api.php?timestamp={{the-current-timestamp}}&public_key={{public_key}}&hash={{your-generated-hash}}&mode=get_application_recipient_options","description":"<p>Returns an array of registration recipient IDs with corresponding names that are custom to this system's registration form.</p>\n","urlObject":{"path":["webservices","v2","ws_ap_api.php"],"host":["{{endpoint}}"],"query":[{"description":{"content":"<p>Current timestamp, see <a href=\"#authentication\">Authentication</a></p>\n","type":"text/plain"},"key":"timestamp","value":"{{the-current-timestamp}}"},{"description":{"content":"<p>Your public key, see <a href=\"#authentication\">Authentication</a></p>\n","type":"text/plain"},"key":"public_key","value":"{{public_key}}"},{"description":{"content":"<p>Your hash, see <a href=\"#authentication\">Authentication</a></p>\n","type":"text/plain"},"key":"hash","value":"{{your-generated-hash}}"},{"description":{"content":"<p>Request mode</p>\n","type":"text/plain"},"key":"mode","value":"get_application_recipient_options"}],"variable":[]}},"response":[{"id":"bc4714e1-e4a0-4931-ad95-a3ae27c4f29f","name":"get_application_recipient_options","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{endpoint}}/webservices/v2/ws_ap_api.php?timestamp={{the-current-timestamp}}&public_key={{public_key}}&hash={{your-generated-hash}}&mode=get_application_recipient_options","host":["{{endpoint}}"],"path":["webservices","v2","ws_ap_api.php"],"query":[{"key":"timestamp","value":"{{the-current-timestamp}}","description":"Current timestamp, see [Authentication](#authentication)"},{"key":"public_key","value":"{{public_key}}","description":"Your public key, see [Authentication](#authentication)"},{"key":"hash","value":"{{your-generated-hash}}","description":"Your hash, see [Authentication](#authentication)"},{"key":"mode","value":"get_application_recipient_options","description":"Request mode"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Wed, 13 Jul 2022 13:33:45 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"334"},{"key":"Connection","value":"keep-alive"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Cache-Control","value":"s-maxage=10"},{"key":"Pragma","value":"no-cache"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Content-Encoding","value":"gzip"},{"key":"X-XSS-Protection","value":"0"}],"cookie":[],"responseTime":null,"body":"{\n    \"code\": 1,\n    \"message\": \"Success\",\n    \"recipient_options_map\": {\n        \"10000\": \"Birmingham\",\n        \"10001\": \"Cambridge\",\n        \"10002\": \"Cardiff\",\n        \"10003\": \"Exeter\",\n        \"10004\": \"Glasgow\",\n        \"10005\": \"London\",\n        \"10006\": \"Leeds\",\n        \"10007\": \"Manchester\",\n        \"10008\": \"Dublin\",\n        \"10009\": \"Galway\",\n        \"-5999\": \"Default\"\n    }\n}"}],"_postman_id":"63384156-9255-400b-9602-edae0e7cf0f1"},{"name":"create_application_with_form_data","event":[{"listen":"prerequest","script":{"id":"7ab4cee3-76a7-4b2c-9332-f2cc0e2a8b96","exec":["var timestamp = Math.floor(Date.now() / 1000);\r","pm.variables.set(\"timestamp\", timestamp);\r","var hash = CryptoJS.SHA512(timestamp.toString() + pm.environment.get(\"secret_key\"));\r","pm.variables.set(\"hash\", hash.toString(CryptoJS.enc.Hex));"],"type":"text/javascript"}}],"id":"56126a2d-c229-4dff-84fb-fecb14235225","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"cv","description":"<p>Optional CV File</p>\n","type":"file","src":"/C:/Users/beckf/Desktop/testfile.pdf"}]},"url":"{{endpoint}}/webservices/v2/ws_ap_api.php?timestamp={{the-current-timestamp}}&public_key={{public_key}}&hash={{your-generated-hash}}&mode=create_application_with_form_data&source={{your_application_name}}&first_name=John&surname=Smith&email_address=Emilie.Stehr52@gmail.com&recipient_cpda_id={{recipient_cpda_id}}&reg_field_34166=01895 123 456&extra_tracking_data={\"rcv_id\":123}","description":"<h2 id=\"custom-fields\">Custom Fields</h2>\n<p>Posts can include fields that are custom to this system's registration form.</p>\n<p>These should be prefixed with <code>reg_field_</code> followed by the unique ID of that field.</p>\n<h2 id=\"json-format\">JSON Format</h2>\n<p>Posts can optionally include the fields as a JSON string field <code>json_form_data</code> instead if preferable</p>\n","urlObject":{"path":["webservices","v2","ws_ap_api.php"],"host":["{{endpoint}}"],"query":[{"description":{"content":"<p>Current timestamp, see <a href=\"#authentication\">Authentication</a></p>\n","type":"text/plain"},"key":"timestamp","value":"{{the-current-timestamp}}"},{"description":{"content":"<p>Your public key, see <a href=\"#authentication\">Authentication</a></p>\n","type":"text/plain"},"key":"public_key","value":"{{public_key}}"},{"description":{"content":"<p>Your hash, see <a href=\"#authentication\">Authentication</a></p>\n","type":"text/plain"},"key":"hash","value":"{{your-generated-hash}}"},{"description":{"content":"<p>Request mode</p>\n","type":"text/plain"},"key":"mode","value":"create_application_with_form_data"},{"description":{"content":"<p>A string defining the name of your application, eg \"Salesforce\" (for logging purposes)</p>\n","type":"text/plain"},"key":"source","value":"{{your_application_name}}"},{"description":{"content":"<p>First name of applicant</p>\n","type":"text/plain"},"key":"first_name","value":"John"},{"description":{"content":"<p>Surname of applicant</p>\n","type":"text/plain"},"key":"surname","value":"Smith"},{"description":{"content":"<p>Email address of applicant</p>\n","type":"text/plain"},"key":"email_address","value":"Kristina_Spinka99@yahoo.com"},{"description":{"content":"<p>(optional) ID corresponding to the application recipient, see <a href=\"#63384156-9255-400b-9602-edae0e7cf0f1\">get_application_recipient_options</a></p>\n","type":"text/plain"},"key":"recipient_cpda_id","value":"{{recipient_cpda_id}}"},{"description":{"content":"<p>Example custom registration field, in this case a phone number</p>\n","type":"text/plain"},"key":"reg_field_34166","value":"01895 123 456"},{"key":"extra_tracking_data","value":"{\"rcv_id\":123}"}],"variable":[]}},"response":[{"id":"81a1241c-ae1f-45e5-826d-1dc15126dbee","name":"create_application_with_form_data example","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"cv","description":"Optional CV File","type":"file","src":"/C:/Users/beckf/Desktop/testfile.pdf"}],"options":{"raw":{"language":"json"}}},"url":{"raw":"{{endpoint}}/webservices/v2/ws_ap_api.php?timestamp={{the-current-timestamp}}&public_key={{public_key}}&hash={{your-generated-hash}}&mode=create_application_with_form_data&first_name=John&surname=Smith&email_address=john+1@smith.com&recipient_cpda_id={{recipient_cpda_id}}&source={{your_application_name}}&reg_field_34166=01895 123 456","host":["{{endpoint}}"],"path":["webservices","v2","ws_ap_api.php"],"query":[{"key":"timestamp","value":"{{the-current-timestamp}}","description":"Current timestamp, see [Authentication](#authentication)"},{"key":"public_key","value":"{{public_key}}","description":"Your public key, see [Authentication](#authentication)"},{"key":"hash","value":"{{your-generated-hash}}","description":"Your hash, see [Authentication](#authentication)"},{"key":"mode","value":"create_application_with_form_data","description":"Request mode"},{"key":"first_name","value":"John","description":"First name of applicant"},{"key":"surname","value":"Smith","description":"Surname of applicant"},{"key":"email_address","value":"john+1@smith.com","description":"Email address of applicant"},{"key":"recipient_cpda_id","value":"{{recipient_cpda_id}}","description":"(optional) ID corresponding to the application recipient"},{"key":"source","value":"{{your_application_name}}","description":"A string defining the name of your application, eg \"Salesforce\" (for logging purposes)"},{"key":"reg_field_34166","value":"01895 123 456","description":"Example custom registration field, in this case a phone number"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Fri, 16 Oct 2020 15:41:47 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"73"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"PHP/7.3.23"},{"key":"X-Powered-By","value":"PleskLin"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Set-Cookie","value":"ccd_lang=-1999; expires=Thu, 14-Jan-2021 15:41:47 GMT; Max-Age=7776000; path=/"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n    \"code\": 1,\n    \"message\": \"Created registration successfully\"\n}"}],"_postman_id":"56126a2d-c229-4dff-84fb-fecb14235225"},{"name":"modify_application_registration","event":[{"listen":"prerequest","script":{"id":"6fb51b25-49e1-469b-8fae-00333f23017c","exec":["var timestamp = Math.floor(Date.now() / 1000);\r","pm.variables.set(\"timestamp\", timestamp);\r","var hash = CryptoJS.SHA512(timestamp.toString() + pm.environment.get(\"secret_key\"));\r","pm.variables.set(\"hash\", hash.toString(CryptoJS.enc.Hex));"],"type":"text/javascript"}}],"id":"bd2021e6-7f0a-48b9-9bfd-1a0983ca6d63","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"cv","description":"<p>Optional CV File</p>\n","type":"file","src":"testfile.pdf"}]},"url":"{{endpoint}}/webservices/v2/ws_ap_api.php?timestamp={{the-current-timestamp}}&public_key={{public_key}}&hash={{your-generated-hash}}&mode=modify_application_registration&id=884&source={{your_application_name}}&reg_field_12345=01895 123 456","description":"<h2 id=\"custom-fields\">Custom Fields</h2>\n<p>Posts can include fields that are custom to this system's registration form.</p>\n<p>These should be prefixed with <code>reg_field_</code> followed by the unique ID of that field.</p>\n<h2 id=\"json-format\">JSON Format</h2>\n<p>Posts can optionally include the fields as a JSON string field <code>json_form_data</code> instead if preferable</p>\n","urlObject":{"path":["webservices","v2","ws_ap_api.php"],"host":["{{endpoint}}"],"query":[{"description":{"content":"<p>Current timestamp, see <a href=\"#authentication\">Authentication</a></p>\n","type":"text/plain"},"key":"timestamp","value":"{{the-current-timestamp}}"},{"description":{"content":"<p>Your public key, see <a href=\"#authentication\">Authentication</a></p>\n","type":"text/plain"},"key":"public_key","value":"{{public_key}}"},{"description":{"content":"<p>Your hash, see <a href=\"#authentication\">Authentication</a></p>\n","type":"text/plain"},"key":"hash","value":"{{your-generated-hash}}"},{"description":{"content":"<p>Request mode</p>\n","type":"text/plain"},"key":"mode","value":"modify_application_registration"},{"description":{"content":"<p>The application ID corresponding to the application you wish to modify</p>\n","type":"text/plain"},"key":"id","value":"884"},{"description":{"content":"<p>A string defining the name of your application, eg \"Salesforce\" (for logging purposes)</p>\n","type":"text/plain"},"key":"source","value":"{{your_application_name}}"},{"disabled":true,"description":{"content":"<p>(optional) First name of applicant</p>\n","type":"text/plain"},"key":"first_name","value":"John"},{"disabled":true,"description":{"content":"<p>(optional) Surname of applicant</p>\n","type":"text/plain"},"key":"surname","value":"Smith"},{"disabled":true,"description":{"content":"<p>(optional) ID corresponding to the application recipient, see <a href=\"#63384156-9255-400b-9602-edae0e7cf0f1\">get_application_recipient_options</a></p>\n","type":"text/plain"},"key":"recipient_cpda_id","value":"{{recipient_cpda_id}}"},{"description":{"content":"<p>(optional) Example custom registration field, in this case a phone number\nFor a list of available registration fields call <a href=\"#92d589c2-d35a-48cc-ad2c-665cb66004d7\">get_registration_fields</a></p>\n","type":"text/plain"},"key":"reg_field_12345","value":"01895 123 456"}],"variable":[]}},"response":[{"id":"e7f8f162-f0e7-4e45-aeb8-f64ec4d2f749","name":"Example modifying just one custom registration field","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"description":"Optional CV File","key":"cv","type":"file","src":"/C:/Users/beckf/Desktop/testfile.pdf"}],"options":{"raw":{"language":"json"}}},"url":{"raw":"{{endpoint}}/webservices/v2/ws_ap_api.php?timestamp={{the-current-timestamp}}&public_key={{public_key}}&hash={{your-generated-hash}}&mode=modify_application_registration&id=123&source={{your_application_name}}&reg_field_12345=01895 123 456","host":["{{endpoint}}"],"path":["webservices","v2","ws_ap_api.php"],"query":[{"key":"timestamp","value":"{{the-current-timestamp}}","description":"Current timestamp, see [Authentication](#authentication)"},{"key":"public_key","value":"{{public_key}}","description":"Your public key, see [Authentication](#authentication)"},{"key":"hash","value":"{{your-generated-hash}}","description":"Your hash, see [Authentication](#authentication)"},{"key":"mode","value":"modify_application_registration","description":"Request mode"},{"key":"id","value":"123","description":"The application ID corresponding to the application you wish to modify"},{"key":"source","value":"{{your_application_name}}","description":"A string defining the name of your application, eg \"Salesforce\" (for logging purposes)"},{"key":"first_name","value":"John","description":"(optional) First name of applicant","disabled":true},{"key":"surname","value":"Smith","description":"(optional) Surname of applicant","disabled":true},{"key":"recipient_cpda_id","value":"{{recipient_cpda_id}}","description":"(optional) ID corresponding to the application recipient","disabled":true},{"key":"reg_field_12345","value":"01895 123 456","description":"(optional) Example custom registration field, in this case a phone number"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Mon, 19 Oct 2020 16:14:01 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"74"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"PHP/7.3.23"},{"key":"X-Powered-By","value":"PleskLin"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Set-Cookie","value":"ccd_lang=-1999; expires=Sun, 17-Jan-2021 16:14:01 GMT; Max-Age=7776000; path=/"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n    \"code\": 1,\n    \"message\": \"Modified registration successfully\"\n}"},{"id":"f8127268-567e-4d9d-9216-b5bef6919291","name":"Example changing multiple fields","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"description":"Optional CV File","key":"cv","type":"file","src":"/C:/Users/beckf/Desktop/testfile.pdf"}],"options":{"raw":{"language":"json"}}},"url":{"raw":"{{endpoint}}/webservices/v2/ws_ap_api.php?timestamp={{the-current-timestamp}}&public_key={{public_key}}&hash={{your-generated-hash}}&mode=modify_application_registration&id=123&source={{your_application_name}}&first_name=John&surname=Smith&recipient_cpda_id={{recipient_cpda_id}}&reg_field_12345=01895 123 456","host":["{{endpoint}}"],"path":["webservices","v2","ws_ap_api.php"],"query":[{"key":"timestamp","value":"{{the-current-timestamp}}","description":"Current timestamp, see [Authentication](#authentication)"},{"key":"public_key","value":"{{public_key}}","description":"Your public key, see [Authentication](#authentication)"},{"key":"hash","value":"{{your-generated-hash}}","description":"Your hash, see [Authentication](#authentication)"},{"key":"mode","value":"modify_application_registration","description":"Request mode"},{"key":"id","value":"123","description":"The application ID corresponding to the application you wish to modify"},{"key":"source","value":"{{your_application_name}}","description":"A string defining the name of your application, eg \"Salesforce\" (for logging purposes)"},{"key":"first_name","value":"John","description":"(optional) First name of applicant"},{"key":"surname","value":"Smith","description":"(optional) Surname of applicant"},{"key":"recipient_cpda_id","value":"{{recipient_cpda_id}}","description":"(optional) ID corresponding to the application recipient"},{"key":"reg_field_12345","value":"01895 123 456","description":"(optional) Example custom registration field, in this case a phone number"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Mon, 19 Oct 2020 16:12:30 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"74"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"PHP/7.3.23"},{"key":"X-Powered-By","value":"PleskLin"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Set-Cookie","value":"ccd_lang=-1999; expires=Sun, 17-Jan-2021 16:12:30 GMT; Max-Age=7776000; path=/"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n    \"code\": 1,\n    \"message\": \"Modified registration successfully\"\n}"}],"_postman_id":"bd2021e6-7f0a-48b9-9bfd-1a0983ca6d63"},{"name":"get_application_files","event":[{"listen":"prerequest","script":{"id":"6fb51b25-49e1-469b-8fae-00333f23017c","exec":["var timestamp = Math.floor(Date.now() / 1000);\r","pm.variables.set(\"timestamp\", timestamp);\r","var hash = CryptoJS.SHA512(timestamp.toString() + pm.environment.get(\"secret_key\"));\r","pm.variables.set(\"hash\", hash.toString(CryptoJS.enc.Hex));"],"type":"text/javascript","packages":{},"requests":{}}},{"listen":"test","script":{"id":"20f4e27b-c7b9-4a2f-9abf-c47116876f4c","exec":[""],"type":"text/javascript","packages":{},"requests":{}}}],"id":"e74bb4e2-b806-445b-82e7-3363dd24e520","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{endpoint}}/webservices/v2/ws_ap_api.php?timestamp={{the-current-timestamp}}&public_key={{public_key}}&hash={{your-generated-hash}}&mode=get_application_files&id=42638&type=all","description":"<h2 id=\"return-type\">Return Type</h2>\n<p>If the request is valid the file (.zip or .pdf depending on the <code>type</code> specified) will be returned directly. On error, JSON is returned describing the error.</p>\n<h2 id=\"type\">Type</h2>\n<p><code>The type</code> parameter can be set to one of 3 values:</p>\n<ul>\n<li><p><code>all</code> - Returns a zip file containing the completed application PDF and any additional form file uploads (including CV if enabled)</p>\n</li>\n<li><p><code>application_pdf</code> - Returns the completed application PDF</p>\n</li>\n<li><p><code>additional_files_zip</code> - Returns a zip file containing any additional form file uploads (including CV if enabled)</p>\n</li>\n</ul>\n<h2 id=\"json-format\">JSON Format</h2>\n<p>Posts can optionally include the fields as a JSON string field <code>json_form_data</code> instead if preferable</p>\n","urlObject":{"path":["webservices","v2","ws_ap_api.php"],"host":["{{endpoint}}"],"query":[{"description":{"content":"<p>Current timestamp, see <a href=\"#authentication\">Authentication</a></p>\n","type":"text/plain"},"key":"timestamp","value":"{{the-current-timestamp}}"},{"description":{"content":"<p>Your public key, see <a href=\"#authentication\">Authentication</a></p>\n","type":"text/plain"},"key":"public_key","value":"{{public_key}}"},{"description":{"content":"<p>Your hash, see <a href=\"#authentication\">Authentication</a></p>\n","type":"text/plain"},"key":"hash","value":"{{your-generated-hash}}"},{"description":{"content":"<p>Request mode</p>\n","type":"text/plain"},"key":"mode","value":"get_application_files"},{"description":{"content":"<p>The application ID corresponding to the application you wish to modify</p>\n","type":"text/plain"},"key":"id","value":"42638"},{"description":{"content":"<p>all / application_pdf  / additional_files_zip </p>\n","type":"text/plain"},"key":"type","value":"all"}],"variable":[]}},"response":[{"id":"d995eeec-e1e0-4758-87a7-b740245d2cb9","name":"Application not found","originalRequest":{"method":"GET","header":[],"body":{"mode":"formdata","formdata":[]},"url":{"raw":"{{endpoint}}/webservices/v2/ws_ap_api.php?timestamp={{the-current-timestamp}}&public_key={{public_key}}&hash={{your-generated-hash}}&mode=get_application_files&id=7777&type=all","host":["{{endpoint}}"],"path":["webservices","v2","ws_ap_api.php"],"query":[{"key":"timestamp","value":"{{the-current-timestamp}}","description":"Current timestamp, see [Authentication](#authentication)"},{"key":"public_key","value":"{{public_key}}","description":"Your public key, see [Authentication](#authentication)"},{"key":"hash","value":"{{your-generated-hash}}","description":"Your hash, see [Authentication](#authentication)"},{"key":"mode","value":"get_application_files","description":"Request mode"},{"key":"id","value":"7777","description":"The application ID corresponding to the application you wish to modify"},{"key":"type","value":"all","description":"Returns a zip file containing the completed application PDF and any additional form file uploads (including CV if enabled)"},{"key":"type","value":"application_pdf ","description":"Returns the completed application PDF","type":"text","disabled":true},{"key":"type","value":"additional_files_zip ","description":"Returns a zip file containing any additional form file uploads (including CV if enabled)","type":"text","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Wed, 22 Mar 2023 11:51:49 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"78"},{"key":"Connection","value":"keep-alive"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Cache-Control","value":"s-maxage=10"},{"key":"Pragma","value":"no-cache"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Content-Encoding","value":"gzip"},{"key":"X-XSS-Protection","value":"0"}],"cookie":[],"responseTime":null,"body":"{\n    \"code\": 4,\n    \"message\": \"Couldn't find application with ID 7777\"\n}"},{"id":"768d87b5-22bc-4b73-ac86-72a97bf2d778","name":"Application not complete","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{endpoint}}/webservices/v2/ws_ap_api.php?timestamp={{the-current-timestamp}}&public_key={{public_key}}&hash={{your-generated-hash}}&mode=get_application_files&id=26&type=application_pdf","host":["{{endpoint}}"],"path":["webservices","v2","ws_ap_api.php"],"query":[{"key":"timestamp","value":"{{the-current-timestamp}}","description":"Current timestamp, see [Authentication](#authentication)"},{"key":"public_key","value":"{{public_key}}","description":"Your public key, see [Authentication](#authentication)"},{"key":"hash","value":"{{your-generated-hash}}","description":"Your hash, see [Authentication](#authentication)"},{"key":"mode","value":"get_application_files","description":"Request mode"},{"key":"id","value":"26","description":"The application ID corresponding to the application you wish to modify"},{"key":"type","value":"application_pdf","description":"all / application_pdf  / additional_files_zip "}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Thu, 30 Mar 2023 11:01:36 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"79"},{"key":"Connection","value":"keep-alive"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Cache-Control","value":"s-maxage=10"},{"key":"Pragma","value":"no-cache"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Content-Encoding","value":"gzip"},{"key":"X-XSS-Protection","value":"0"}],"cookie":[],"responseTime":null,"body":"{\n    \"code\": 6,\n    \"message\": \"Application with ID 26 is not complete\"\n}"}],"_postman_id":"e74bb4e2-b806-445b-82e7-3363dd24e520"},{"name":"get_all_form_fields_for_recipient","event":[{"listen":"prerequest","script":{"id":"345a6430-ec80-45ed-8f4a-2b5f892a6130","exec":["var timestamp = Math.floor(Date.now() / 1000);\r","pm.variables.set(\"timestamp\", timestamp);\r","var hash = CryptoJS.SHA512(timestamp.toString() + pm.environment.get(\"secret_key\"));\r","pm.variables.set(\"hash\", hash.toString(CryptoJS.enc.Hex));"],"type":"text/javascript"}}],"id":"77cfb133-80b5-49d0-9f2a-8904f5d1cb29","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{endpoint}}/webservices/v2/ws_ap_api.php?timestamp={{the-current-timestamp}}&public_key={{public_key}}&hash={{your-generated-hash}}&mode=get_all_form_fields_for_recipient&recipient_cpda_id=","description":"<p>Returns an array of all form steps, fields and subforms for the given recipient ID.</p>\n","urlObject":{"path":["webservices","v2","ws_ap_api.php"],"host":["{{endpoint}}"],"query":[{"description":{"content":"<p>Current timestamp, see <a href=\"#authentication\">Authentication</a></p>\n","type":"text/plain"},"key":"timestamp","value":"{{the-current-timestamp}}"},{"description":{"content":"<p>Your public key, see <a href=\"#authentication\">Authentication</a></p>\n","type":"text/plain"},"key":"public_key","value":"{{public_key}}"},{"description":{"content":"<p>Your hash, see <a href=\"#authentication\">Authentication</a></p>\n","type":"text/plain"},"key":"hash","value":"{{your-generated-hash}}"},{"description":{"content":"<p>Request mode</p>\n","type":"text/plain"},"key":"mode","value":"get_all_form_fields_for_recipient"},{"description":{"content":"<p>The ID of the recipient flow you are requesting form fields for</p>\n","type":"text/plain"},"key":"recipient_cpda_id","value":""}],"variable":[]}},"response":[{"id":"e3b289c2-1802-4039-b4b4-3bc9a8261ec1","name":"get_all_form_fields_for_recipient","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{endpoint}}/webservices/v2/ws_ap_api.php?timestamp={{the-current-timestamp}}&public_key={{public_key}}&hash={{your-generated-hash}}&mode=get_all_form_fields_for_recipient&recipient_cpda_id=59571","host":["{{endpoint}}"],"path":["webservices","v2","ws_ap_api.php"],"query":[{"key":"timestamp","value":"{{the-current-timestamp}}","description":"Current timestamp, see [Authentication](#authentication)"},{"key":"public_key","value":"{{public_key}}","description":"Your public key, see [Authentication](#authentication)"},{"key":"hash","value":"{{your-generated-hash}}","description":"Your hash, see [Authentication](#authentication)"},{"key":"mode","value":"get_all_form_fields_for_recipient","description":"Request mode"},{"key":"recipient_cpda_id","value":"59571","description":"The ID of the recipient flow you are requesting form fields for"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Mon, 18 Dec 2023 17:12:55 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Cache-Control","value":"s-maxage=10"},{"key":"Pragma","value":"no-cache"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-XSS-Protection","value":"0"}],"cookie":[],"responseTime":null,"body":"{\n    \"code\": 1,\n    \"message\": \"Success\",\n    \"recipient_cpda_id\": \"59571\",\n    \"forms\": [\n        {\n            \"id\": 59142,\n            \"title\": \"Test Form\",\n            \"fields\": [\n                {\n                    \"id\": 59147,\n                    \"title\": \"Test Field 1\",\n                    \"seq\": 0,\n                    \"type\": \"text\",\n                    \"type_key\": \"set_fieldtype_form_text\",\n                    \"manditory\": false,\n                    \"multiple\": false\n                },\n                {\n                    \"id\": 59148,\n                    \"title\": \"Test Field 2\",\n                    \"seq\": 1,\n                    \"type\": \"text\",\n                    \"type_key\": \"set_fieldtype_form_text\",\n                    \"manditory\": false,\n                    \"multiple\": false\n                },\n                {\n                    \"id\": 59149,\n                    \"title\": \"Test Field 3\",\n                    \"seq\": 2,\n                    \"type\": \"text\",\n                    \"type_key\": \"set_fieldtype_form_text\",\n                    \"manditory\": false,\n                    \"multiple\": false\n                }\n            ]\n        },\n        {\n            \"id\": 59183,\n            \"title\": \"ELIs Form\",\n            \"fields\": [\n                {\n                    \"id\": 59188,\n                    \"title\": \"Name\",\n                    \"seq\": 0,\n                    \"type\": \"text\",\n                    \"type_key\": \"set_fieldtype_form_text\",\n                    \"manditory\": false,\n                    \"multiple\": false\n                },\n                {\n                    \"id\": 59189,\n                    \"title\": \"Phone\",\n                    \"seq\": 1,\n                    \"type\": \"text\",\n                    \"type_key\": \"set_fieldtype_form_text\",\n                    \"manditory\": false,\n                    \"multiple\": false\n                },\n                {\n                    \"id\": 59190,\n                    \"title\": \"Email\",\n                    \"seq\": 2,\n                    \"type\": \"text\",\n                    \"type_key\": \"set_fieldtype_form_text\",\n                    \"manditory\": false,\n                    \"multiple\": false\n                },\n                {\n                    \"id\": 59433,\n                    \"title\": \"Doc 1\",\n                    \"seq\": 3,\n                    \"type\": \"doc_upload\",\n                    \"type_key\": \"set_fieldtype_form_doc_upload\",\n                    \"manditory\": false,\n                    \"multiple\": false\n                },\n                {\n                    \"id\": 59434,\n                    \"title\": \"Doc 2\",\n                    \"seq\": 4,\n                    \"type\": \"doc_upload\",\n                    \"type_key\": \"set_fieldtype_form_doc_upload\",\n                    \"manditory\": false,\n                    \"multiple\": false\n                }\n            ]\n        },\n        {\n            \"id\": 59263,\n            \"title\": \"Another Form Step\",\n            \"fields\": [\n                {\n                    \"id\": 59268,\n                    \"title\": \"Test Field\",\n                    \"seq\": 0,\n                    \"type\": \"text\",\n                    \"type_key\": \"set_fieldtype_form_text\",\n                    \"manditory\": true,\n                    \"multiple\": false\n                },\n                {\n                    \"id\": 59269,\n                    \"title\": \"Test Field Two\",\n                    \"seq\": 1,\n                    \"type\": \"checkbox\",\n                    \"type_key\": \"set_fieldtype_form_yesno\",\n                    \"manditory\": true,\n                    \"multiple\": false\n                },\n                {\n                    \"id\": 59270,\n                    \"title\": \"Test Field Three\",\n                    \"seq\": 2,\n                    \"type\": \"checkbox\",\n                    \"type_key\": \"set_fieldtype_form_checkbox\",\n                    \"manditory\": true,\n                    \"multiple\": false\n                }\n            ]\n        },\n        {\n            \"id\": 59617,\n            \"title\": \"Form Step With Subforms\",\n            \"fields\": [\n                {\n                    \"id\": 59621,\n                    \"title\": \"Would you like to be contacted by phone?\",\n                    \"seq\": 0,\n                    \"type\": \"checkbox\",\n                    \"type_key\": \"set_fieldtype_form_checkbox\",\n                    \"manditory\": true,\n                    \"multiple\": false,\n                    \"subforms\": [\n                        {\n                            \"id\": 59624,\n                            \"title\": \"No\",\n                            \"fields\": [\n                                {\n                                    \"id\": 59626,\n                                    \"title\": \"Why not?\",\n                                    \"seq\": 0,\n                                    \"type\": \"text\",\n                                    \"type_key\": \"set_fieldtype_form_text\",\n                                    \"manditory\": false,\n                                    \"multiple\": false\n                                }\n                            ]\n                        },\n                        {\n                            \"id\": 59625,\n                            \"title\": \"Yes\",\n                            \"fields\": [\n                                {\n                                    \"id\": 59627,\n                                    \"title\": \"What kind of phone do you have?\",\n                                    \"seq\": 0,\n                                    \"type\": \"form_select\",\n                                    \"type_key\": \"set_fieldtype_form_select\",\n                                    \"manditory\": true,\n                                    \"multiple\": false,\n                                    \"subforms\": [\n                                        {\n                                            \"id\": 59630,\n                                            \"title\": \"Landline\",\n                                            \"fields\": [\n                                                {\n                                                    \"id\": 59632,\n                                                    \"title\": \"Landline number\",\n                                                    \"seq\": 0,\n                                                    \"type\": \"telephone_number\",\n                                                    \"type_key\": \"set_fieldtype_form_telephone\",\n                                                    \"manditory\": true,\n                                                    \"multiple\": false\n                                                }\n                                            ]\n                                        },\n                                        {\n                                            \"id\": 59631,\n                                            \"title\": \"Mobile\",\n                                            \"fields\": [\n                                                {\n                                                    \"id\": 59633,\n                                                    \"title\": \"Mobile number\",\n                                                    \"seq\": 0,\n                                                    \"type\": \"telephone_number\",\n                                                    \"type_key\": \"set_fieldtype_form_telephone\",\n                                                    \"manditory\": true,\n                                                    \"multiple\": false\n                                                }\n                                            ]\n                                        }\n                                    ]\n                                }\n                            ]\n                        }\n                    ]\n                },\n                {\n                    \"id\": 59622,\n                    \"title\": \"Address\",\n                    \"seq\": 1,\n                    \"type\": \"textarea\",\n                    \"type_key\": \"set_fieldtype_form_textarea\",\n                    \"manditory\": false,\n                    \"multiple\": false\n                },\n                {\n                    \"id\": 59623,\n                    \"title\": \"Post Code\",\n                    \"seq\": 2,\n                    \"type\": \"text\",\n                    \"type_key\": \"set_fieldtype_form_text\",\n                    \"manditory\": false,\n                    \"multiple\": false\n                }\n            ]\n        }\n    ]\n}"}],"_postman_id":"77cfb133-80b5-49d0-9f2a-8904f5d1cb29"},{"name":"get_application_form_data","event":[{"listen":"prerequest","script":{"id":"345a6430-ec80-45ed-8f4a-2b5f892a6130","exec":["var timestamp = Math.floor(Date.now() / 1000);\r","pm.variables.set(\"timestamp\", timestamp);\r","var hash = CryptoJS.SHA512(timestamp.toString() + pm.environment.get(\"secret_key\"));\r","pm.variables.set(\"hash\", hash.toString(CryptoJS.enc.Hex));"],"type":"text/javascript","packages":{}}}],"id":"0db1569f-f715-458d-b232-c4a52181398e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{endpoint}}/webservices/v2/ws_ap_api.php?timestamp={{the-current-timestamp}}&public_key={{public_key}}&hash={{your-generated-hash}}&mode=get_application_form_data&id=26&field_ids=59637,59188","description":"<p>Returns an array of all form steps, fields and subforms for the given recipient ID.</p>\n","urlObject":{"path":["webservices","v2","ws_ap_api.php"],"host":["{{endpoint}}"],"query":[{"description":{"content":"<p>Current timestamp, see <a href=\"#authentication\">Authentication</a></p>\n","type":"text/plain"},"key":"timestamp","value":"{{the-current-timestamp}}"},{"description":{"content":"<p>Your public key, see <a href=\"#authentication\">Authentication</a></p>\n","type":"text/plain"},"key":"public_key","value":"{{public_key}}"},{"description":{"content":"<p>Your hash, see <a href=\"#authentication\">Authentication</a></p>\n","type":"text/plain"},"key":"hash","value":"{{your-generated-hash}}"},{"description":{"content":"<p>Request mode</p>\n","type":"text/plain"},"key":"mode","value":"get_application_form_data"},{"description":{"content":"<p>The application ID corresponding to the application you wish to modify</p>\n","type":"text/plain"},"key":"id","value":"26"},{"description":{"content":"<p>Comma-separated ids corresponding to the fields you wish to get data for</p>\n","type":"text/plain"},"key":"field_ids","value":"59637,59188"}],"variable":[]}},"response":[{"id":"8871458b-ec6c-491e-82cb-f9e83fde5476","name":"get_application_form_data","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{endpoint}}/webservices/v2/ws_ap_api.php?timestamp={{the-current-timestamp}}&public_key={{public_key}}&hash={{your-generated-hash}}&mode=get_application_form_data&id=26&field_ids=59637,59188","host":["{{endpoint}}"],"path":["webservices","v2","ws_ap_api.php"],"query":[{"key":"timestamp","value":"{{the-current-timestamp}}","description":"Current timestamp, see [Authentication](#authentication)"},{"key":"public_key","value":"{{public_key}}","description":"Your public key, see [Authentication](#authentication)"},{"key":"hash","value":"{{your-generated-hash}}","description":"Your hash, see [Authentication](#authentication)"},{"key":"mode","value":"get_application_form_data","description":"Request mode"},{"key":"id","value":"26","description":"The application ID corresponding to the application you wish to modify"},{"key":"field_ids","value":"59637,59188","description":"Comma-separated ids corresponding to the fields you wish to get data for"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Mon, 12 Aug 2024 10:00:48 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Cache-Control","value":"s-maxage=10"},{"key":"Pragma","value":"no-cache"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-XSS-Protection","value":"0"}],"cookie":[],"responseTime":null,"body":"{\n    \"code\": 1,\n    \"message\": \"Success\",\n    \"field_data\": {\n        \"59188\": [\n            {\n                \"id\": 59188,\n                \"value_id\": 59408,\n                \"name\": \"Name\",\n                \"type\": \"set_fieldtype_form_text\",\n                \"type_normalized\": \"fieldtype_text\",\n                \"value_raw\": \"Anonymised\",\n                \"value_rendered\": \"Anonymised\"\n            }\n        ],\n        \"59637\": [\n            {\n                \"id\": 59637,\n                \"value_id\": 0,\n                \"name\": \"Test Field\",\n                \"type\": \"set_fieldtype_form_text\",\n                \"type_normalized\": \"fieldtype_text\",\n                \"value_raw\": \"\",\n                \"value_rendered\": \"\"\n            }\n        ]\n    }\n}"}],"_postman_id":"0db1569f-f715-458d-b232-c4a52181398e"}],"event":[{"listen":"prerequest","script":{"id":"5440eaf1-2b70-4846-baee-cab93dafe26b","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"8db5d0ea-4ba2-4a27-8d17-a571724fac1d","type":"text/javascript","exec":[""]}}],"variable":[{"key":"hash","value":"{{your-generated-hash}}"},{"key":"timestamp","value":"{{the-current-timestamp}}"},{"key":"timestamp_from","value":"1598914800"},{"key":"your_application_name","value":"{{your_application_name}}"},{"key":"first_name","value":"John"},{"key":"surname","value":"Smith"},{"key":"email_address","value":"john+1@smith.com"}]}