Digital Asset Management API Overview
\nOur Digital Asset Management (DAM) API provides a RESTful interface, allowing for seamless integration with our comprehensive digital asset management system. Built to function reliably over HTTP/HTTPS, it uniformly returns data in a structured JSON (JavaScript Object Notation) format.
\nKey Features:
\nRESTful Design: Adheres to the principles of Representational State Transfer (REST), ensuring standardised interactions over the web streamlining the integration process for developers.
\nJSON Data Format: Returns data in the lightweight, widely accepted JSON format, ensuring compatibility with a multitude of platforms and ease of parsing.
\nExtensive Endpoints: The DAM API is equipped with several hundred endpoints, each tailored for specific asset management functionalities. This breadth ensures extensive control over assets, from querying to manipulation.
\nDetailed Parameters: These endpoints are complemented by a wide assortment of parameters, offering developers in-depth flexibility to refine their requests and get precise responses.
\nVersatile Integration: While originally designed for our client’s WordPress frontends, the API is versatile enough to integrate seamlessly with other applications, systems, and platforms, expanding its utility.
\nScalability: With capabilities ranging from managing simple image files to complex multimedia assets, the Capture API is designed for scalability, and performance.
\nSecurity: We prioritise data integrity and confidentiality. As such, our API comes with robust security and authentication mechanisms to ensure the safe transfer, storage, and access to digital assets.
\nThe Capture API serves as a critical integration tool, enabling the connection of your digital asset repository not only to WordPress interfaces but also to various other applications and systems. Through its extensive endpoints and parameters, it provides precise and efficient asset management functionalities.
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"8452164","collectionId":"a755c446-02a0-442b-8658-e0bcc6b36e42","publishedId":"SzKbNviE","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"publishDate":"2020-03-03T16:32:52.000Z"},"item":[{"name":"Admin","item":[{"name":"Assets","item":[{"name":"create asset","id":"a6da7b08-a01c-4631-9261-d5dd954a89ca","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"value":"{{access_key_api}}","key":"Both asset and metadata blocks are required.
Within the asset block, org_filename, batchname and externalid1 are the minimum required fields. All others are optional
contact_id is now optional. photographer_code can be used instead (and will be used if both are provided), but if either of these parameters is passed they must relate to a user already defined in the system who is the asset's creator, e.g photographer/artist etccontact_id nor photographer_code is passed, the asset will still be created but without an owner. This can be changed via the updateAsset call.Within the metadata block any mdX fields of type input, textarea, checkbox, date, dropdown, or multicheckbox can be set via the API (other types are currently unsupported)
\nAlso, any which are defined in coo as \"use as\" fields (the is_xxx fields in metadata_config) can not be set directly.
photographer_code - if passed (within the asset block) must be the photo_code of an existing contact in the system. This contact will be associated to the asset as the asset owner/photographercontact_id - if passed within the asset block must be the id of an existing contact in the system. This contact will be associated to the asset as the asset owner/photographer.license_types, release_status and groups are optional as they are not directly required for asset creation. The asset can be updated later to make associations to these objectscountry_allow and country_deny are new optional parameters, which take an array of country id's. You should not use both together; either allow 1 or more countries, or deny 1 or more countries. Setting a single country in allow will implicitly deny the asset from all other countries.access_level - if passed within the asset block will set the access_level on the asset to the integer value providedset the no_publish flag on an asset by passing \"no_publish\":1 within the asset section in the request data, e.g.
\n\n\n\"asset\":{
\n\"no_publish\": 1 \n\n}
\n
unset the no_publish flag by passing \"no_publish\": 0 within in the asset section of the request data
\nthis can be updated separately from any other field, or with other fields.
\nit must be an integer value;
\nRetrieves information on the specified asset, including metadata fields and the url to the preview.
\nThe asset identifier can be either
\nthe asset id (integer, assigned by the capture site on asset create), or
\nthe original filename (string, org_filename that is provided on asset create - also the actual filename of the uploaded asset)
\nthis does not use the search index, but directly queries the database in order to allow the use of filters not currently available to search. returns summary information and url to thumbnail for each asset
\nNOTE if published = no or never, do not apply publishingdate filter, as this will have no results. assets in not or never been published state do not have publishing date
\nby default results will be returned on page 1 with 100 items per page, sorted by newest asset id first
\n","urlObject":{"path":["api","admin","assets"],"host":["{{cw3_api_url}}"],"query":[{"description":{"content":"yes,no,never
\n","type":"text/plain"},"key":"published","value":"yes"},{"disabled":true,"key":"batchname","value":"batch"},{"disabled":true,"description":{"content":"integer specifying the result page to display. default 1
\n","type":"text/plain"},"key":"page","value":"1"},{"disabled":true,"description":{"content":"items per page to return. default 100 if omitted
\n","type":"text/plain"},"key":"itemsperpage","value":"100"},{"disabled":true,"description":{"content":"start date(Y-M-D) : end date(Y-M-D) OR date(Y-M-D)
\n","type":"text/plain"},"key":"uploaddate","value":"2019-01-01:2020-07-30"},{"disabled":true,"description":{"content":"start date(Y-M-D) : end date(Y-M-D) OR date(Y-M-D)
\n","type":"text/plain"},"key":"publishingdate","value":"2020-11-10"},{"disabled":true,"description":{"content":"start date(Y-M-D) : end date(Y-M-D) OR date(Y-M-D)
\n","type":"text/plain"},"key":"lastmodifydate","value":"2020-07-30"},{"disabled":true,"description":{"content":"sort by batchname, uploaddate, publishingdate, lastmodifydate, assetid. will default to asset id desc
\n","type":"text/plain"},"key":"sort","value":"publishingdate:desc"},{"disabled":true,"description":{"content":"pass 'simples' to get minimal asset info back, no value needed
\n","type":"text/plain"},"key":"simples","value":""}],"variable":[]}},"response":[{"id":"17a2e560-d511-4806-b23f-c72e96668a9e","name":"list all published assets, ordered by descending asset id, simple summary ","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"X-Api-Key","value":"{{access_key_api}}","type":"text"}],"url":{"raw":"{{cw3_api_url}}/api/admin/assets?published=yes&page=1&itemsperpage=100&simples","host":["{{cw3_api_url}}"],"path":["api","admin","assets"],"query":[{"key":"published","value":"yes","description":"yes,no,never"},{"key":"batchname","value":"batch","disabled":true},{"key":"page","value":"1","description":"integer specifying the result page to display. default 1"},{"key":"itemsperpage","value":"100","description":"items per page to return. default 100 if omitted"},{"key":"uploaddate","value":"2019-01-01:2020-07-30","description":"start date(Y-M-D) : end date(Y-M-D) OR date(Y-M-D)","disabled":true},{"key":"publishingdate","value":"2020-05-01:2020-11-12","description":"start date(Y-M-D) : end date(Y-M-D) OR date(Y-M-D)","disabled":true},{"key":"lastmodifydate","value":"2020-07-30","description":"start date(Y-M-D) : end date(Y-M-D) OR date(Y-M-D)","disabled":true},{"key":"sort","value":"publishingdate:desc","description":"sort by batchname, uploaddate, publishingdate, lastmodifydate, assetid. will default to asset id desc","type":"text","disabled":true},{"key":"simples","value":null,"description":"pass 'simples' to get minimal asset info back, no value needed"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 12 Nov 2020 07:07:01 GMT"},{"key":"Server","value":"Apache"},{"key":"Vary","value":"Authorization"},{"key":"Upgrade","value":"h2,h2c"},{"key":"Connection","value":"Upgrade, Keep-Alive"},{"key":"X-Powered-By","value":"capture API"},{"key":"Status","value":"200 OK"},{"key":"Access-Control-Allow-Origin","value":""},{"key":"Content-Language","value":"en"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"X-Api-Key","value":"{{access_key_api}}","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"data\": {\n \"total\": 75,\n \"returned\": 75,\n \"pages\": 1,\n \"page\": 1,\n \"assets\": [\n {\n \"summary\": {\n \"idasset\": 138,\n \"org_filename\": \"ivy003.png\",\n \"batchname\": \"X1602556085\",\n \"upload_date\": \"2020-10-13 05:28:39\",\n \"publishing_date\": \"2020-11-10 11:04:40\",\n \"last_modify_date_time\": \"2020-11-10 09:04:50\"\n }\n },\n {\n \"summary\": {\n \"idasset\": 137,\n \"org_filename\": \"video2.mp4\",\n \"batchname\": \"X1602493425\",\n \"upload_date\": \"2020-10-12 12:05:28\",\n \"publishing_date\": \"2020-10-12 12:06:01\",\n \"last_modify_date_time\": \"2020-10-29 11:35:43\"\n }\n },\n {\n \"summary\": {\n \"idasset\": 136,\n \"org_filename\": \"1542275-7bf2d7931f060cb76610e83732866e13.mp4\",\n \"batchname\": \"X1602493007\",\n \"upload_date\": \"2020-10-12 11:59:57\",\n \"publishing_date\": \"2020-10-12 12:00:46\",\n \"last_modify_date_time\": \"2020-10-29 11:35:47\"\n }\n }\n ]\n }\n}"},{"id":"678a3076-021f-46ee-9c2b-5e76e0f63eea","name":"list all unpublished assets","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"X-Api-Key","value":"{{access_key_api}}","type":"text"}],"url":{"raw":"{{cw3_api_url}}/api/admin/assets?published=no&page=1&itemsperpage=100&sort=publishingdate:desc","host":["{{cw3_api_url}}"],"path":["api","admin","assets"],"query":[{"key":"published","value":"no","description":"yes,no,never"},{"key":"batchname","value":"batch","disabled":true},{"key":"page","value":"1","description":"integer specifying the result page to display. default 1"},{"key":"itemsperpage","value":"100","description":"items per page to return. default 100 if omitted"},{"key":"uploaddate","value":"2019-01-01:2020-07-30","description":"start date(Y-M-D) : end date(Y-M-D) OR date(Y-M-D)","disabled":true},{"key":"publishingdate","value":"2020-11-10","description":"start date(Y-M-D) : end date(Y-M-D) OR date(Y-M-D)","disabled":true},{"key":"lastmodifydate","value":"2020-07-30","description":"start date(Y-M-D) : end date(Y-M-D) OR date(Y-M-D)","disabled":true},{"key":"sort","value":"publishingdate:desc","description":"sort by batchname, uploaddate, publishingdate, lastmodifydate, assetid. will default to asset id desc"},{"key":"simples","value":null,"description":"pass 'simples' to get minimal asset info back, no value needed","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 12 Nov 2020 07:23:37 GMT"},{"key":"Server","value":"Apache"},{"key":"Vary","value":"Authorization"},{"key":"X-Powered-By","value":"capture API"},{"key":"Status","value":"200 OK"},{"key":"Access-Control-Allow-Origin","value":""},{"key":"Content-Language","value":"en"},{"key":"Content-Length","value":"789"},{"key":"Keep-Alive","value":"timeout=5, max=99"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json; charset=UTF-8"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"data\": {\n \"total\": 1,\n \"returned\": 1,\n \"pages\": 1,\n \"page\": 1,\n \"assets\": [\n {\n \"summary\": {\n \"idasset\": \"106\",\n \"idusers\": \"55\",\n \"file_extension\": \"jpg\",\n \"org_filename\": \"timg 2.jpg\",\n \"filesize\": \"221761\",\n \"height\": \"1024\",\n \"width\": \"1024\",\n \"batchname\": \"X1583903242\",\n \"upload_date\": \"2020-03-11 05:07:42\",\n \"externalid1\": \"timg 2\",\n \"externalid2\": \"0\",\n \"call_me_price\": \"0\",\n \"publishing_date\": \"2020-03-11 05:11:56\",\n \"mime_type\": \"image/jpeg\",\n \"exif_datetimeoriginal\": null,\n \"idasset_status\": \"2\",\n \"exclusive_code\": \"0\",\n \"base_type\": \"image\",\n \"license_types\": [],\n \"publication_status_id\": \"1\",\n \"contact_id\": \"0\"\n },\n \"thumb\": {\n \"exists\": true,\n \"thumb_mimetype\": \"image/jpeg\",\n \"url\": {\n \"1\": \"https://example-site.com/coo/user/thumbs/1/106.jpg\",\n \"3\": \"https://example-site.com/coo/user/thumbs/1/106.jpg\"\n }\n }\n }\n ]\n }\n}"},{"id":"89a97cdd-4ad9-4404-b2c2-1a8181c6dba3","name":"list all published assets with a batchname like 'HV', simplified response","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"X-Api-Key","value":"{{access_key_api}}","type":"text"}],"url":{"raw":"{{cw3_api_url}}/api/admin/assets?published=yes&batchname=HV&page=1&itemsperpage=100&simples","host":["{{cw3_api_url}}"],"path":["api","admin","assets"],"query":[{"key":"published","value":"yes","description":"yes,no,never"},{"key":"batchname","value":"HV"},{"key":"page","value":"1","description":"integer specifying the result page to display. default 1"},{"key":"itemsperpage","value":"100","description":"items per page to return. default 100 if omitted"},{"key":"uploaddate","value":"2019-01-01:2020-07-30","description":"start date(Y-M-D) : end date(Y-M-D) OR date(Y-M-D)","disabled":true},{"key":"publishingdate","value":"2020-05-01:2020-11-12","description":"start date(Y-M-D) : end date(Y-M-D) OR date(Y-M-D)","disabled":true},{"key":"lastmodifydate","value":"2020-07-30","description":"start date(Y-M-D) : end date(Y-M-D) OR date(Y-M-D)","disabled":true},{"key":"sort","value":"publishingdate:desc","description":"sort by batchname, uploaddate, publishingdate, lastmodifydate, assetid. will default to asset id desc","type":"text","disabled":true},{"key":"simples","value":null,"description":"pass 'simples' to get minimal asset info back, no value needed"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 12 Nov 2020 07:15:21 GMT"},{"key":"Server","value":"Apache"},{"key":"Vary","value":"Authorization"},{"key":"Upgrade","value":"h2,h2c"},{"key":"Connection","value":"Upgrade, Keep-Alive"},{"key":"X-Powered-By","value":"capture API"},{"key":"Status","value":"200 OK"},{"key":"Access-Control-Allow-Origin","value":""},{"key":"Content-Language","value":"en"},{"key":"Content-Length","value":"3901"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Content-Type","value":"application/json; charset=UTF-8"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"data\": {\n \"total\": 17,\n \"returned\": 17,\n \"pages\": 1,\n \"page\": 1,\n \"assets\": [\n {\n \"summary\": {\n \"idasset\": \"73\",\n \"org_filename\": \"8273968.jpg\",\n \"batchname\": \"HV1580389056\",\n \"upload_date\": \"2020-01-30 12:57:46\",\n \"publishing_date\": \"2020-04-16 20:43:21\",\n \"last_modify_date_time\": \"2020-10-29 11:35:42\"\n }\n },\n {\n \"summary\": {\n \"idasset\": \"72\",\n \"org_filename\": \"8273966.jpg\",\n \"batchname\": \"HV1580388998\",\n \"upload_date\": \"2020-01-30 12:57:03\",\n \"publishing_date\": \"2020-04-16 20:43:24\",\n \"last_modify_date_time\": \"2020-10-29 11:36:57\"\n }\n },\n {\n \"summary\": {\n \"idasset\": \"71\",\n \"org_filename\": \"51322910.jpg\",\n \"batchname\": \"HV1580386728\",\n \"upload_date\": \"2020-01-30 12:19:54\",\n \"publishing_date\": \"2020-04-16 20:43:24\",\n \"last_modify_date_time\": \"2020-10-29 11:36:59\"\n }\n },\n {\n \"summary\": {\n \"idasset\": \"70\",\n \"org_filename\": \"51322905.jpg\",\n \"batchname\": \"HV1580386728\",\n \"upload_date\": \"2020-01-30 12:19:51\",\n \"publishing_date\": \"2020-04-16 20:43:29\",\n \"last_modify_date_time\": \"2020-10-29 11:37:00\"\n }\n },\n {\n \"summary\": {\n \"idasset\": \"69\",\n \"org_filename\": \"51177922.jpg\",\n \"batchname\": \"HV1580386728\",\n \"upload_date\": \"2020-01-30 12:19:49\",\n \"publishing_date\": \"2020-04-16 20:43:31\",\n \"last_modify_date_time\": \"2020-10-29 11:37:01\"\n }\n },\n {\n \"summary\": {\n \"idasset\": \"68\",\n \"org_filename\": \"40347478.jpg\",\n \"batchname\": \"HV1580386728\",\n \"upload_date\": \"2020-01-30 12:19:46\",\n \"publishing_date\": \"2020-04-16 20:43:32\",\n \"last_modify_date_time\": \"2020-10-29 11:37:04\"\n }\n },\n {\n \"summary\": {\n \"idasset\": \"67\",\n \"org_filename\": \"40347477.jpg\",\n \"batchname\": \"HV1580386728\",\n \"upload_date\": \"2020-01-30 12:19:44\",\n \"publishing_date\": \"2020-04-16 20:43:33\",\n \"last_modify_date_time\": \"2020-10-29 11:37:05\"\n }\n },\n {\n \"summary\": {\n \"idasset\": \"66\",\n \"org_filename\": \"39700571.jpg\",\n \"batchname\": \"HV1580386728\",\n \"upload_date\": \"2020-01-30 12:19:41\",\n \"publishing_date\": \"2020-04-16 20:43:38\",\n \"last_modify_date_time\": \"2020-10-29 11:37:07\"\n }\n },\n {\n \"summary\": {\n \"idasset\": \"65\",\n \"org_filename\": \"25811922.jpg\",\n \"batchname\": \"HV1580386728\",\n \"upload_date\": \"2020-01-30 12:19:39\",\n \"publishing_date\": \"2020-04-16 20:43:39\",\n \"last_modify_date_time\": \"2020-10-29 11:37:08\"\n }\n },\n {\n \"summary\": {\n \"idasset\": \"64\",\n \"org_filename\": \"25811921.jpg\",\n \"batchname\": \"HV1580386728\",\n \"upload_date\": \"2020-01-30 12:19:36\",\n \"publishing_date\": \"2020-04-16 20:43:40\",\n \"last_modify_date_time\": \"2020-10-29 11:37:09\"\n }\n },\n {\n \"summary\": {\n \"idasset\": \"63\",\n \"org_filename\": \"25811915.jpg\",\n \"batchname\": \"HV1580386728\",\n \"upload_date\": \"2020-01-30 12:19:34\",\n \"publishing_date\": \"2020-04-16 20:43:42\",\n \"last_modify_date_time\": \"2020-10-29 11:37:10\"\n }\n },\n {\n \"summary\": {\n \"idasset\": \"62\",\n \"org_filename\": \"25811908.jpg\",\n \"batchname\": \"HV1580386728\",\n \"upload_date\": \"2020-01-30 12:19:32\",\n \"publishing_date\": \"2020-04-16 20:43:43\",\n \"last_modify_date_time\": \"2020-10-29 11:37:11\"\n }\n },\n {\n \"summary\": {\n \"idasset\": \"61\",\n \"org_filename\": \"15087145.jpg\",\n \"batchname\": \"HV1580386728\",\n \"upload_date\": \"2020-01-30 12:19:29\",\n \"publishing_date\": \"2020-04-16 20:43:45\",\n \"last_modify_date_time\": \"2020-10-29 11:37:13\"\n }\n },\n {\n \"summary\": {\n \"idasset\": \"60\",\n \"org_filename\": \"15087143.jpg\",\n \"batchname\": \"HV1580386728\",\n \"upload_date\": \"2020-01-30 12:19:27\",\n \"publishing_date\": \"2020-04-16 20:43:48\",\n \"last_modify_date_time\": \"2020-10-29 11:37:15\"\n }\n },\n {\n \"summary\": {\n \"idasset\": \"59\",\n \"org_filename\": \"14855392.jpg\",\n \"batchname\": \"HV1580386728\",\n \"upload_date\": \"2020-01-30 12:19:25\",\n \"publishing_date\": \"2020-04-16 20:43:48\",\n \"last_modify_date_time\": \"2020-10-29 11:37:17\"\n }\n },\n {\n \"summary\": {\n \"idasset\": \"58\",\n \"org_filename\": \"12704576.jpg\",\n \"batchname\": \"HV1580386728\",\n \"upload_date\": \"2020-01-30 12:19:22\",\n \"publishing_date\": \"2020-04-16 20:43:49\",\n \"last_modify_date_time\": \"2020-10-29 11:37:17\"\n }\n },\n {\n \"summary\": {\n \"idasset\": \"57\",\n \"org_filename\": \"12429349.jpg\",\n \"batchname\": \"HV1580386728\",\n \"upload_date\": \"2020-01-30 12:19:20\",\n \"publishing_date\": \"2020-04-16 20:43:53\",\n \"last_modify_date_time\": \"2020-10-29 11:37:20\"\n }\n }\n ]\n }\n}"},{"id":"8f82a198-f28e-4b70-8e08-e026fee79e0a","name":"list all published assets that were published on 10th Nov 2020,detailed response (not simplified)","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"X-Api-Key","value":"{{access_key_api}}","type":"text"}],"url":{"raw":"{{cw3_api_url}}/api/admin/assets?published=yes&page=1&itemsperpage=100&publishingdate=2020-11-10&sort=publishingdate:desc","host":["{{cw3_api_url}}"],"path":["api","admin","assets"],"query":[{"key":"published","value":"yes","description":"yes,no,never"},{"key":"batchname","value":"HV","disabled":true},{"key":"page","value":"1","description":"integer specifying the result page to display. default 1"},{"key":"itemsperpage","value":"100","description":"items per page to return. default 100 if omitted"},{"key":"uploaddate","value":"2019-01-01:2020-07-30","description":"start date(Y-M-D) : end date(Y-M-D) OR date(Y-M-D)","disabled":true},{"key":"publishingdate","value":"2020-11-10","description":"start date(Y-M-D) : end date(Y-M-D) OR date(Y-M-D)"},{"key":"lastmodifydate","value":"2020-07-30","description":"start date(Y-M-D) : end date(Y-M-D) OR date(Y-M-D)","disabled":true},{"key":"sort","value":"publishingdate:desc","description":"sort by batchname, uploaddate, publishingdate, lastmodifydate, assetid. will default to asset id desc"},{"key":"simples","value":null,"description":"pass 'simples' to get minimal asset info back, no value needed","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 12 Nov 2020 07:21:59 GMT"},{"key":"Server","value":"Apache"},{"key":"Vary","value":"Authorization"},{"key":"X-Powered-By","value":"capture API"},{"key":"Status","value":"200 OK"},{"key":"Access-Control-Allow-Origin","value":""},{"key":"Content-Language","value":"en"},{"key":"Content-Length","value":"902"},{"key":"Keep-Alive","value":"timeout=5, max=99"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json; charset=UTF-8"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"data\": {\n \"total\": 1,\n \"returned\": 1,\n \"pages\": 1,\n \"page\": 1,\n \"assets\": [\n {\n \"summary\": {\n \"idasset\": \"138\",\n \"idusers\": \"55\",\n \"file_extension\": \"png\",\n \"org_filename\": \"ivy003.png\",\n \"filesize\": \"1219356\",\n \"height\": \"859\",\n \"width\": \"735\",\n \"batchname\": \"X1602556085\",\n \"upload_date\": \"2020-10-13 05:28:39\",\n \"externalid1\": \"ivy003\",\n \"externalid2\": \"0\",\n \"call_me_price\": \"0\",\n \"publishing_date\": \"2020-11-10 11:04:40\",\n \"mime_type\": \"image/png\",\n \"exif_datetimeoriginal\": null,\n \"idasset_status\": \"1\",\n \"exclusive_code\": \"0\",\n \"base_type\": \"image\",\n \"license_types\": [\n {\n \"idlicencetype\": \"3\",\n \"name\": \"Wholly owned\",\n \"code\": \"WO\"\n },\n {\n \"idlicencetype\": \"4\",\n \"name\": \"Third-party owned\",\n \"code\": \"TO\"\n }\n ],\n \"publication_status_id\": \"2\",\n \"contact_id\": \"0\"\n },\n \"thumb\": {\n \"exists\": true,\n \"thumb_mimetype\": \"image/png\",\n \"url\": {\n \"1\": \"https://example-site.com/coo/user/thumbs/1/138.png\",\n \"3\": \"https://example-site.com/coo/user/thumbs/1/138.png\"\n }\n }\n }\n ]\n }\n}"},{"id":"9b82a268-cf63-41fa-912b-bdddbe96d694","name":"list all published assets that were published between 1st Oct 2020 and 12th Nov 2020","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"X-Api-Key","value":"{{access_key_api}}","type":"text"}],"url":{"raw":"{{cw3_api_url}}/api/admin/assets?published=yes&page=1&itemsperpage=100&publishingdate=2020-10-01:2020-11-12&sort=publishingdate:desc&simples","host":["{{cw3_api_url}}"],"path":["api","admin","assets"],"query":[{"key":"published","value":"yes","description":"yes,no,never"},{"key":"batchname","value":"HV","disabled":true},{"key":"page","value":"1","description":"integer specifying the result page to display. default 1"},{"key":"itemsperpage","value":"100","description":"items per page to return. default 100 if omitted"},{"key":"uploaddate","value":"2019-01-01:2020-07-30","description":"start date(Y-M-D) : end date(Y-M-D) OR date(Y-M-D)","disabled":true},{"key":"publishingdate","value":"2020-10-01:2020-11-12","description":"start date(Y-M-D) : end date(Y-M-D) OR date(Y-M-D)"},{"key":"lastmodifydate","value":"2020-07-30","description":"start date(Y-M-D) : end date(Y-M-D) OR date(Y-M-D)","disabled":true},{"key":"sort","value":"publishingdate:desc","description":"sort by batchname, uploaddate, publishingdate, lastmodifydate, assetid. will default to asset id desc"},{"key":"simples","value":null,"description":"pass 'simples' to get minimal asset info back, no value needed"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 12 Nov 2020 07:18:24 GMT"},{"key":"Server","value":"Apache"},{"key":"Vary","value":"Authorization"},{"key":"Upgrade","value":"h2,h2c"},{"key":"Connection","value":"Upgrade, Keep-Alive"},{"key":"X-Powered-By","value":"capture API"},{"key":"Status","value":"200 OK"},{"key":"Access-Control-Allow-Origin","value":""},{"key":"Content-Language","value":"en"},{"key":"Content-Length","value":"4224"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Content-Type","value":"application/json; charset=UTF-8"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"data\": {\n \"total\": 18,\n \"returned\": 18,\n \"pages\": 1,\n \"page\": 1,\n \"assets\": [\n {\n \"summary\": {\n \"idasset\": \"138\",\n \"org_filename\": \"ivy003.png\",\n \"batchname\": \"X1602556085\",\n \"upload_date\": \"2020-10-13 05:28:39\",\n \"publishing_date\": \"2020-11-10 11:04:40\",\n \"last_modify_date_time\": \"2020-11-10 09:04:50\"\n }\n },\n {\n \"summary\": {\n \"idasset\": \"113\",\n \"org_filename\": \"30575.jpg\",\n \"batchname\": \"O1588672532\",\n \"upload_date\": \"2020-05-05 10:55:47\",\n \"publishing_date\": \"2020-10-29 13:36:15\",\n \"last_modify_date_time\": \"2020-10-29 11:36:24\"\n }\n },\n {\n \"summary\": {\n \"idasset\": \"116\",\n \"org_filename\": \"30575.jpg\",\n \"batchname\": \"O1590504422\",\n \"upload_date\": \"2020-05-26 17:47:14\",\n \"publishing_date\": \"2020-10-29 13:36:14\",\n \"last_modify_date_time\": \"2020-10-29 11:36:22\"\n }\n },\n {\n \"summary\": {\n \"idasset\": \"123\",\n \"org_filename\": \"Test Image 4.jpg\",\n \"batchname\": \"X1593761381\",\n \"upload_date\": \"2020-07-03 10:29:59\",\n \"publishing_date\": \"2020-10-29 13:36:06\",\n \"last_modify_date_time\": \"2020-10-29 11:36:14\"\n }\n },\n {\n \"summary\": {\n \"idasset\": \"124\",\n \"org_filename\": \"Test Image 4.jpg\",\n \"batchname\": \"4#55#10:36 3-07-20\",\n \"upload_date\": \"2020-07-03 10:36:39\",\n \"publishing_date\": \"2020-10-29 13:36:05\",\n \"last_modify_date_time\": \"2020-10-29 11:36:13\"\n }\n },\n {\n \"summary\": {\n \"idasset\": \"125\",\n \"org_filename\": \"1.jpg\",\n \"batchname\": \"4#55#10:38 3-07-20\",\n \"upload_date\": \"2020-07-03 10:39:16\",\n \"publishing_date\": \"2020-10-29 13:36:04\",\n \"last_modify_date_time\": \"2020-10-29 11:36:12\"\n }\n },\n {\n \"summary\": {\n \"idasset\": \"126\",\n \"org_filename\": \"test2 .pdf\",\n \"batchname\": \"X1593762029\",\n \"upload_date\": \"2020-07-03 10:40:48\",\n \"publishing_date\": \"2020-10-29 13:36:01\",\n \"last_modify_date_time\": \"2020-10-29 11:36:12\"\n }\n },\n {\n \"summary\": {\n \"idasset\": \"127\",\n \"org_filename\": \"Copy of α-1 Antitrypsin MININEPH Kit Product Insert - Czech (INSERTS - ZIN034.CZ - 1 - 170700) - 1.PDF\",\n \"batchname\": \"X1594268180\",\n \"upload_date\": \"2020-07-09 07:16:37\",\n \"publishing_date\": \"2020-10-29 13:35:59\",\n \"last_modify_date_time\": \"2020-10-29 11:36:09\"\n }\n },\n {\n \"summary\": {\n \"idasset\": \"128\",\n \"org_filename\": \"170700.PDF\",\n \"batchname\": \"4#55#11:17 9-07-20\",\n \"upload_date\": \"2020-07-09 11:17:56\",\n \"publishing_date\": \"2020-10-29 13:35:58\",\n \"last_modify_date_time\": \"2020-10-29 11:36:08\"\n }\n },\n {\n \"summary\": {\n \"idasset\": \"129\",\n \"org_filename\": \"Copy of α-1 Antitrypsin.PDF\",\n \"batchname\": \"4#55#16:52 9-07-20\",\n \"upload_date\": \"2020-07-09 16:52:21\",\n \"publishing_date\": \"2020-10-29 13:35:57\",\n \"last_modify_date_time\": \"2020-10-29 11:36:07\"\n }\n },\n {\n \"summary\": {\n \"idasset\": \"130\",\n \"org_filename\": \"Copy of α-1 Antitrypsin MININEPH Kit Product Insert - Czech (INSERTS - ZIN034.CZ - 1 - 170700) - 1.PDF\",\n \"batchname\": \"4#55#16:54 9-07-20\",\n \"upload_date\": \"2020-07-09 16:56:00\",\n \"publishing_date\": \"2020-10-29 13:35:55\",\n \"last_modify_date_time\": \"2020-10-29 11:36:05\"\n }\n },\n {\n \"summary\": {\n \"idasset\": \"133\",\n \"org_filename\": \"4199924-4.jpg\",\n \"batchname\": \"X1597139019\",\n \"upload_date\": \"2020-08-11 12:44:31\",\n \"publishing_date\": \"2020-10-29 13:35:53\",\n \"last_modify_date_time\": \"2020-10-29 11:36:01\"\n }\n },\n {\n \"summary\": {\n \"idasset\": \"134\",\n \"org_filename\": \"2020021303.jpg\",\n \"batchname\": \"4#55#08:42 12-08-20\",\n \"upload_date\": \"2020-08-12 08:43:13\",\n \"publishing_date\": \"2020-10-29 13:35:53\",\n \"last_modify_date_time\": \"2020-10-29 11:36:01\"\n }\n },\n {\n \"summary\": {\n \"idasset\": \"135\",\n \"org_filename\": \"2012021304.jpg\",\n \"batchname\": \"4#55#10:58 12-08-20\",\n \"upload_date\": \"2020-08-12 10:59:31\",\n \"publishing_date\": \"2020-10-29 13:35:52\",\n \"last_modify_date_time\": \"2020-10-29 11:36:01\"\n }\n },\n {\n \"summary\": {\n \"idasset\": \"122\",\n \"org_filename\": \"Test Image 5.jpg\",\n \"batchname\": \"X1593759474\",\n \"upload_date\": \"2020-07-03 10:02:45\",\n \"publishing_date\": \"2020-10-16 12:15:13\",\n \"last_modify_date_time\": \"2020-10-29 11:36:07\"\n }\n },\n {\n \"summary\": {\n \"idasset\": \"121\",\n \"org_filename\": \"Test Image 5.jpg\",\n \"batchname\": \"X1593759474\",\n \"upload_date\": \"2020-07-03 09:58:44\",\n \"publishing_date\": \"2020-10-16 12:15:05\",\n \"last_modify_date_time\": \"2020-10-29 11:36:09\"\n }\n },\n {\n \"summary\": {\n \"idasset\": \"137\",\n \"org_filename\": \"video2.mp4\",\n \"batchname\": \"X1602493425\",\n \"upload_date\": \"2020-10-12 12:05:28\",\n \"publishing_date\": \"2020-10-12 12:06:01\",\n \"last_modify_date_time\": \"2020-10-29 11:35:43\"\n }\n },\n {\n \"summary\": {\n \"idasset\": \"136\",\n \"org_filename\": \"1542275-7bf2d7931f060cb76610e83732866e13.mp4\",\n \"batchname\": \"X1602493007\",\n \"upload_date\": \"2020-10-12 11:59:57\",\n \"publishing_date\": \"2020-10-12 12:00:46\",\n \"last_modify_date_time\": \"2020-10-29 11:35:47\"\n }\n }\n ]\n }\n}"}],"_postman_id":"088cf193-065e-408e-a150-56a502e3f25a"},{"name":"update asset","id":"1302bf8b-0fb0-413b-9dd3-53d0283cfa79","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"value":"{{access_key_api}}","key":"note that updating the asset and/or metadata fields from this call does not update the search index - use smart publish call for that
\nIf contact_id is passed, it must be the id of a user in the system as this is used as the creator/owner reference for the asset (e.g. photographer, artist etc).
If photographer_code is passed, it must be the photo_code of a user in the system as this is used as the creator/owner reference for the asset (e.g. photographer, artist etc)
Any internally configured metadata fields will also be updated, for example if field md9 is defined as Creator and has is_photog_name flag set, changing contact_id or photographer_code will set the contact name into the metadata.md9 field
If country_allow is passed as an array of country id's, the current countries allowed for the asset will be replaced. If an empty array is passed, all currently set countries allowed will be removed.
If country_deny is passed as an array of country id's, the current countries denied for the asset will be replaced. If an empty array is passed, all currently set countries denied will be removed.
Set the minimum price on an asset by passing min_price in the request with the value, e.g.
\"min_price\": \"10.50\"
To remove the minimum pricing, pass min_price with value 0 e.g.
\"min_price\": \"0.0\"
Note: it is not necessary to pass non zero values as a string (encapsulated in quotes), but to reset back to zero, you must pass \"0.0\", as the request filter currently considers integer value of 0 to be an empty field. This will be corrected in a later update.
\nUpdate the access level value on an asset by passing access_level within asset section of the the request with an integer value, e.g.
\n\n\n\"asset\":{
\n\"access_level\": 5 \n}
\n
set the no_publish flag on an asset by passing \"no_publish\":1 within the asset section in the request data, e.g.
\n\n\n\"asset\":{
\n\"no_publish\": 1 \n}
\n
unset the no_publish flag by passing \"no_publish\": 0 within in the asset section of the request data
\nthis can be updated separately from any other field, or with other fields.
\nit must be an integer value;
\nThe following must be true for a successful update:
\nPerforms a delete on an asset referenced by its internal Capture id. The delete is cascading, removing the asset record from every part of the system except ecommerce order and event log tables.
\nAsset is removed from:
\nsearch index
\ncdn table including actual files
\ncountry allowed/restriction tables
\nregion allowed/restriction tables
\nrelease links
\nrights clearance
\nshare
\nuse allowed/restriction tables
\nkeywords
\ncollection assets
\nlicencetype asset
\nmetadata
\nbasket items
\nlightbox_items
\nResets any collections using it as lead asset
\nDeletes thumb, preview, original image files
\n","urlObject":{"path":["api","admin","asset","{{asset_id}}"],"host":["{{cw3_api_url}}"],"query":[],"variable":[]}},"response":[{"id":"689ccb7a-25ce-414f-9d13-ddb16f763554","name":"delete asset by id (success 204 returned)","originalRequest":{"method":"DELETE","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"X-Api-Key","value":"{{access_key_api}}","type":"text"}],"url":"{{cw3_api_url}}/api/admin/asset/{{asset_id}}"},"status":"No Content","code":204,"_postman_previewlanguage":"plain","header":[{"key":"Date","value":"Wed, 11 Mar 2020 11:30:17 GMT"},{"key":"Server","value":"Apache/2.4.41 (Win64) OpenSSL/1.1.1c PHP/7.3.14"},{"key":"Vary","value":"Authorization"},{"key":"X-Powered-By","value":"capture API"},{"key":"Status","value":"204 No Content"},{"key":"Access-Control-Allow-Origin","value":""},{"key":"Content-Language","value":"en"},{"key":"Keep-Alive","value":"timeout=5, max=99"},{"key":"Connection","value":"Keep-Alive"}],"cookie":[],"responseTime":null,"body":null},{"id":"f0ea4b75-e51c-4160-97ec-4bef8cb55965","name":"delete asset by id (fail - asset does not exist)","originalRequest":{"method":"DELETE","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"X-Api-Key","value":"{{access_key_api}}","type":"text"}],"url":"{{cw3_api_url}}/api/admin/asset/1110"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 11 Mar 2020 11:36:13 GMT"},{"key":"Server","value":"Apache/2.4.41 (Win64) OpenSSL/1.1.1c PHP/7.3.14"},{"key":"Vary","value":"Authorization"},{"key":"Upgrade","value":"h2,h2c"},{"key":"Connection","value":"Upgrade, Keep-Alive"},{"key":"X-Powered-By","value":"capture API"},{"key":"Status","value":"404 Not Found"},{"key":"Access-Control-Allow-Origin","value":""},{"key":"Content-Language","value":"en"},{"key":"Content-Length","value":"94"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Content-Type","value":"application/json; charset=UTF-8"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 404,\n \"error\": {\n \"message\": \"not found\",\n \"summary\": \"asset `1110` not found\",\n \"verbose\": []\n }\n}"}],"_postman_id":"c7a14859-0590-42c8-ae87-88196423b0eb"},{"name":"delete asset by filename","id":"87e63d89-e0ad-43c2-b5bf-4fc3469eb8bf","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"key":"Performs a delete on an asset using the original filename as the identifier. The org_filename of an asset is typically unique per asset, but uniqueness is not enforced (only the capture asset id is truly unique). It is therefore possible for more than one asset to have the same org_filename. In order to deal with this scenario, this endpoint can accept an optional trailing url parameter; /force
If /force is omitted (e.g. https://api/admin/asset/filename/) and multiple assets with same name exist a 409 Conflict is returned, with the asset id's listed in the error.verbose block
If /force is added (e.g. https://api/admin/asset/filename//force), the delete is forced even if multiple assets exist with same name, and all matching assets will be removed.
The delete is cascading, removing the asset record(s) from every part of the system except ecommerce order and event log tables
\nAsset is removed from:
\nsearch index
\ncdn table including actual files
\ncountry allowed/restriction tables
\nregion allowed/restriction tables
\nrelease links
\nrights clearance
\nshare
\nuse allowed/restriction tables
\nkeywords
\ncollection assets
\nlicencetype asset
\nmetadata
\nbasket items
\nlightbox_items
\nResets any collections using it as lead asset
\nDeletes thumb, preview, original image files
\n","urlObject":{"path":["api","admin","asset","filename","{{filename}}","force"],"host":["{{cw3_api_url}}"],"query":[],"variable":[]}},"response":[{"id":"00a4a060-6da4-4dfb-b592-26f530db7ca6","name":"(fail) delete asset by filename - not exist","originalRequest":{"method":"DELETE","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"X-Api-Key","value":"{{access_key_api}}","type":"text"}],"url":"{{cw3_api_url}}/api/admin/asset/filename/{{filename}}/force"},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"status\": 404,\n \"error\": {\n \"message\": \"not found\",\n \"summary\": \"asset `a44b2a4bf74f2acaae9a2a1d9e167144.png` does not exist\",\n \"verbose\": []\n }\n}"},{"id":"da0eb786-a2dd-4a3b-bf0a-8aab4bc7388b","name":"(fail) delete asset by filename - conflict multiple assets when not forced","originalRequest":{"method":"DELETE","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"X-Api-Key","value":"{{access_key_api}}","type":"text"}],"url":"{{cw3_api_url}}/api/admin/asset/filename/{{filename}}"},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"status\": 409,\r\n \"error\": {\r\n \"message\": \"conflict\",\r\n \"summary\": \"unable to delete asset; `803f2a64f7dd4f0f434b746b2a991a42.jpg`; multiple assets\",\r\n \"verbose\": [\r\n \"1378\",\r\n \"1376\",\r\n \"1377\",\r\n \"1375\"\r\n ]\r\n }\r\n}"},{"id":"5227ea66-837e-44b5-946f-7faddbef2bd2","name":"(success) delete asset by filename","originalRequest":{"method":"DELETE","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"X-Api-Key","value":"{{access_key_api}}","type":"text"}],"url":"{{cw3_api_url}}/api/admin/asset/filename/{{filename}}/force"},"status":"No Content","code":204,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":""}],"_postman_id":"87e63d89-e0ad-43c2-b5bf-4fc3469eb8bf"},{"name":"archive asset (no backup of highres)","id":"35728f6b-cda3-4b44-855e-715013d0b714","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"value":"{{access_key_api}}","key":"Retains the asset record, but sets fields archived=1 and id_asset_status=2
\nUnpublishes the asset
\nDeletes thumb, preview, and original image files
\n","urlObject":{"path":["api","admin","asset","{{asset_id}}","archive"],"host":["{{cw3_api_url}}"],"query":[],"variable":[]}},"response":[{"id":"210eec0c-1dd8-4009-843a-dea703eb4032","name":"archive asset no backup of highres (success)","originalRequest":{"method":"DELETE","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"X-Api-Key","value":"{{access_key_api}}","type":"text"}],"url":"{{cw3_api_url}}/api/admin/asset/1105/archive"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 10 Mar 2020 13:56:18 GMT"},{"key":"Server","value":"Apache/2.4.41 (Win64) OpenSSL/1.1.1c PHP/7.3.14"},{"key":"Vary","value":"Authorization"},{"key":"Upgrade","value":"h2,h2c"},{"key":"Connection","value":"Upgrade, Keep-Alive"},{"key":"X-Powered-By","value":"capture API"},{"key":"Status","value":"200 OK"},{"key":"Access-Control-Allow-Origin","value":""},{"key":"Content-Language","value":"en"},{"key":"Content-Length","value":"65"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Content-Type","value":"application/json; charset=UTF-8"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"data\": {\n \"asset_id\": \"1105\",\n \"backup_high_res\": false\n }\n}"},{"id":"7d40dcf4-9610-4440-8d0f-30d2448e0196","name":"(fail) archive asset but asset is already archived","originalRequest":{"method":"DELETE","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"X-Api-Key","value":"{{access_key_api}}","type":"text"}],"url":"{{cw3_api_url}}/api/admin/asset/1104/archive"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 10 Mar 2020 13:55:42 GMT"},{"key":"Server","value":"Apache/2.4.41 (Win64) OpenSSL/1.1.1c PHP/7.3.14"},{"key":"Vary","value":"Authorization"},{"key":"Upgrade","value":"h2,h2c"},{"key":"Connection","value":"Upgrade, close"},{"key":"X-Powered-By","value":"capture API"},{"key":"Status","value":"400 Bad Request"},{"key":"Access-Control-Allow-Origin","value":""},{"key":"Content-Language","value":"en"},{"key":"Content-Length","value":"112"},{"key":"Content-Type","value":"application/json; charset=UTF-8"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 400,\n \"error\": {\n \"message\": \"bad request\",\n \"summary\": \"asset `1104` has already been archived\",\n \"verbose\": []\n }\n}"}],"_postman_id":"35728f6b-cda3-4b44-855e-715013d0b714"},{"name":"archive asset (with backup of highres)","id":"629f2f8f-fe36-4701-a365-1aee9b09b118","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"value":"{{access_key_api}}","key":"Retains the asset record, but sets fields archived=1 and id_asset_status=2
\nUnpublishes the asset
\nBacks up the thumb, preview, original image files to the user ftp folder
\n","urlObject":{"path":["api","admin","asset","{{asset_id}}","archive"],"host":["{{cw3_api_url}}"],"query":[],"variable":[]}},"response":[{"id":"7ad08321-c9b6-4777-8c95-406dcb0283c4","name":"(fail) archive asset but asset is already archived","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"X-Api-Key","value":"{{access_key_api}}","type":"text"}],"url":"{{cw3_api_url}}/api/admin/asset/1104/archive"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 10 Mar 2020 13:53:14 GMT"},{"key":"Server","value":"Apache/2.4.41 (Win64) OpenSSL/1.1.1c PHP/7.3.14"},{"key":"Vary","value":"Authorization"},{"key":"Upgrade","value":"h2,h2c"},{"key":"Connection","value":"Upgrade, close"},{"key":"X-Powered-By","value":"capture API"},{"key":"Status","value":"400 Bad Request"},{"key":"Access-Control-Allow-Origin","value":""},{"key":"Content-Language","value":"en"},{"key":"Content-Length","value":"112"},{"key":"Content-Type","value":"application/json; charset=UTF-8"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 400,\n \"error\": {\n \"message\": \"bad request\",\n \"summary\": \"asset `1104` has already been archived\",\n \"verbose\": []\n }\n}"},{"id":"ad0e7a0a-d783-4d95-aeb1-9d0619469bb9","name":"(success) archive asset with backup of highres","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"X-Api-Key","value":"{{access_key_api}}","type":"text"}],"url":"{{cw3_api_url}}/api/admin/asset/1105/archive"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 10 Mar 2020 13:53:14 GMT"},{"key":"Server","value":"Apache/2.4.41 (Win64) OpenSSL/1.1.1c PHP/7.3.14"},{"key":"Vary","value":"Authorization"},{"key":"Upgrade","value":"h2,h2c"},{"key":"Connection","value":"Upgrade, close"},{"key":"X-Powered-By","value":"capture API"},{"key":"Status","value":"400 Bad Request"},{"key":"Access-Control-Allow-Origin","value":""},{"key":"Content-Language","value":"en"},{"key":"Content-Length","value":"112"},{"key":"Content-Type","value":"application/json; charset=UTF-8"}],"cookie":[],"responseTime":null,"body":"{\r\n \"status\": 200,\r\n \"data\": {\r\n \"asset_id\": \"1105\",\r\n \"backup_high_res\": true\r\n }\r\n}"}],"_postman_id":"629f2f8f-fe36-4701-a365-1aee9b09b118"},{"name":"change publication status","id":"0964de34-b9bf-4d6b-b421-77bb653132f4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"value":"{{access_key_api}}","key":"Valid values are
\ne.g.
\nIf you PUT the asset into groups 81,84,85 the asset will appear under those groups.
\nIf you then make another call and PUT the asset into group 90, the asset will be removed from groups 81,84,85 and linked only to 90.
\nIf you wanted to keep the asset in the existing groups they must be sent with the request, e.g. PUT asset into groups 81,84,85,90.
\n","urlObject":{"path":["api","admin","asset","{{asset_id}}","groups"],"host":["{{cw3_api_url}}"],"query":[],"variable":[]}},"response":[{"id":"39f539b9-a715-4e53-9258-b658c14dcd9a","name":"update asset group associations (fail - incorrect asset id)","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"X-Api-Key","value":"{{access_key_api}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"groups\": [\r\n \t1,\r\n \t4\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"{{cw3_api_url}}/api/admin/asset/1110/groups"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 11 Mar 2020 23:15:48 GMT"},{"key":"Server","value":"Apache/2.4.41 (Win64) OpenSSL/1.1.1c PHP/7.3.14"},{"key":"Vary","value":"Authorization"},{"key":"Upgrade","value":"h2,h2c"},{"key":"Connection","value":"Upgrade, Keep-Alive"},{"key":"X-Powered-By","value":"capture API"},{"key":"Status","value":"404 Not Found"},{"key":"Access-Control-Allow-Origin","value":""},{"key":"Content-Language","value":"en"},{"key":"Content-Length","value":"94"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Content-Type","value":"application/json; charset=UTF-8"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 404,\n \"error\": {\n \"message\": \"not found\",\n \"summary\": \"asset `1110` not found\",\n \"verbose\": []\n }\n}"},{"id":"6bd3ac54-7407-4a8a-8eae-526b0a625c2f","name":"update asset group associations (fail - incorrect groups passed)","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"X-Api-Key","value":"{{access_key_api}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"groups\": [\r\n \t16,\r\n \t40\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"{{cw3_api_url}}/api/admin/asset/{{asset_id}}/groups"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 11 Mar 2020 23:18:15 GMT"},{"key":"Server","value":"Apache/2.4.41 (Win64) OpenSSL/1.1.1c PHP/7.3.14"},{"key":"Vary","value":"Authorization"},{"key":"Upgrade","value":"h2,h2c"},{"key":"Connection","value":"Upgrade, Keep-Alive"},{"key":"X-Powered-By","value":"capture API"},{"key":"Status","value":"404 Not Found"},{"key":"Access-Control-Allow-Origin","value":""},{"key":"Content-Language","value":"en"},{"key":"Content-Length","value":"97"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Content-Type","value":"application/json; charset=UTF-8"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 404,\n \"error\": {\n \"message\": \"not found\",\n \"summary\": \"group `16` does not exist\",\n \"verbose\": []\n }\n}"},{"id":"e1bda983-b702-4546-9a12-6e083788d462","name":"update asset group associations (success - replace asset group associations with groups 1,4)","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"X-Api-Key","value":"{{access_key_api}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"groups\": [\r\n \t1,4\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"{{cw3_api_url}}/api/admin/asset/{{asset_id}}/groups"},"status":"No Content","code":204,"_postman_previewlanguage":"plain","header":[{"key":"Date","value":"Tue, 10 Mar 2020 14:38:15 GMT"},{"key":"Server","value":"Apache/2.4.41 (Win64) OpenSSL/1.1.1c PHP/7.3.14"},{"key":"Vary","value":"Authorization"},{"key":"Upgrade","value":"h2,h2c"},{"key":"Connection","value":"Upgrade, Keep-Alive"},{"key":"X-Powered-By","value":"capture API"},{"key":"Status","value":"204 No Content"},{"key":"Access-Control-Allow-Origin","value":""},{"key":"Content-Language","value":"en"},{"key":"Keep-Alive","value":"timeout=5, max=100"}],"cookie":[],"responseTime":null,"body":null}],"_postman_id":"91847fda-105e-44d8-aca9-22f56d62746c"},{"name":"update asset license types","id":"de094020-7cc0-4943-a985-1e908fb0ce1e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"value":"{{access_key_api}}","key":"e.g.
\nIf you PUT the asset with license types 3, 4 the asset will be linked to those license types.
\nIf you then make another call and PUT the asset with license type 2, the asset will be unlinked from license types 3 and 4 and only linked to license type 2.
\nIf you wanted to keep the asset with the existing license types they must be sent with the request, e.g. PUT asset with license types 2, 3, 4.
\n","urlObject":{"path":["api","admin","asset","{{asset_id}}","licensetypes"],"host":["{{cw3_api_url}}"],"query":[],"variable":[]}},"response":[{"id":"57323a66-c28e-463f-99f5-dd38845a6e32","name":"update asset license types (success - replace current license associations with license types 3 and 4)","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"X-Api-Key","value":"{{access_key_api}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"licenseTypes\": [\n 3,\n 4\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{cw3_api_url}}/api/admin/asset/{{asset_id}}/licensetypes"},"status":"No Content","code":204,"_postman_previewlanguage":"plain","header":[{"key":"Date","value":"Tue, 10 Mar 2020 15:14:16 GMT"},{"key":"Server","value":"Apache/2.4.41 (Win64) OpenSSL/1.1.1c PHP/7.3.14"},{"key":"Vary","value":"Authorization"},{"key":"Upgrade","value":"h2,h2c"},{"key":"Connection","value":"Upgrade, Keep-Alive"},{"key":"X-Powered-By","value":"capture API"},{"key":"Status","value":"204 No Content"},{"key":"Access-Control-Allow-Origin","value":""},{"key":"Content-Language","value":"en"},{"key":"Keep-Alive","value":"timeout=5, max=100"}],"cookie":[],"responseTime":null,"body":null},{"id":"e5ec2256-5757-49a7-a5c3-5fb2d0fa5a69","name":"update asset license types (fail - non existent license id in request)","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"X-Api-Key","value":"{{access_key_api}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"licenseTypes\": [\n 8\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{cw3_api_url}}/api/admin/asset/{{asset_id}}/licensetypes"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 10 Mar 2020 15:15:19 GMT"},{"key":"Server","value":"Apache/2.4.41 (Win64) OpenSSL/1.1.1c PHP/7.3.14"},{"key":"Vary","value":"Authorization"},{"key":"Upgrade","value":"h2,h2c"},{"key":"Connection","value":"Upgrade, Keep-Alive"},{"key":"X-Powered-By","value":"capture API"},{"key":"Status","value":"404 Not Found"},{"key":"Access-Control-Allow-Origin","value":""},{"key":"Content-Language","value":"en"},{"key":"Content-Length","value":"103"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Content-Type","value":"application/json; charset=UTF-8"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 404,\n \"error\": {\n \"message\": \"not found\",\n \"summary\": \"license type `8` does not exist\",\n \"verbose\": []\n }\n}"}],"_postman_id":"de094020-7cc0-4943-a985-1e908fb0ce1e"},{"name":"update asset release status","id":"5a7d689a-576e-4a62-b5c9-28325cf5b4f9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"value":"{{access_key_api}}","key":"e.g.
\nIf you PUT the asset with release statuses 3, 4 the asset will be linked to those release status types.
\nIf you then make another call and PUT the asset with release status 2, the asset will be unlinked from 3 and 4 and only linked to 2.
\nIf you wanted to keep the asset with the existing release statuses they must be sent with the request, e.g. PUT asset with release status 2, 3, 4.
\n","urlObject":{"path":["api","admin","asset","{{asse_id}}","releasestatus"],"host":["{{cw3_api_url}}"],"query":[],"variable":[]}},"response":[{"id":"096c3c15-4702-467d-9d66-a046e544c922","name":"update asset release status (success - replace existing release statuses with 3 and 4)","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"X-Api-Key","value":"{{access_key_api}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"release_status\": [\r\n \t3,4\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"{{cw3_api_url}}/api/admin/asset/{{asset_id}}/releasestatus"},"status":"No Content","code":204,"_postman_previewlanguage":"plain","header":[{"key":"Date","value":"Tue, 10 Mar 2020 15:18:20 GMT"},{"key":"Server","value":"Apache/2.4.41 (Win64) OpenSSL/1.1.1c PHP/7.3.14"},{"key":"Vary","value":"Authorization"},{"key":"Upgrade","value":"h2,h2c"},{"key":"Connection","value":"Upgrade, Keep-Alive"},{"key":"X-Powered-By","value":"capture API"},{"key":"Status","value":"204 No Content"},{"key":"Access-Control-Allow-Origin","value":""},{"key":"Content-Language","value":"en"},{"key":"Keep-Alive","value":"timeout=5, max=100"}],"cookie":[],"responseTime":null,"body":null},{"id":"4c9c98e0-3137-4329-b42b-f893469ac04c","name":"update asset release status (fail - incorrect release status sent in request)","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"X-Api-Key","value":"{{access_key_api}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"release_status\": [\r\n \t10\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"{{cw3_api_url}}/api/admin/asset/{{asset_id}}/releasestatus"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 10 Mar 2020 15:21:56 GMT"},{"key":"Server","value":"Apache/2.4.41 (Win64) OpenSSL/1.1.1c PHP/7.3.14"},{"key":"Vary","value":"Authorization"},{"key":"Upgrade","value":"h2,h2c"},{"key":"Connection","value":"Upgrade, Keep-Alive"},{"key":"X-Powered-By","value":"capture API"},{"key":"Status","value":"404 Not Found"},{"key":"Access-Control-Allow-Origin","value":""},{"key":"Content-Language","value":"en"},{"key":"Content-Length","value":"99"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Content-Type","value":"application/json; charset=UTF-8"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 404,\n \"error\": {\n \"message\": \"not found\",\n \"summary\": \"release `10` does not exist\",\n \"verbose\": []\n }\n}"}],"_postman_id":"5a7d689a-576e-4a62-b5c9-28325cf5b4f9"},{"name":"update asset set country allowed","id":"a08613c5-816a-4b48-a596-387a0309c316","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"value":"{{access_key_api}}","key":"Changes the list of countries an asset is allowed to be viewed in. The asset will be restricted from any country not in this list.
\nIt is not necessary to set an asset country allow and an asset country deny - just one of the calls should be sufficient
\nNOTE - this is a PUT request, so the operation is to REPLACE the allowed countries the asset is associated with.
\ne.g.
\nIf you PUT the asset with countries 222, 223 the asset will be allowed in those countries.
\nIf you then make another call and PUT the asset with country 80, the asset will be unlinked from 222 and 223 and only linked to 80.
\nIf you wanted to keep the asset with the existing allowed countries, they must be sent with the request, e.g.\nPUT asset with countries 222, 223, 80.
\nTo remove all countries associated to the asset (making it available everywhere unless anything is set in the deny list), pass an empty array.
\n","urlObject":{"path":["api","admin","asset","{{asset_id}}","country","allow"],"host":["{{cw3_api_url}}"],"query":[],"variable":[]}},"response":[{"id":"2b920108-94ea-4d84-849c-48888775dd91","name":"success: remove all countries from allow list for given asset","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"X-Api-Key","value":"{{access_key_api}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"country_list\": []\r\n}","options":{"raw":{"language":"json"}}},"url":"{{cw3_api_url}}/api/admin/asset/7288/country/allow"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 11 May 2020 12:12:40 GMT"},{"key":"Server","value":"Apache/2.4.43 (Win64) OpenSSL/1.1.1f PHP/7.3.14"},{"key":"Vary","value":"Authorization"},{"key":"Upgrade","value":"h2,h2c"},{"key":"Connection","value":"Upgrade, Keep-Alive"},{"key":"X-Powered-By","value":"capture API"},{"key":"Status","value":"200 OK"},{"key":"Access-Control-Allow-Origin","value":""},{"key":"Content-Language","value":"en"},{"key":"Content-Length","value":"65"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Content-Type","value":"application/json; charset=UTF-8"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"data\": {\n \"asset_id\": 7288,\n \"allowed\": \"no restriction\"\n }\n}"},{"id":"42531e21-1e51-4b30-9032-9cef3bbd89a0","name":"fail: incorrect country id passed","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"X-Api-Key","value":"{{access_key_api}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"country_list\": [222,223, 280]\r\n}","options":{"raw":{"language":"json"}}},"url":"{{cw3_api_url}}/api/admin/asset/7288/country/allow"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 11 May 2020 12:11:52 GMT"},{"key":"Server","value":"Apache/2.4.43 (Win64) OpenSSL/1.1.1f PHP/7.3.14"},{"key":"Vary","value":"Authorization"},{"key":"Upgrade","value":"h2,h2c"},{"key":"Connection","value":"Upgrade, close"},{"key":"X-Powered-By","value":"capture API"},{"key":"Status","value":"400 Bad Request"},{"key":"Access-Control-Allow-Origin","value":""},{"key":"Content-Language","value":"en"},{"key":"Content-Length","value":"105"},{"key":"Content-Type","value":"application/json; charset=UTF-8"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 400,\n \"error\": {\n \"message\": \"bad request\",\n \"summary\": \"unrecognised country in request\",\n \"verbose\": []\n }\n}"},{"id":"bbd47801-2c89-44dc-9969-962c49c9cde8","name":"success: set UK and USA as allowed countries","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"X-Api-Key","value":"{{access_key_api}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"country_list\": [222,223]\r\n}","options":{"raw":{"language":"json"}}},"url":"{{cw3_api_url}}/api/admin/asset/7288/country/allow"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 11 May 2020 12:09:51 GMT"},{"key":"Server","value":"Apache/2.4.43 (Win64) OpenSSL/1.1.1f PHP/7.3.14"},{"key":"Vary","value":"Authorization"},{"key":"Upgrade","value":"h2,h2c"},{"key":"Connection","value":"Upgrade, Keep-Alive"},{"key":"X-Powered-By","value":"capture API"},{"key":"Status","value":"200 OK"},{"key":"Access-Control-Allow-Origin","value":""},{"key":"Content-Language","value":"en"},{"key":"Content-Length","value":"95"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Content-Type","value":"application/json; charset=UTF-8"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"data\": {\n \"asset_id\": 7288,\n \"allowed\": {\n \"222\": \"United Kingdom\",\n \"223\": \"United States\"\n }\n }\n}"}],"_postman_id":"a08613c5-816a-4b48-a596-387a0309c316"},{"name":"update asset set country denied","id":"24d92541-b15d-4e8f-88fc-5a48789415a7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"value":"{{access_key_api}}","key":"Changes the list of countries from which an asset is not allowed to be viewed. The asset will be restricted from any country in this list.
\nIt is not necessary to set an asset country allow and an asset country deny - just one of the calls should be sufficient
\nNOTE - this is a PUT request, so the operation is to REPLACE the denied countries the asset is associated with
\ne.g.
\nif you PUT the asset with countries 222, 223 the asset will be denied in those countries
\nif you then make another call and PUT the asset with country 80, the asset will be unlinked from 222 and 223 and only linked to 80
\nif you wanted to keep the asset with the existing denied countries, they must be sent with the request, e.g.\nPUT asset with countries 222, 223, 80.
\nTo remove all countries associated to the asset (making it available everywhere unless anything is set in the allow list), pass an empty array.
\n","urlObject":{"path":["api","admin","asset","{{asset_id}}","country","deny"],"host":["{{cw3_api_url}}"],"query":[],"variable":[]}},"response":[{"id":"17a9df66-b261-4f3d-961c-c5e2d375b629","name":"success: deny asset from UK and USA","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"country_list\": [\r\n \t223, 222\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{cw3_api_url}}/api/admin/asset/7288/country/deny?X-Api-Key={{access_key_api}}","host":["{{cw3_api_url}}"],"path":["api","admin","asset","7288","country","deny"],"query":[{"key":"X-Api-Key","value":"{{access_key_api}}","type":"text"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 11 May 2020 12:18:45 GMT"},{"key":"Server","value":"Apache/2.4.43 (Win64) OpenSSL/1.1.1f PHP/7.3.14"},{"key":"Vary","value":"Authorization"},{"key":"Upgrade","value":"h2,h2c"},{"key":"Connection","value":"Upgrade, Keep-Alive"},{"key":"X-Powered-By","value":"capture API"},{"key":"Status","value":"200 OK"},{"key":"Access-Control-Allow-Origin","value":""},{"key":"Content-Language","value":"en"},{"key":"Content-Length","value":"92"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Content-Type","value":"application/json; charset=UTF-8"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"data\": {\n \"asset_id\": 7288,\n \"deny\": {\n \"222\": \"United Kingdom\",\n \"223\": \"United States\"\n }\n }\n}"},{"id":"8787ea62-b6c3-4cbf-8141-0c68bf55872d","name":"fail: incorrect country id passed","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"X-Api-Key","value":"{{access_key_api}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"country_list\": [\r\n \t223, 222, 300\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"{{cw3_api_url}}/api/admin/asset/7288/country/deny"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 11 May 2020 12:19:58 GMT"},{"key":"Server","value":"Apache/2.4.43 (Win64) OpenSSL/1.1.1f PHP/7.3.14"},{"key":"Vary","value":"Authorization"},{"key":"Upgrade","value":"h2,h2c"},{"key":"Connection","value":"Upgrade, close"},{"key":"X-Powered-By","value":"capture API"},{"key":"Status","value":"400 Bad Request"},{"key":"Access-Control-Allow-Origin","value":""},{"key":"Content-Language","value":"en"},{"key":"Content-Length","value":"105"},{"key":"Content-Type","value":"application/json; charset=UTF-8"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 400,\n \"error\": {\n \"message\": \"bad request\",\n \"summary\": \"unrecognised country in request\",\n \"verbose\": []\n }\n}"},{"id":"ba31a125-6492-431b-92ca-f17942015740","name":"success: remove all countries from the assets deny list","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"X-Api-Key","value":"{{access_key_api}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"country_list\": []\r\n}","options":{"raw":{"language":"json"}}},"url":"{{cw3_api_url}}/api/admin/asset/7288/country/deny"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 11 May 2020 12:20:34 GMT"},{"key":"Server","value":"Apache/2.4.43 (Win64) OpenSSL/1.1.1f PHP/7.3.14"},{"key":"Vary","value":"Authorization"},{"key":"Upgrade","value":"h2,h2c"},{"key":"Connection","value":"Upgrade, Keep-Alive"},{"key":"X-Powered-By","value":"capture API"},{"key":"Status","value":"200 OK"},{"key":"Access-Control-Allow-Origin","value":""},{"key":"Content-Language","value":"en"},{"key":"Content-Length","value":"62"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Content-Type","value":"application/json; charset=UTF-8"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"data\": {\n \"asset_id\": 7288,\n \"deny\": \"no restriction\"\n }\n}"}],"_postman_id":"24d92541-b15d-4e8f-88fc-5a48789415a7"},{"name":"asset smart publish","id":"b201a273-32a2-494a-a2ba-436ce57eb9a9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"value":"{{access_key_api}}","key":"decides how best to publish an asset depending on its current publication state and the no_publish attribute which can be set on an asset.
changes the publication state of 1 or more assets to hidden, to quickly remove them from front end search and display.
the publication state is changed in the search index and in the main asset record. this does not make any changes to the asset files, cdn record etc - they all stay intact.
\nrequest data should be passed in the body of the request, preferably as json with a key name 'assets' and an array of integer asset id's to change.
\nchanges the publication state of 1 or more assets that are hidden back to published, to quickly reenable them to front end search and display.
the publication state is changed in the search index and in the main asset record. this does not make any changes to the asset files, cdn record etc - they all stay intact.
\nrequest data should be passed in the body of the request, preferably as json with a key name 'assets' and an array of integer asset id's to change.
\nreturns internal asset id, date, and a client specific status code for the events
\npaging can be controlled with two option parameters;
\nthis is optional with the date parameter;
earliest date:latest date where the date format is YYYYMMDD (e.g. date=20200618:20201215)integer specifying the result page to display
\n","type":"text/plain"},"key":"page","value":"70"},{"disabled":true,"description":{"content":"items per page to return. default 100 if omitted
\n","type":"text/plain"},"key":"itemsperpage","value":"10"},{"disabled":true,"description":{"content":"The default is the data of the last seven days\nstart date(Y-M-D) : end date(Y-M-D) OR date(Y-M-D)
\n","type":"text/plain"},"key":"date","value":"20201216"}],"variable":[]}},"response":[{"id":"157f1e45-d3f1-4765-929c-33161a356420","name":"success - asset activity logs for a specific date (26th May 2020 in this example)","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"X-Api-Key","value":"{{access_key_api}}","type":"text"}],"url":{"raw":"{{cw3_api_url}}/api/admin/asset/activitylogs?itemsperpage=10&date=20200526","host":["{{cw3_api_url}}"],"path":["api","admin","asset","activitylogs"],"query":[{"key":"page","value":"70","description":"integer specifying the result page to display","disabled":true},{"key":"itemsperpage","value":"10","description":"items per page to return. default 100 if omitted"},{"key":"date","value":"20200526","description":"The default is the data of the last seven days\nstart date(Y-M-D) : end date(Y-M-D) OR date(Y-M-D)\n"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 15 Dec 2020 07:27:01 GMT"},{"key":"Server","value":"Apache"},{"key":"Vary","value":"Authorization"},{"key":"Upgrade","value":"h2,h2c"},{"key":"Connection","value":"Upgrade, Keep-Alive"},{"key":"X-Powered-By","value":"capture API"},{"key":"Status","value":"200 OK"},{"key":"Access-Control-Allow-Origin","value":""},{"key":"Content-Language","value":"en"},{"key":"Content-Length","value":"618"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Content-Type","value":"application/json; charset=UTF-8"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"data\": {\n \"total\": 157,\n \"returned\": 10,\n \"pages\": 16,\n \"page\": 1,\n \"logs\": [\n {\n \"date\": \"20200526-235537\",\n \"status\": 1,\n \"asset_id\": \"17\"\n },\n {\n \"date\": \"20200526-223732\",\n \"status\": 1,\n \"asset_id\": \"23\"\n },\n {\n \"date\": \"20200526-223627\",\n \"status\": 1,\n \"asset_id\": \"37\"\n },\n {\n \"date\": \"20200526-212902\",\n \"status\": 2,\n \"asset_id\": \"85\"\n },\n {\n \"date\": \"20200526-212859\",\n \"status\": 1,\n \"asset_id\": \"85\"\n },\n {\n \"date\": \"20200526-212858\",\n \"status\": 2,\n \"asset_id\": \"83\"\n },\n {\n \"date\": \"20200526-212855\",\n \"status\": 1,\n \"asset_id\": \"83\"\n },\n {\n \"date\": \"20200526-212854\",\n \"status\": 2,\n \"asset_id\": \"82\"\n },\n {\n \"date\": \"20200526-212852\",\n \"status\": 1,\n \"asset_id\": \"82\"\n },\n {\n \"date\": \"20200526-212850\",\n \"status\": 2,\n \"asset_id\": \"81\"\n }\n ]\n }\n}"},{"id":"57502178-9716-4eb3-a987-9c85026eec9d","name":" success - asset activity logs for last 7 days","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"X-Api-Key","value":"{{access_key_api}}","type":"text"}],"url":{"raw":"{{cw3_api_url}}/api/admin/asset/activitylogs","host":["{{cw3_api_url}}"],"path":["api","admin","asset","activitylogs"],"query":[{"key":"page","value":"7","description":"integer specifying the result page to display","disabled":true},{"key":"itemsperpage","value":"10","description":"items per page to return. default 100 if omitted","disabled":true},{"key":"date","value":"20190101:20201215","description":"The default is the data of the last seven days\nstart date(Y-M-D) : end date(Y-M-D) OR date(Y-M-D)\n","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 15 Dec 2020 07:24:03 GMT"},{"key":"Server","value":"Apache"},{"key":"Vary","value":"Authorization"},{"key":"Upgrade","value":"h2,h2c"},{"key":"Connection","value":"Upgrade, Keep-Alive"},{"key":"X-Powered-By","value":"capture API"},{"key":"Status","value":"200 OK"},{"key":"Access-Control-Allow-Origin","value":""},{"key":"Content-Language","value":"en"},{"key":"Content-Length","value":"294"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Content-Type","value":"application/json; charset=UTF-8"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"data\": {\n \"total\": 4,\n \"returned\": 4,\n \"pages\": 1,\n \"page\": 1,\n \"logs\": [\n {\n \"date\": \"20201211-093643\",\n \"status\": 3,\n \"asset_id\": \"134\"\n },\n {\n \"date\": \"20201211-093637\",\n \"status\": 2,\n \"asset_id\": \"134\"\n },\n {\n \"date\": \"20201211-093559\",\n \"status\": 2,\n \"asset_id\": \"135\"\n },\n {\n \"date\": \"20201211-093547\",\n \"status\": 1,\n \"asset_id\": \"134\"\n }\n ]\n }\n}"},{"id":"c4fdf2e2-a5d8-43c3-a06c-5c13e68e7d16","name":"fail - no logs found, in this example because invalid date (set to tomorrow)","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"X-Api-Key","value":"{{access_key_api}}","type":"text"}],"url":{"raw":"{{cw3_api_url}}/api/admin/asset/activitylogs?itemsperpage=10&date=20201216","host":["{{cw3_api_url}}"],"path":["api","admin","asset","activitylogs"],"query":[{"key":"page","value":"70","description":"integer specifying the result page to display","disabled":true},{"key":"itemsperpage","value":"10","description":"items per page to return. default 100 if omitted"},{"key":"date","value":"20201216","description":"The default is the data of the last seven days\nstart date(Y-M-D) : end date(Y-M-D) OR date(Y-M-D)\n"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 15 Dec 2020 07:28:37 GMT"},{"key":"Server","value":"Apache"},{"key":"Vary","value":"Authorization"},{"key":"Upgrade","value":"h2,h2c"},{"key":"Connection","value":"Upgrade, Keep-Alive"},{"key":"X-Powered-By","value":"capture API"},{"key":"Status","value":"404 Not Found"},{"key":"Access-Control-Allow-Origin","value":""},{"key":"Content-Language","value":"en"},{"key":"Content-Length","value":"98"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Content-Type","value":"application/json; charset=UTF-8"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 404,\n \"error\": {\n \"message\": \"not found\",\n \"summary\": \"no logged events available\",\n \"verbose\": []\n }\n}"},{"id":"fab1e2f3-c58e-4c44-9571-4487e282dfc7","name":" success - asset activity logs for date range Jan 1st 2019 to Dec 15th 2020, 10 items per page","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"X-Api-Key","value":"{{access_key_api}}","type":"text"}],"url":{"raw":"{{cw3_api_url}}/api/admin/asset/activitylogs?itemsperpage=10&date=20190101:20201215","host":["{{cw3_api_url}}"],"path":["api","admin","asset","activitylogs"],"query":[{"key":"page","value":"7","description":"integer specifying the result page to display","disabled":true},{"key":"itemsperpage","value":"10","description":"items per page to return. default 100 if omitted"},{"key":"date","value":"20190101:20201215","description":"The default is the data of the last seven days\nstart date(Y-M-D) : end date(Y-M-D) OR date(Y-M-D)\n"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 15 Dec 2020 07:25:20 GMT"},{"key":"Server","value":"Apache"},{"key":"Vary","value":"Authorization"},{"key":"Upgrade","value":"h2,h2c"},{"key":"Connection","value":"Upgrade, Keep-Alive"},{"key":"X-Powered-By","value":"capture API"},{"key":"Status","value":"200 OK"},{"key":"Access-Control-Allow-Origin","value":""},{"key":"Content-Language","value":"en"},{"key":"Content-Length","value":"626"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Content-Type","value":"application/json; charset=UTF-8"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"data\": {\n \"total\": 2118,\n \"returned\": 10,\n \"pages\": 212,\n \"page\": 1,\n \"logs\": [\n {\n \"date\": \"20201211-093643\",\n \"status\": 3,\n \"asset_id\": \"134\"\n },\n {\n \"date\": \"20201211-093637\",\n \"status\": 2,\n \"asset_id\": \"134\"\n },\n {\n \"date\": \"20201211-093559\",\n \"status\": 2,\n \"asset_id\": \"135\"\n },\n {\n \"date\": \"20201211-093547\",\n \"status\": 1,\n \"asset_id\": \"134\"\n },\n {\n \"date\": \"20201204-135143\",\n \"status\": 1,\n \"asset_id\": \"88\"\n },\n {\n \"date\": \"20201204-135141\",\n \"status\": 1,\n \"asset_id\": \"87\"\n },\n {\n \"date\": \"20201204-134335\",\n \"status\": 1,\n \"asset_id\": \"109\"\n },\n {\n \"date\": \"20201204-134334\",\n \"status\": 1,\n \"asset_id\": \"70\"\n },\n {\n \"date\": \"20201204-134331\",\n \"status\": 1,\n \"asset_id\": \"109\"\n },\n {\n \"date\": \"20201203-193059\",\n \"status\": 1,\n \"asset_id\": \"96\"\n }\n ]\n }\n}"}],"_postman_id":"1d4641bb-cb34-4fda-b883-53eab8b91aa3"}],"id":"525dd0f3-1a52-4d33-a8d1-06b317755e43","description":"The section contains endpoints allowing create, read, update and delete operations on Assets.
\nThey require an authenticated user with admin rights. This is achieved by setting the relevant users contact_type to one which has the is_staff flag set.
\nAll these endpoints support multilingual message response if additional languages are defined in the system. By default all messages are returned in English (British), but preferred language can be requested by sending the Accept-Language header with a basic 2-character language code, for example
\nAccept-Language: fi
\nwill (if Finnish is a configured language) return messages in Finnish, but will revert to English if the preferred language is not available.
\n","event":[{"listen":"prerequest","script":{"id":"cc5fa9cf-4cbd-441c-a9e3-9d7fc07b4412","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"2d874ff2-f757-4947-bc69-3954181d4b37","type":"text/javascript","exec":[""]}}],"_postman_id":"525dd0f3-1a52-4d33-a8d1-06b317755e43"},{"name":"Contacts","item":[{"name":"get contacts","id":"8aa03024-dda5-4d7e-8771-c6d579236b5a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"value":"{{access_key_api}}","key":"Filtering is possible based on First Name, Last Name, email domain, created and last_activity
\n","urlObject":{"path":["api","admin","contacts"],"host":["{{cw3_api_url}}"],"query":[{"description":{"content":"First Name
\n","type":"text/plain"},"key":"fname","value":null},{"description":{"content":"Last Name
\n","type":"text/plain"},"key":"lname","value":null},{"description":{"content":"email domain
\n","type":"text/plain"},"key":"email","value":"example.com"},{"description":{"content":"start date(Y-M-D) : end date(Y-M-D) OR date(Y-M-D)
\n","type":"text/plain"},"key":"created","value":"2020-01-01:2020-09-31"},{"description":{"content":"start date(Y-M-D) : end date(Y-M-D) OR date(Y-M-D)
\n","type":"text/plain"},"key":"last_activity","value":""},{"description":{"content":"integer specifying the result page to display
\n","type":"text/plain"},"key":"page","value":"1"},{"description":{"content":"items per page to return. default 100 if omitted
\n","type":"text/plain"},"key":"itemsPerPage","value":"20"}],"variable":[]}},"response":[{"id":"9d124b4c-171f-4cf6-873e-06c5dd8f57ee","name":"get contacts","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"X-Api-Key","value":"{{access_key_api}}","type":"text"}],"url":{"raw":"{{cw3_api_url}}/api/admin/contacts?fname&lname&email=example.com&created=2020-01-01:2020-09-31&last_activity=&page=1&itemsPerPage=20","host":["{{cw3_api_url}}"],"path":["api","admin","contacts"],"query":[{"key":"fname","value":null,"description":"First Name"},{"key":"lname","value":null,"description":"Last Name"},{"key":"email","value":"example.com","description":"email domain"},{"key":"created","value":"2020-01-01:2020-09-31","description":"start date(Y-M-D) : end date(Y-M-D) OR date(Y-M-D)"},{"key":"last_activity","value":"","description":"start date(Y-M-D) : end date(Y-M-D) OR date(Y-M-D)"},{"key":"page","value":"1","description":"integer specifying the result page to display"},{"key":"itemsPerPage","value":"20","description":"items per page to return. default 100 if omitted"}]}},"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"data\": {\n \"total\": 2,\n \"returned\": 2,\n \"pages\": 1,\n \"page\": 1,\n \"contacts\": [\n {\n \"contact_id\": \"56\",\n \"userId\": \"56\",\n \"idcontacts\": \"56\",\n \"fname\": \"John\",\n \"lname\": \"Smith\",\n \"email\": \"John.Smith@example.com\",\n \"photo_code\": null,\n \"is_staff\": false,\n \"is_submissions_editor\": false,\n \"user_id\": null,\n \"contributor\": false,\n \"hotfolder\": false,\n \"srm_enabled\": false,\n \"category\": [],\n \"type\": {\n \"idcontact_type\": 3,\n \"name\": \"Client - full\"\n }\n },\n {\n \"contact_id\": \"32\",\n \"userId\": \"32\",\n \"idcontacts\": \"32\",\n \"fname\": \"Jane\",\n \"lname\": \"Doe\",\n \"email\": \"Jane.Doe@example.com\",\n \"photo_code\": null,\n \"is_staff\": false,\n \"is_submissions_editor\": false,\n \"user_id\": null,\n \"contributor\": false,\n \"hotfolder\": false,\n \"srm_enabled\": false,\n \"category\": [],\n \"type\": {\n \"idcontact_type\": 3,\n \"name\": \"Client - full\"\n }\n }\n ]\n }\n}"}],"_postman_id":"8aa03024-dda5-4d7e-8771-c6d579236b5a"},{"name":"get contact by id","id":"ce0205e3-17da-4d55-83aa-09caa3cefb26","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"value":"{{access_key_api}}","key":"Indicates how many items and children each lightbox has.
\n","urlObject":{"path":["api","admin","contact","{{contact_id}}","lightboxes"],"host":["{{cw3_api_url}}"],"query":[{"description":{"content":"integer specifying the result page to display
\n","type":"text/plain"},"key":"page","value":"1"},{"description":{"content":"items per page to return. default 100 if omitted
\n","type":"text/plain"},"key":"itemsPerPage","value":"20"}],"variable":[]}},"response":[{"id":"2c4f8fa6-f940-4cfe-8a3d-0dcbf9b1aa2d","name":"get contact lightboxes","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"X-Api-Key","value":"{{access_key_api}}","type":"text"}],"url":{"raw":"{{cw3_api_url}}/api/admin/contact/99/lightboxes?page=1&itemsPerPage=20","host":["{{cw3_api_url}}"],"path":["api","admin","contact","99","lightboxes"],"query":[{"key":"page","value":"1","description":"integer specifying the result page to display"},{"key":"itemsPerPage","value":"20","description":"items per page to return. default 100 if omitted"}]}},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"status\": 200,\r\n \"data\": {\r\n \"total\": 1,\r\n \"returned\": 1,\r\n \"pages\": 1,\r\n \"page\": 1,\r\n \"lightboxes\": [\r\n {\r\n \"lightbox_id\": \"86\",\r\n \"id_lightbox\": \"86\",\r\n \"parent_id\": \"0\",\r\n \"name\": \"My lightbox\",\r\n \"create_date\": \"2020-06-22 08:43:55\",\r\n \"update_date\": null,\r\n \"item_count\": 0,\r\n \"child_count\": 0,\r\n \"is_default\": true,\r\n \"metadata\": []\r\n }\r\n ]\r\n }\r\n}"}],"_postman_id":"1cc10453-c68f-46fc-af7e-70173be1385f"},{"name":"get contact baskets","id":"c41925e3-f3a3-445b-b753-6de181cf24d3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"value":"{{access_key_api}}","key":"Pagination available
\n","urlObject":{"path":["api","admin","contact","{{contact_id}}","baskets"],"host":["{{cw3_api_url}}"],"query":[{"description":{"content":"integer specifying the result page to display
\n","type":"text/plain"},"key":"page","value":"1"},{"description":{"content":"items per page to return. default 100 if omitted
\n","type":"text/plain"},"key":"itemsPerPage","value":"20"}],"variable":[]}},"response":[{"id":"3c68963e-0c5b-4093-b5cb-a233cee1d9ee","name":"get contact baskets","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"X-Api-Key","value":"{{access_key_api}}","type":"text"}],"url":{"raw":"{{cw3_api_url}}/api/admin/contact/99/baskets?page=1&itemsPerPage=20","host":["{{cw3_api_url}}"],"path":["api","admin","contact","99","baskets"],"query":[{"key":"page","value":"1","description":"integer specifying the result page to display"},{"key":"itemsPerPage","value":"20","description":"items per page to return. default 100 if omitted"}]}},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"status\": 200,\r\n \"data\": {\r\n \"total\": 13,\r\n \"returned\": 13,\r\n \"pages\": 1,\r\n \"page\": 1,\r\n \"baskets\": [\r\n {\r\n \"basket_id\": 104,\r\n \"name\": \"My Basket 1\",\r\n \"created_date\": \"2020-06-18 06:42:01\",\r\n \"last_updated\": \"2020-07-07 10:51:06\",\r\n \"item_count\": 0\r\n },\r\n {\r\n \"basket_id\": 102,\r\n \"name\": \"My Basket 2\",\r\n \"created_date\": \"2020-06-18 06:08:58\",\r\n \"last_updated\": \"2020-07-07 10:51:06\",\r\n \"item_count\": 0\r\n },\r\n {\r\n \"basket_id\": 93,\r\n \"name\": \"My Basket 3\",\r\n \"created_date\": \"2020-06-12 04:57:59\",\r\n \"last_updated\": \"2020-07-07 10:51:06\",\r\n \"item_count\": 1\r\n },\r\n {\r\n \"basket_id\": 92,\r\n \"name\": \"My Basket 4\",\r\n \"created_date\": \"2020-06-12 04:57:57\",\r\n \"last_updated\": \"2020-07-07 10:51:06\",\r\n \"item_count\": 1\r\n },\r\n {\r\n \"basket_id\": 91,\r\n \"name\": \"My Basket 5\",\r\n \"created_date\": \"2020-06-12 04:56:30\",\r\n \"last_updated\": \"2020-07-07 10:51:06\",\r\n \"item_count\": 2\r\n },\r\n {\r\n \"basket_id\": 90,\r\n \"name\": \"My Basket 6\",\r\n \"created_date\": \"2020-06-12 04:55:10\",\r\n \"last_updated\": \"2020-07-07 10:51:06\",\r\n \"item_count\": 1\r\n },\r\n {\r\n \"basket_id\": 49,\r\n \"name\": \"My Basket 7\",\r\n \"created_date\": \"2020-05-22 09:44:12\",\r\n \"last_updated\": \"2020-07-07 10:51:06\",\r\n \"item_count\": 1\r\n },\r\n {\r\n \"basket_id\": 48,\r\n \"name\": \"My Basket 8\",\r\n \"created_date\": \"2020-05-22 09:44:11\",\r\n \"last_updated\": \"2020-07-07 10:51:06\",\r\n \"item_count\": 0\r\n },\r\n {\r\n \"basket_id\": 38,\r\n \"name\": \"My Basket 9\",\r\n \"created_date\": \"2020-05-20 04:03:49\",\r\n \"last_updated\": \"2020-07-07 10:51:06\",\r\n \"item_count\": 1\r\n },\r\n {\r\n \"basket_id\": 35,\r\n \"name\": \"My Basket 10\",\r\n \"created_date\": \"2020-05-20 03:52:29\",\r\n \"last_updated\": \"2020-07-07 10:51:06\",\r\n \"item_count\": 1\r\n },\r\n {\r\n \"basket_id\": 32,\r\n \"name\": \"My Basket 11\",\r\n \"created_date\": \"2020-05-19 03:09:18\",\r\n \"last_updated\": \"2020-07-07 10:51:06\",\r\n \"item_count\": 1\r\n },\r\n {\r\n \"basket_id\": 31,\r\n \"name\": \"My Basket 12\",\r\n \"created_date\": \"2020-05-19 03:07:17\",\r\n \"last_updated\": \"2020-07-07 10:51:06\",\r\n \"item_count\": 1\r\n },\r\n {\r\n \"basket_id\": 30,\r\n \"name\": \"My Basket 13\",\r\n \"created_date\": \"2020-05-19 03:06:06\",\r\n \"last_updated\": \"2020-07-07 10:51:06\",\r\n \"item_count\": 1\r\n }\r\n ]\r\n }\r\n}"}],"_postman_id":"c41925e3-f3a3-445b-b753-6de181cf24d3"}],"id":"aa6ed70f-4e94-490a-89af-a78cbfc5d03c","_postman_id":"aa6ed70f-4e94-490a-89af-a78cbfc5d03c","description":""},{"name":"V2 Asset create / update","item":[{"name":"create asset","id":"9faf3dfe-7fb2-4b01-93c6-8a6ca0d49799","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"value":"{{access_key_api}}","key":"This just creates the asset/metadata record - it does not accept the actual file to be stored against this asset record
\nThe http response for a successful create is 201 Created
\nThe following metadata field data types are currently supported
\ntext; see md25 (Copyright) as an example, or md1 (Subject) as a multilingual example
\ndropdown; linked to a defined keyword list, see md29 (Country) as an example
\nmulticheckbox; linked to a defined keyword list, see md36 (Image type) as a multilingual example
\ndate, preferably following the format YYYY-MM-DD; see md4 as an example
\ncheckbox, simple 0 or 1 value only; see md54 (Global Sales) as an example
\nIn the case of multilingual fields, value data for all enabled languages must be passed (even if the value data is not translated). For example, a site supporting both English and Finnish multilingual data would be passed as an array with the keys being the lowercase 2 character country code.
\nMultilingual Text or Dropdown
\n\"md2\": {\n \"en\": \"English Description\",\n \"fi\": \"Finnish Description\"\n}\n\nMulticheckbox fields must have the values passed as arrays, as they support multiple values. e.g.
\n\"mdX\": [\n \"value1\", \"value2\"\n]\n\nMultilingual multicheckbox therefore must be an array of languages, each with array data e.g.
\n\"md36\": {\n \"en\": [\"Royalty Free\", \"Editorial images\"],\n \"fi\": [\"Rojaltivapaa\", \"Uutiskuvat\"]\n}\n\nasset and metadata sections are always required for create.
\nWithin the asset section, org_filename (the original filename of the image/video file) is the minimum required data, other asset fields are optional, but in practice it is usual to provide more data.
Within the metadatasection, while all the mdX fields are technically optional, in practice it is usual to provide some data. Any fields provided will be checked for data type validity. Text fields are accepted as free-form text, date fields should follow convential date formats (ideally yyyy-mm-dd to avoid ambiguity), and as dropdown or multicheckbox fields tend to be linked to a defined keyword list, so the supplied values will be checked against these.
Some mdX fields may be defined in COO as \"use as\" fields (the is_xxx fields in metadata_config). These can not be set directly as they store calculated data. These fields can be defined on a per client basis they are not listed in this documentation, but we can provide a list of fields that are useable from the create/update calls.
license_types - links the asset to one or more license types
\nrelease_status - links the asset to one or more release statuses
\ngroups - places the asset inside one or more groups
\ncountry_allow - sets the list of countries an asset can be visible in
\ncountry_deny - set the list of countries as asset is restricted from
\nNote - for country restrictions, only use one of country_allow or country_deny depending on which makes most sense. Do not use both in the same request
\nPreviously create would always create an asset, even if it already existed. Now create will reject the request if an asset already exists with the same org_filename. This takes the form of a 409 Conflict response.
With the recent updates to our system stack to keep up to date with security, bug and performance fixes, changes in the underlying database driver have meant that the asset id is now (correctly) being returned as an integer value (\"asset_id\": 12345678), whereas previously it was returned as a string (\"asset_id\": \"12345678\"). While loosely typed languages such as PHP and javascript don't really care about this, if you are calling the API from a strongly typed language it may have a problem if a value previously returned as a numeric string is now returned as a proper numeric value.
\nWe will be looking to maintain the response so that numbers are returned as numeric values and not as numeric strings, however we would advise adding some resilience to code calling our API to be aware of this. If numeric strings are found in the response and you believe they should be numbers please advise us so we can look into it.
\n","urlObject":{"path":["api","v2","admin","asset"],"host":["{{cw3_api_url}}"],"query":[],"variable":[]}},"response":[{"id":"90989695-c7c0-4b99-98bd-8145eb46dd1c","name":"success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"X-Api-Key","value":"{{access_key_api}}","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"asset\":{\n\t\t\"org_filename\": \"CAP-540-004.jpg\",\n \"batchname\": \"CAPAPITEST\",\n \"externalid1\": \"CAP-540-004\",\n \"photographer_code\": \"GM1967\",\n \"no_publish\": 0,\n \"access_level\": 3,\n \"min_price\": 0.00,\n \"fixedprice\": 0\n\t},\n \"metadata\": {\n \t\"md1\": {\n \t\t\"en\":\"Subject (example)\",\n \t\t\"fi\":\"Aihe (esimerkki)\"\n \t},\n \t\"md2\": {\n \t\t\"en\": \"Description (example)\",\n \t\t\"fi\": \"Kuvaus (esimerkki)\"\n \t},\n \t\"md3\": {\n \"en\": \"lobster; turtle; shark; squid; octopus; dolphin\",\n \"fi\": \"hummeri; kilpikonna; hai; kalmari; mustekala; delfiini\"\n },\n \"md4\": \"2023-02-08\",\n \"md5\": {\n \"en\": \"Beijing\",\n \"fi\": \"Peking\"\n },\n \"md7\": {\n \"en\": \"China\",\n \"fi\": \"Kiina\"\n },\n \"md8\": \"Special Instructions\",\n \"md9\": \"Gavin Photographer\",\n \"md10\": \"Capture\",\n \"md25\": \"©2023 Capture Ltd\",\n \"md29\": \"China\",\n \"md30\": \"Original Source\",\n \"md36\": {\n \"en\": [\"Royalty Free\", \"Editorial images\"],\n \"fi\": [\"Rojaltivapaa\", \"Uutiskuvat\"]\n },\n \"md40\": \"7654321\",\n \"md41\": \"20230208173445\",\n \"md42\": \"20230208173445\",\n \"md44\": \"Yes\",\n \"md45\": \"CAP-540 Project\",\n \"md46\": \"20230208\",\n \"md48\": \"Subject to royalty\",\n \"md49\": \"Wired\",\n \"md51\": \"No\",\n \"md52\": \"No\",\n \"md53\": \"3 Royaltin alaiset\",\n \"md54\": 0\n },\n \"license_types\": [3],\n \"release_status\": [2],\n \"groups\": [90],\n \"country_allow\" : [70]\n}","options":{"raw":{"language":"json"}}},"url":"{{cw3_api_url}}/api/v2/admin/asset"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 201,\n \"data\": {\n \"asset_id\": 130000003,\n \"org_filename\": \"CAP-540-004.jpg\",\n \"externalid1\": \"CAP-540-004\"\n }\n}"},{"id":"af78551c-7d03-4d50-95d3-aaff74100691","name":"fail - contact not found for specified contact_id","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"X-Api-Key","value":"{{access_key_api}}","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"asset\":{\n\t\t\"org_filename\": \"CAP-540-004.jpg\",\n \"batchname\": \"CAPAPITEST\",\n \"externalid1\": \"CAP-540-004\",\n \"photographer_code\": \"GM1967\",\n \"no_publish\": 0,\n \"access_level\": 3,\n \"min_price\": 0.00,\n \"fixedprice\": 0\n\t},\n \"metadata\": {\n \t\"md1\": {\n \t\t\"en\":\"Subject (example)\",\n \t\t\"fi\":\"Aihe (esimerkki)\"\n \t},\n \t\"md2\": {\n \t\t\"en\": \"Description (example)\",\n \t\t\"fi\": \"Kuvaus (esimerkki)\"\n \t},\n \t\"md3\": {\n \"en\": \"lobster; turtle; shark; squid; octopus; dolphin\",\n \"fi\": \"hummeri; kilpikonna; hai; kalmari; mustekala; delfiini\"\n },\n \"md4\": \"2023-02-08\",\n \"md5\": {\n \"en\": \"Beijing\",\n \"fi\": \"Peking\"\n },\n \"md7\": {\n \"en\": \"China\",\n \"fi\": \"Kiina\"\n },\n \"md8\": \"Special Instructions\",\n \"md9\": \"Gavin Photographer\",\n \"md10\": \"Capture\",\n \"md25\": \"©2023 Capture Ltd\",\n \"md29\": \"China\",\n \"md30\": \"Original Source\",\n \"md36\": {\n \"en\": [\"Royalty Free\", \"Editorial images\"],\n \"fi\": [\"Rojaltivapaa\", \"Uutiskuvat\"]\n },\n \"md40\": \"7654321\",\n \"md41\": \"20230208173445\",\n \"md42\": \"20230208173445\",\n \"md44\": \"Yes\",\n \"md45\": \"CAP-540 Project\",\n \"md46\": \"20230208\",\n \"md48\": \"Subject to royalty\",\n \"md49\": \"Wired\",\n \"md51\": \"No\",\n \"md52\": \"No\",\n \"md53\": \"3 Royaltin alaiset\",\n \"md54\": 0\n },\n \"license_types\": [3],\n \"release_status\": [2],\n \"groups\": [90],\n \"country_allow\" : [70]\n}","options":{"raw":{"language":"json"}}},"url":"{{cw3_api_url}}/api/v2/admin/asset"},"status":"Conflict","code":409,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 03 Mar 2020 16:29:36 GMT"},{"key":"Server","value":"Apache"},{"key":"Vary","value":"Authorization"},{"key":"Upgrade","value":"h2,h2c"},{"key":"Connection","value":"Upgrade, close"},{"key":"X-Powered-By","value":"capture API"},{"key":"Status","value":"400 Bad Request"},{"key":"Access-Control-Allow-Origin","value":""},{"key":"Content-Language","value":"en"},{"key":"Content-Length","value":"171"},{"key":"Content-Type","value":"application/json; charset=UTF-8"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 409,\n \"error\": {\n \"message\": \"conflict\",\n \"summary\": \"unable to create asset; asset with org_filename `CAP-540-004.jpg` already exists\",\n \"verbose\": []\n }\n}"},{"id":"4176a8be-3426-4b8a-bf01-817317d1a875","name":"fail - invalid date provided to a date field","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"X-Api-Key","value":"{{access_key_api}}","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"asset\":{\n\t\t\"org_filename\": \"CAP-540-005.jpg\",\n \"batchname\": \"CAPAPITEST\",\n \"externalid1\": \"CAP-540-005\",\n \"photographer_code\": \"GM1967\",\n \"no_publish\": 0,\n \"access_level\": 3,\n \"min_price\": 0.00,\n \"fixedprice\": 0\n\t},\n \"metadata\": {\n \t\"md1\": {\n \t\t\"en\":\"Subject (example)\",\n \t\t\"fi\":\"Aihe (esimerkki)\"\n \t},\n \t\"md2\": {\n \t\t\"en\": \"Description (example)\",\n \t\t\"fi\": \"Kuvaus (esimerkki)\"\n \t},\n \t\"md3\": {\n \"en\": \"lobster; turtle; shark; squid; octopus; dolphin\",\n \"fi\": \"hummeri; kilpikonna; hai; kalmari; mustekala; delfiini\"\n },\n \"md4\": \"this should be a date\",\n \"md5\": {\n \"en\": \"Beijing\",\n \"fi\": \"Peking\"\n },\n \"md7\": {\n \"en\": \"China\",\n \"fi\": \"Kiina\"\n },\n \"md8\": \"Special Instructions\",\n \"md9\": \"Gavin Photographer\",\n \"md10\": \"Capture\",\n \"md25\": \"©2023 Capture Ltd\",\n \"md29\": \"China\",\n \"md30\": \"Original Source\",\n \"md36\": {\n \"en\": [\"Royalty Free\", \"Editorial images\"],\n \"fi\": [\"Rojaltivapaa\", \"Uutiskuvat\"]\n },\n \"md40\": \"7654321\",\n \"md41\": \"20230208173445\",\n \"md42\": \"20230208173445\",\n \"md44\": \"Yes\",\n \"md45\": \"CAP-540 Project\",\n \"md46\": \"20230208\",\n \"md48\": \"Subject to royalty\",\n \"md49\": \"Wired\",\n \"md51\": \"No\",\n \"md52\": \"No\",\n \"md53\": \"3 Royaltin alaiset\",\n \"md54\": 0\n },\n \"license_types\": [3],\n \"release_status\": [2],\n \"groups\": [90],\n \"country_allow\" : [70]\n}","options":{"raw":{"language":"json"}}},"url":"{{cw3_api_url}}/api/v2/admin/asset"},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 03 Mar 2020 16:32:05 GMT"},{"key":"Server","value":"Apache"},{"key":"Vary","value":"Authorization"},{"key":"Upgrade","value":"h2,h2c"},{"key":"Connection","value":"Upgrade, close"},{"key":"X-Powered-By","value":"capture API"},{"key":"Status","value":"400 Bad Request"},{"key":"Access-Control-Allow-Origin","value":""},{"key":"Content-Language","value":"en"},{"key":"Content-Length","value":"244"},{"key":"Content-Type","value":"application/json; charset=UTF-8"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 422,\n \"error\": {\n \"message\": \"unprocessable entity\",\n \"summary\": \"one or more metadata fields in the request are incorrect for the defined field data types; md4\",\n \"verbose\": {\n \"md4\": \"field md4 is defined as type `date` and can only accept date or datetime\"\n }\n }\n}"},{"id":"b42ea5d3-6333-4cee-823c-9849ff55fa31","name":"fail - invalid data provided to a multilingual text field","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"X-Api-Key","value":"{{access_key_api}}","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"asset\":{\n\t\t\"org_filename\": \"CAP-540-005.jpg\",\n \"batchname\": \"CAPAPITEST\",\n \"externalid1\": \"CAP-540-005\",\n \"photographer_code\": \"GM1967\",\n \"no_publish\": 0,\n \"access_level\": 3,\n \"min_price\": 0.00,\n \"fixedprice\": 0\n\t},\n \"metadata\": {\n \t\"md1\": \"Subject (example)\",\n \t\"md2\": {\n \t\t\"en\": \"Description (example)\",\n \t\t\"fi\": \"Kuvaus (esimerkki)\"\n \t},\n \t\"md3\": {\n \"en\": \"lobster; turtle; shark; squid; octopus; dolphin\",\n \"fi\": \"hummeri; kilpikonna; hai; kalmari; mustekala; delfiini\"\n },\n \"md4\": \"2023-02-08\",\n \"md5\": {\n \"en\": \"Beijing\",\n \"fi\": \"Peking\"\n },\n \"md7\": {\n \"en\": \"China\",\n \"fi\": \"Kiina\"\n },\n \"md8\": \"Special Instructions\",\n \"md9\": \"Gavin Photographer\",\n \"md10\": \"Capture\",\n \"md25\": \"©2023 Capture Ltd\",\n \"md29\": \"China\",\n \"md30\": \"Original Source\",\n \"md36\": {\n \"en\": [\"Royalty Free\", \"Editorial images\"],\n \"fi\": [\"Rojaltivapaa\", \"Uutiskuvat\"]\n },\n \"md40\": \"7654321\",\n \"md41\": \"20230208173445\",\n \"md42\": \"20230208173445\",\n \"md44\": \"Yes\",\n \"md45\": \"CAP-540 Project\",\n \"md46\": \"20230208\",\n \"md48\": \"Subject to royalty\",\n \"md49\": \"Wired\",\n \"md51\": \"No\",\n \"md52\": \"No\",\n \"md53\": \"3 Royaltin alaiset\",\n \"md54\": 0\n },\n \"license_types\": [3],\n \"release_status\": [2],\n \"groups\": [90],\n \"country_allow\" : [70]\n}","options":{"raw":{"language":"json"}}},"url":"{{cw3_api_url}}/api/v2/admin/asset"},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 03 Mar 2020 16:30:25 GMT"},{"key":"Server","value":"Apache"},{"key":"Vary","value":"Authorization"},{"key":"Upgrade","value":"h2,h2c"},{"key":"Connection","value":"Upgrade, close"},{"key":"X-Powered-By","value":"capture API"},{"key":"Status","value":"400 Bad Request"},{"key":"Access-Control-Allow-Origin","value":""},{"key":"Content-Language","value":"en"},{"key":"Content-Length","value":"215"},{"key":"Content-Type","value":"application/json; charset=UTF-8"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 422,\n \"error\": {\n \"message\": \"unprocessable entity\",\n \"summary\": \"one or more metadata fields in the request are incorrect for the defined field data types; md1\",\n \"verbose\": {\n \"md1\": [\n \"field md1 is multilingual; missing language data for en\",\n \"field md1 is multilingual; missing language data for fi\"\n ]\n }\n }\n}"},{"id":"a3b6286a-a107-44bd-a9dd-bcd6efeccfe6","name":"fail - invalid data provided to a checkbox field","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"X-Api-Key","value":"{{access_key_api}}","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"asset\":{\n\t\t\"org_filename\": \"CAP-540-005.jpg\",\n \"batchname\": \"CAPAPITEST\",\n \"externalid1\": \"CAP-540-005\",\n \"photographer_code\": \"GM1967\",\n \"no_publish\": 0,\n \"access_level\": 3,\n \"min_price\": 0.00,\n \"fixedprice\": 0\n\t},\n \"metadata\": {\n \t\"md1\": {\n \t\t\"en\":\"Subject (example)\",\n \t\t\"fi\":\"Aihe (esimerkki)\"\n \t},\n \t\"md2\": {\n \t\t\"en\": \"Description (example)\",\n \t\t\"fi\": \"Kuvaus (esimerkki)\"\n \t},\n \t\"md3\": {\n \"en\": \"lobster; turtle; shark; squid; octopus; dolphin\",\n \"fi\": \"hummeri; kilpikonna; hai; kalmari; mustekala; delfiini\"\n },\n \"md4\": \"2023-02-08\",\n \"md5\": {\n \"en\": \"Beijing\",\n \"fi\": \"Peking\"\n },\n \"md7\": {\n \"en\": \"China\",\n \"fi\": \"Kiina\"\n },\n \"md8\": \"Special Instructions\",\n \"md9\": \"Gavin Photographer\",\n \"md10\": \"Capture\",\n \"md25\": \"©2023 Capture Ltd\",\n \"md29\": \"China\",\n \"md30\": \"Original Source\",\n \"md36\": {\n \"en\": [\"Royalty Free\", \"Editorial images\"],\n \"fi\": [\"Rojaltivapaa\", \"Uutiskuvat\"]\n },\n \"md40\": \"7654321\",\n \"md41\": \"20230208173445\",\n \"md42\": \"20230208173445\",\n \"md44\": \"Yes\",\n \"md45\": \"CAP-540 Project\",\n \"md46\": \"20230208\",\n \"md48\": \"Subject to royalty\",\n \"md49\": \"Wired\",\n \"md51\": \"No\",\n \"md52\": \"No\",\n \"md53\": \"3 Royaltin alaiset\",\n \"md54\": \"Yes\"\n },\n \"license_types\": [3],\n \"release_status\": [2],\n \"groups\": [90],\n \"country_allow\" : [70]\n}","options":{"raw":{"language":"json"}}},"url":"{{cw3_api_url}}/api/v2/admin/asset"},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 03 Mar 2020 16:30:25 GMT"},{"key":"Server","value":"Apache"},{"key":"Vary","value":"Authorization"},{"key":"Upgrade","value":"h2,h2c"},{"key":"Connection","value":"Upgrade, close"},{"key":"X-Powered-By","value":"capture API"},{"key":"Status","value":"400 Bad Request"},{"key":"Access-Control-Allow-Origin","value":""},{"key":"Content-Language","value":"en"},{"key":"Content-Length","value":"215"},{"key":"Content-Type","value":"application/json; charset=UTF-8"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 422,\n \"error\": {\n \"message\": \"unprocessable entity\",\n \"summary\": \"one or more metadata fields in the request are incorrect for the defined field data types; md54\",\n \"verbose\": {\n \"md54\": \"field md54 is defined as type `checkbox` and can only accept values of 0 or 1\"\n }\n }\n}"}],"_postman_id":"9faf3dfe-7fb2-4b01-93c6-8a6ca0d49799"},{"name":"update asset","id":"dd3e1171-92b6-4cc6-b702-a5e68ec24b6d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"value":"{{access_key_api}}","key":"There are no required sections for update, but at least one or more of the optional sections should be provided, otherwise there is no point in making the update request...
\nasset - changes to asset fields. Unlike create it is not necessary to pass org_filename for update; it is probably best not to update the org_filename field as that could have unintended consequences. The asset identifier is passed as part of the endpoint url
\nmetadata - changes to metadata fields. it is not necessary to pass all the metadata fields sent in the create - only the fields being changed. Fields that are passed will be subject to data validation.
\nlicense_types - links the asset to one or more license types
\nrelease_status - links the asset to one or more release statuses
\ngroups - places the asset inside one or more groups
\ncountry_allow - sets the list of countries an asset can be visible in
\ncountry_deny - set the list of countries as asset is restricted from
\nNote - for country restrictions, only use one of country_allow or country_deny depending on which makes most sense. Do not use both in the same request
\nExtra control attributes can be passed in the data payload. If passed they should be at the same level as asset or metadata section (i.e. not inside)
\nkey_field: - optional, only applies to PUT or PATCH requests. It defines the field name that the asset-identifier passed as the last item in the url refers to. For example, PUT or PATCH to /api/v2/admin/asset/test-file.jpg with a payload like
\n{ \n \"key_field\": \"org_filename\", \n \"asset\": { ... } \n \"metadata\": { ... } \n}\n\nIn this example key_field is stating to the API that the provided identifier test-file.jpg is the org_filename, so create (PUT) or update (PUT, PATCH) operations will only look for the asset against the org_filename field.
If the asset does not exist PUT will create it, PATCH will return error.
If the asset does exist, both PUT and PATCH will update it.
For POST, the payload must contain org_filename, and the create will return an error if an asset exists with the same name. If key_field is provided in POST, the request payload must contain that field and data to test for already existing assets.
If the key_field is omitted, the asset-identifier will be tested against the internal idasset field if it is numeric, otherwise if alphanumeric against org_filename, externalid1 and externalid2.
\npublish: - optional, only really relevant to update operations as an asset cannot be published if the actual image file has not been uploaded for the asset record. This is calling the existing smart publish which will trigger a full publish if the asset is not published, or just republish metadata if the asset is already in a published state. e.g.
\n{ \n \"publish\": true, \n \"asset\": { ... } \n}\n\nasset and metadata must be passed for create to work, refer to Create Asset V2
\notherwise sections are optional, refer to Update Asset V2
\n","urlObject":{"path":["api","v2","admin","asset","{{asset_identifier}}"],"host":["{{cw3_api_url}}"],"query":[],"variable":[]}},"response":[{"id":"7db35a90-5414-4712-91dd-9af9a1ed2b16","name":"success - create as asset did not exist","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"X-Api-Key","value":"{{access_key_api}}","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"asset\":{\n\t\t\"org_filename\": \"CAP-540-008.jpg\",\n \"batchname\": \"CAPAPITEST\",\n \"externalid1\": \"CAP-540-008\",\n \"photographer_code\": \"GM1967\",\n \"no_publish\": 0,\n \"access_level\": 3,\n \"min_price\": 0.00,\n \"fixedprice\": 0\n\t},\n \"metadata\": {\n \t\"md1\": {\n \t\t\"en\":\"Subject (example)\",\n \t\t\"fi\":\"Aihe (esimerkki)\"\n \t},\n \t\"md2\": {\n \t\t\"en\": \"Description (example)\",\n \t\t\"fi\": \"Kuvaus (esimerkki)\"\n \t},\n \t\"md3\": {\n \"en\": \"lobster; turtle; shark; squid; octopus; dolphin\",\n \"fi\": \"hummeri; kilpikonna; hai; kalmari; mustekala; delfiini\"\n },\n \"md4\": \"2023-02-08\",\n \"md5\": {\n \"en\": \"Beijing\",\n \"fi\": \"Peking\"\n },\n \"md7\": {\n \"en\": \"China\",\n \"fi\": \"Kiina\"\n },\n \"md8\": \"Special Instructions\",\n \"md9\": \"Gavin Photographer\",\n \"md10\": \"Capture\",\n \"md25\": \"©2023 Capture Ltd\",\n \"md29\": \"China\",\n \"md30\": \"Original Source\",\n \"md36\": {\n \"en\": [\"Royalty Free\", \"Editorial images\"],\n \"fi\": [\"Rojaltivapaa\", \"Uutiskuvat\"]\n },\n \"md40\": \"7654321\",\n \"md41\": \"20230208173445\",\n \"md42\": \"20230208173445\",\n \"md44\": \"Yes\",\n \"md45\": \"CAP-540 Project\",\n \"md46\": \"20230208\",\n \"md48\": \"Subject to royalty\",\n \"md49\": \"Wired\",\n \"md51\": \"No\",\n \"md52\": \"No\",\n \"md53\": \"3 Royaltin alaiset\",\n \"md54\": 0\n },\n \"license_types\": [3],\n \"release_status\": [2],\n \"groups\": [90],\n \"country_allow\" : [70]\n}","options":{"raw":{"language":"json"}}},"url":"{{cw3_api_url}}/api/v2/admin/asset/CAP-540-008"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 11 Mar 2020 13:15:22 GMT"},{"key":"Server","value":"Apache/2.4.41 (Win64) OpenSSL/1.1.1c PHP/7.3.14"},{"key":"Vary","value":"Authorization"},{"key":"Upgrade","value":"h2,h2c"},{"key":"Connection","value":"Upgrade, Keep-Alive"},{"key":"X-Powered-By","value":"capture API"},{"key":"Status","value":"204 No Content"},{"key":"Access-Control-Allow-Origin","value":""},{"key":"Content-Language","value":"en"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 201,\n \"data\": {\n \"asset_id\": 130000004,\n \"org_filename\": \"CAP-540-008.jpg\",\n \"externalid1\": \"CAP-540-008\"\n }\n}"},{"id":"c25122e6-d061-434b-9b35-ce42039eeea9","name":"success - update as asset already exists","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"X-Api-Key","value":"{{access_key_api}}","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"asset\":{\n \"batchname\": \"CAPAPITEST\",\n \"photographer_code\": \"GM1967\",\n \"no_publish\": 0,\n \"access_level\": 3,\n \"min_price\": 0.00,\n \"fixedprice\": 0\n\t},\n \"metadata\": {\n \t\"md1\": {\n \t\t\"en\":\"Subject (example)\",\n \t\t\"fi\":\"Aihe (esimerkki)\"\n \t},\n \t\"md2\": {\n \t\t\"en\": \"Description (example)\",\n \t\t\"fi\": \"Kuvaus (esimerkki)\"\n \t},\n \t\"md3\": {\n \"en\": \"lobster; turtle; shark; squid; octopus; dolphin\",\n \"fi\": \"hummeri; kilpikonna; hai; kalmari; mustekala; delfiini\"\n },\n \"md4\": \"2023-02-08\",\n \"md5\": {\n \"en\": \"Beijing\",\n \"fi\": \"Peking\"\n },\n \"md7\": {\n \"en\": \"China\",\n \"fi\": \"Kiina\"\n },\n \"md8\": \"Special Instructions\",\n \"md9\": \"Gavin Photographer\",\n \"md10\": \"Capture\",\n \"md25\": \"©2023 Capture Ltd\",\n \"md29\": \"China\",\n \"md30\": \"Original Source\",\n \"md36\": {\n \"en\": [\"Royalty Free\", \"Editorial images\"],\n \"fi\": [\"Rojaltivapaa\", \"Uutiskuvat\"]\n },\n \"md40\": \"7654321\",\n \"md41\": \"20230208173445\",\n \"md42\": \"20230208173445\",\n \"md44\": \"Yes\",\n \"md45\": \"CAP-540 Project\",\n \"md46\": \"20230208\",\n \"md48\": \"Subject to royalty\",\n \"md49\": \"Wired\",\n \"md51\": \"No\",\n \"md52\": \"No\",\n \"md53\": \"3 Royaltin alaiset\",\n \"md54\": 0\n },\n \"license_types\": [3],\n \"release_status\": [2],\n \"groups\": [90],\n \"country_allow\" : [70]\n}","options":{"raw":{"language":"json"}}},"url":"{{cw3_api_url}}/api/v2/admin/asset/CAP-540-008"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 11 Mar 2020 13:07:50 GMT"},{"key":"Server","value":"Apache/2.4.41 (Win64) OpenSSL/1.1.1c PHP/7.3.14"},{"key":"Vary","value":"Authorization"},{"key":"Upgrade","value":"h2,h2c"},{"key":"Connection","value":"Upgrade, Keep-Alive"},{"key":"X-Powered-By","value":"capture API"},{"key":"Status","value":"404 Not Found"},{"key":"Access-Control-Allow-Origin","value":""},{"key":"Content-Language","value":"en"},{"key":"Content-Length","value":"94"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Content-Type","value":"application/json; charset=UTF-8"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"data\": {\n \"asset_id\": 130000004,\n \"org_filename\": \"CAP-540-008.jpg\",\n \"externalid1\": \"CAP-540-008\",\n \"publishing\": {\n \"requested\": false,\n \"outcome\": \"not requested\",\n \"message\": \"not requested\"\n }\n }\n}"},{"id":"221f7b0f-bd7c-45e3-951b-1920594a1c2a","name":"fail - incorrect language code passed in md5","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"X-Api-Key","value":"{{access_key_api}}","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"asset\":{\n \"batchname\": \"CAPAPITEST\",\n \"photographer_code\": \"GM1967\",\n \"no_publish\": 0,\n \"access_level\": 3,\n \"min_price\": 0.00,\n \"fixedprice\": 0\n\t},\n \"metadata\": {\n \t\"md1\": {\n \t\t\"en\":\"Subject (example)\",\n \t\t\"fi\":\"Aihe (esimerkki)\"\n \t},\n \t\"md2\": {\n \t\t\"en\": \"Description (example)\",\n \t\t\"fi\": \"Kuvaus (esimerkki)\"\n \t},\n \t\"md3\": {\n \"en\": \"lobster; turtle; shark; squid; octopus; dolphin\",\n \"fi\": \"hummeri; kilpikonna; hai; kalmari; mustekala; delfiini\"\n },\n \"md4\": \"2023-02-08\",\n \"md5\": {\n \"en\": \"Beijing\",\n \"gd\": \"Peking\"\n },\n \"md7\": {\n \"en\": \"China\",\n \"fi\": \"Kiina\"\n },\n \"md8\": \"Special Instructions\",\n \"md9\": \"Gavin Photographer\",\n \"md10\": \"Capture\",\n \"md25\": \"©2023 Capture Ltd\",\n \"md29\": \"China\",\n \"md30\": \"Original Source\",\n \"md36\": {\n \"en\": [\"Royalty Free\", \"Editorial images\"],\n \"fi\": [\"Rojaltivapaa\", \"Uutiskuvat\"]\n },\n \"md40\": \"7654321\",\n \"md41\": \"20230208173445\",\n \"md42\": \"20230208173445\",\n \"md44\": \"Yes\",\n \"md45\": \"CAP-540 Project\",\n \"md46\": \"20230208\",\n \"md48\": \"Subject to royalty\",\n \"md49\": \"Wired\",\n \"md51\": \"No\",\n \"md52\": \"No\",\n \"md53\": \"3 Royaltin alaiset\",\n \"md54\": 0\n },\n \"license_types\": [3],\n \"release_status\": [2],\n \"groups\": [90],\n \"country_allow\" : [70]\n}","options":{"raw":{"language":"json"}}},"url":"{{cw3_api_url}}/api/v2/admin/asset/CAP-540-008.jpg"},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 11 Mar 2020 13:07:50 GMT"},{"key":"Server","value":"Apache/2.4.41 (Win64) OpenSSL/1.1.1c PHP/7.3.14"},{"key":"Vary","value":"Authorization"},{"key":"Upgrade","value":"h2,h2c"},{"key":"Connection","value":"Upgrade, Keep-Alive"},{"key":"X-Powered-By","value":"capture API"},{"key":"Status","value":"404 Not Found"},{"key":"Access-Control-Allow-Origin","value":""},{"key":"Content-Language","value":"en"},{"key":"Content-Length","value":"94"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Content-Type","value":"application/json; charset=UTF-8"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 422,\n \"error\": {\n \"message\": \"unprocessable entity\",\n \"summary\": \"one or more metadata fields in the request are incorrect for the defined field data types; md5\",\n \"verbose\": {\n \"md5\": [\n \"field md5 is multilingual; missing language data for fi\"\n ]\n }\n }\n}"}],"_postman_id":"7487a238-96ac-4ba0-b067-5294d732cb08"}],"id":"bd7c2298-61c1-431d-ad26-7c4566e7ac02","description":"This section describes the revised create and update methods that improve on the useability and performance of the previous methods.
\nThe V2 calls are implemented behind a new url route, which takes the form
\n\n\nsiteurl/api/v2/admin/asset
\n
to provide separation from the original method while allowing both old and new methods to coexist.
\nThe new v2 methods are smarter in how the operate;
\nprevious v1 functionality
\nnew v2 functionality
\nThe use of HTTP methods applies to determine create only, update only, create or update functionality, following REST conventions, e.g.
\nCRUD operations are part of the admin API so require a user account to have admin rights, or a non-expiring API token.
All requests to the admin API must be accompanied by a valid access token.
The preferred way to pass this token is in a custom http header;
\n\n\nX-Api-Key: token
\n
The use of the custom http header is necessary for sites that make use of SSO (Single Sign On) for front end authentication, as the authentication service is handled by a 3rd party (AWS Cognito). X-Api-Key forces the API to use its own internal authentication to validate the token.
\nNon-SSO sites can still pass the token in the Authorization: Bearer header, but it is advisable to use the custom header for future proofing.
\nPassing the access_token as a query string parameter is still supported for backward compatibility, but is strongly discouraged. It is not secure (token is easily visible), and it is likely the Capture API will eventually stop accepting the token from the query string.
\nPOST <site url>/api/v2/admin/asset
\nCreate only
\nPATCH <site url>/api/v2/admin/asset/asset-identifier
\nUpdate only
\nPUT <site url>/api/v2/admin/asset/asset-identifier
\nCreate if not exist, update if exists
\noptional: id of the contact
\n","type":"text/plain"},"key":"contact_id","value":"21"}],"variable":[]}},"response":[],"_postman_id":"1b280ec5-0b16-4a4d-a523-86add8f56e29"},{"name":"check price with license","id":"89af189f-d172-4c3e-838c-52e656602acd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"value":"{{access_key_api}}","key":"Base64 Encoded JSON string containing a \"license_id\" property and an optional \"license_options\" array
\n","type":"text/plain"},"key":"license_b64","value":"eyJsaWNlbnNlX2lkIjo3fQ=="},{"disabled":true,"description":{"content":"optional: if contact_id is set, this is the ID of the licensee
\n","type":"text/plain"},"key":"licensee_id","value":"42"},{"disabled":true,"description":{"content":"optional: if contact_id is set, use digital delivery for the contact? (1 = true, 0 = false)
\n","type":"text/plain"},"key":"digital_delivery","value":"1"},{"key":"asset_id","value":"{{asset_id}}"},{"key":"contact_id","value":"{{contact_id}}"}],"variable":[]}},"response":[],"_postman_id":"89af189f-d172-4c3e-838c-52e656602acd"},{"name":"get basket","id":"76283fb4-4b42-499c-bd8e-3e0343d3c32f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"value":"{{access_key_api}}","key":"Returns Current API Version
\nUse Case This should be used to check that the API you are connecting meets your minimum requirements. You should check this periodically and not with every request for performance reasons. We suggest that you check when at the start of a session as it is unlikly to change during an active session.
\n","urlObject":{"protocol":"https","path":["api","version"],"host":["YOUR-CAPTURE-DOMAIN"],"query":[],"variable":[]}},"response":[{"id":"7c73cf7a-9ae3-4436-ab93-8fb9f294bb95","name":"Example Version Response","originalRequest":{"method":"GET","header":[],"url":"https://YOUR-CAPTURE-DOMAIN/api/version"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Origin","value":"","name":"Access-Control-Allow-Origin","description":"Specifies a URI that may access the resource. For requests without credentials, the server may specify '*' as a wildcard, thereby allowing any origin to access the resource."},{"key":"Connection","value":"Upgrade, Keep-Alive","name":"Connection","description":"Options that are desired for the connection"},{"key":"Content-Encoding","value":"gzip","name":"Content-Encoding","description":"The type of encoding used on the data."},{"key":"Content-Language","value":"en","name":"Content-Language","description":"The language the content is in"},{"key":"Content-Length","value":"106","name":"Content-Length","description":"The length of the response body in octets (8-bit bytes)"},{"key":"Content-Type","value":"application/json; charset=UTF-8","name":"Content-Type","description":"The mime type of this content"},{"key":"Date","value":"Wed, 02 May 2018 12:00:11 GMT","name":"Date","description":"The date and time that the message was sent"},{"key":"Keep-Alive","value":"timeout=5, max=100","name":"Keep-Alive","description":"Custom header"},{"key":"Server","value":"Apache","name":"Server","description":"A name for the server"},{"key":"Upgrade","value":"h2,h2c","name":"Upgrade","description":"Custom header"},{"key":"Vary","value":"Accept-Encoding","name":"Vary","description":"Tells downstream proxies how to match future request headers to decide whether the cached response can be used rather than requesting a fresh one from the origin server."},{"key":"X-Powered-By","value":"capture API","name":"X-Powered-By","description":"Specifies the technology (ASP.NET, PHP, JBoss, e.g.) supporting the web application (version details are often in X-Runtime, X-Version, or X-AspNet-Version)"}],"cookie":[],"responseTime":null,"body":"{\r\n \"status\":200,\r\n \"data\":{\r\n \"site\":\"Demo\",\r\n \"version\":\"3.1.57.0\",\r\n \"copyright\":\"© 2018-2023 Capture Ltd\"\r\n }\r\n}"}],"_postman_id":"e8aa0150-3c33-4287-b46d-ae5f2c3d67bb"}],"id":"03aa0687-a52c-4405-bd84-c5ef696b6bfd","description":"The endpoints in this section do not require authorisation to access, and do not fall under a sepecific area of the system, they are mostly utiulity tools.
\n","event":[{"listen":"prerequest","script":{"id":"1e2f55a0-5b53-468d-a5d3-33f6c007049d","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"f7204386-bad1-4388-a6ac-ccece2143c80","type":"text/javascript","exec":[""]}}],"_postman_id":"03aa0687-a52c-4405-bd84-c5ef696b6bfd"},{"name":"Authentication","item":[{"name":"Request Access Token","event":[{"listen":"prerequest","script":{"id":"0cd490ff-98a4-47ed-96c4-b60247afc6f9","exec":[""],"type":"text/javascript","packages":{},"requests":{}}},{"listen":"test","script":{"id":"c4550b1a-a579-49f4-9465-9b5fe0824cb9","exec":[""],"type":"text/javascript","packages":{},"requests":{}}}],"id":"1a184ca4-5b44-4112-9c8b-793e29f0b94d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"grant_type","value":"password","type":"text"},{"key":"client_id","value":"{{client_id}}","type":"text"},{"key":"client_secret","value":"{{client_secret}}","type":"text"},{"key":"email","value":"{{email}}","type":"text"},{"key":"password","value":"{{password}}","type":"text"}]},"url":"https://YOUR-CAPTURE-DOMAIN/api/oauth/access_token","description":"Registered users should authenticate and obtain an access token in order to be identified by the API and allowed access to certain features and content.
\nThis is done by making an http POST request to the above url (remembering to substitute YOUR-CAPTURE-DOMAIN for your site domain), passing an x-www-form-urlencoded payload which must contain the parameters shown below.
\nemail and password should be the credentials of the user attempting to authenticate.
\nclient_id and client_secret can initially be set to test, but if regular API access is desired contact Capture to create a non-test set.
\ngrant_type must be password
\nThe response on success will provide an access_token which should be stored by the client to be sent in the Authorization: Bearer token header in subsequent calls to any available endpoint.
\n","urlObject":{"protocol":"https","path":["api","oauth","access_token"],"host":["YOUR-CAPTURE-DOMAIN"],"query":[],"variable":[]}},"response":[{"id":"3ab2ab0e-e8d2-4301-911a-64d8cac011af","name":"Success","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"grant_type","value":"password","type":"text"},{"key":"client_id","value":"test","type":"text"},{"key":"client_secret","value":"test","type":"text"},{"key":"email","value":"john.doe@capture.co.uk","type":"text"},{"key":"password","value":"password1234","type":"text"}]},"url":"https://YOUR-CAPTURE-DOMAIN/api/oauth/access_token"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Origin","value":"","description":"Specifies a URI that may access the resource. For requests without credentials, the server may specify '*' as a wildcard, thereby allowing any origin to access the resource."},{"key":"Connection","value":"Upgrade, Keep-Alive","description":"Options that are desired for the connection"},{"key":"Content-Encoding","value":"gzip","description":"The type of encoding used on the data."},{"key":"Content-Language","value":"en","description":"The language the content is in"},{"key":"Content-Length","value":"252","description":"The length of the response body in octets (8-bit bytes)"},{"key":"Content-Type","value":"application/json; charset=UTF-8","description":"The mime type of this content"},{"key":"Date","value":"Wed, 02 May 2018 13:24:14 GMT","description":"The date and time that the message was sent"},{"key":"Keep-Alive","value":"timeout=5, max=100","description":"Custom header"},{"key":"Server","value":"Apache","description":"A name for the server"},{"key":"Upgrade","value":"h2,h2c","description":"Custom header"},{"key":"Vary","value":"Accept-Encoding","description":"Tells downstream proxies how to match future request headers to decide whether the cached response can be used rather than requesting a fresh one from the origin server."},{"key":"X-Powered-By","value":"capture API","description":"Specifies the technology (ASP.NET, PHP, JBoss, e.g.) supporting the web application (version details are often in X-Runtime, X-Version, or X-AspNet-Version)"}],"cookie":[],"responseTime":null,"body":"{\r\n \"status\":200,\r\n \"access_token\":\"KRWgz37vTsrBVKCzzMa4pqxLsmhR3eHS0Dks2VPv\",\r\n \"token_type\":\"Bearer\",\r\n \"expires_in\":3600,\r\n \"refresh_token\":\"Y1jGWibbXTDhxXKbdScnUU6pUO8Y2dMb7bc1Pot3\",\r\n \"data\":{\r\n \"oauth\":{\r\n \"access_token\":\"KRWgz37vTsrBVKCzzMa4pqxLsmhR3eHS0Dks2VPv\",\r\n \"token_type\":\"Bearer\",\r\n \"expires_in\":3600,\r\n \"refresh_token\":\"Y1jGWibbXTDhxXKbdScnUU6pUO8Y2dMb7bc1Pot3\"\r\n },\r\n \"user\":{\r\n \"contact_id\":101,\r\n \"userId\":101,\r\n \"idcontacts\":101,\r\n \"fname\":\"John\",\r\n \"lname\":\"Doe\",\r\n \"email\":\"john.doe@capture.co.uk\"\r\n }\r\n }\r\n}"},{"id":"7aef3313-b3a1-4b4a-b049-d66c0e67e57a","name":"Failed","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"grant_type","value":"password","type":"text"},{"key":"client_id","value":"test","type":"text"},{"key":"client_secret","value":"test","type":"text"},{"key":"email","value":"{{email}}","type":"text"},{"key":"password","value":"{{password}}","type":"text"}]},"url":"https://YOUR-CAPTURE-DOMAIN/api/oauth/access_token"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Origin","value":"","description":"Specifies a URI that may access the resource. For requests without credentials, the server may specify '*' as a wildcard, thereby allowing any origin to access the resource."},{"key":"Connection","value":"Upgrade, Keep-Alive","description":"Options that are desired for the connection"},{"key":"Content-Language","value":"en","description":"The language the content is in"},{"key":"Content-Type","value":"application/json; charset=UTF-8","description":"The mime type of this content"},{"key":"Date","value":"Wed, 02 May 2018 15:06:16 GMT","description":"The date and time that the message was sent"},{"key":"Keep-Alive","value":"timeout=5, max=100","description":"Custom header"},{"key":"Server","value":"Apache","description":"A name for the server"},{"key":"Transfer-Encoding","value":"chunked","description":"The form of encoding used to safely transfer the entity to the user. Currently defined methods are: chunked, compress, deflate, gzip, identity."},{"key":"Upgrade","value":"h2,h2c","description":"Custom header"},{"key":"X-Powered-By","value":"capture API","description":"Specifies the technology (ASP.NET, PHP, JBoss, e.g.) supporting the web application (version details are often in X-Runtime, X-Version, or X-AspNet-Version)"}],"cookie":[],"responseTime":null,"body":"{\r\n \"status\":401,\r\n \"error\":{\r\n \"message\":\"unauthorized\",\r\n \"summary\":\"user credentials are invalid\",\r\n \"verbose\": [\r\n \"invalid credentials for email `john.doe@capture.co.uk`\"\r\n ]\r\n }\r\n}"}],"_postman_id":"1a184ca4-5b44-4112-9c8b-793e29f0b94d"},{"name":"Ping / Extend Access Token","event":[{"listen":"prerequest","script":{"id":"021e5735-eb55-47ec-b39b-a82ecccde116","exec":[""],"type":"text/javascript","packages":{},"requests":{}}},{"listen":"test","script":{"id":"8c5f8c88-f335-44b1-ad73-582b1c2c4fff","exec":[""],"type":"text/javascript","packages":{},"requests":{}}}],"id":"8d5caf96-901d-4cd5-9ac7-d38b24339372","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{vault:authorization-secret}}"},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://YOUR-CAPTURE-DOMAIN/api/oauth/ping","description":"While a user is logged in, sending regular ping requests will keep their access token alive, by a maximum of 20 minutes. By default a new access token is 60 mins to expiry, ping will keep the token 'alive'.
\nKeep alive will only work while an access token is still valid. If it expires due to inactivity the uer will have to authenticate again.
\nA successful ping request will return http 204 No Content, there will be no response data
\n","urlObject":{"protocol":"https","path":["api","oauth","ping"],"host":["YOUR-CAPTURE-DOMAIN"],"query":[],"variable":[]}},"response":[{"id":"f673b085-12bb-493e-b41b-fa48320bb087","name":"Oauth Ping Token","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"Shows the current basic user information for a given access token
\n","urlObject":{"protocol":"https","path":["api","oauth","whoami"],"host":["YOUR-CAPTURE-DOMAIN"],"query":[],"variable":[]}},"response":[{"id":"63a54cb7-87cd-4f80-a1fd-2e4c7e11459c","name":"Who Am I ","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"{{vault:bearer-token}}","type":"text"}],"url":"https://YOUR-CAPTURE-DOMAIN/api/oauth/whoami"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Origin","value":"","description":"Specifies a URI that may access the resource. For requests without credentials, the server may specify '*' as a wildcard, thereby allowing any origin to access the resource."},{"key":"Connection","value":"Keep-Alive","description":"Options that are desired for the connection"},{"key":"Content-Encoding","value":"gzip","description":"The type of encoding used on the data."},{"key":"Content-Language","value":"en","description":"The language the content is in"},{"key":"Content-Length","value":"177","description":"The length of the response body in octets (8-bit bytes)"},{"key":"Content-Type","value":"application/json; charset=UTF-8","description":"The mime type of this content"},{"key":"Date","value":"Wed, 02 May 2018 15:39:36 GMT","description":"The date and time that the message was sent"},{"key":"Keep-Alive","value":"timeout=5, max=99","description":"Custom header"},{"key":"Server","value":"Apache","description":"A name for the server"},{"key":"Vary","value":"Accept-Encoding","description":"Tells downstream proxies how to match future request headers to decide whether the cached response can be used rather than requesting a fresh one from the origin server."},{"key":"X-Powered-By","value":"capture API","description":"Specifies the technology (ASP.NET, PHP, JBoss, e.g.) supporting the web application (version details are often in X-Runtime, X-Version, or X-AspNet-Version)"}],"cookie":[],"responseTime":null,"body":"{\r\n \"status\":200,\r\n \"data\":{\r\n \"accessToken\":\"LV0FoHfsgrZnnE3yAku8grlFm6OZfNcZJl8h1oiG\",\r\n \"type\":\"user\",\r\n \"user\":{\r\n \"userId\":55,\r\n \"firstName\":\"John\",\r\n \"lastName\":\"Doe\",\r\n \"email\":\"john.doe@capture.co.uk\"\r\n }\r\n }\r\n}"},{"id":"d2095253-649c-4469-9402-f6c6cfc87f45","name":"Failed","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"The Capture API uses OAuth2 as an authentication and authorisation method. An initial request is made passing a username/password combination of a registered user in order to be given an access token.
\nSubsequent requests to the API must then include the access token to identify the user making the requests and allow rights to use certain features. The token should be sent in the Authorization: Bearer token http header.
\nTrusted partners can be granted extended lifetime tokens to be used in conjunction with whitelisted IP addresses. Please contact Capture for further details.
\n","event":[{"listen":"prerequest","script":{"id":"03bbaa51-44b3-476a-aec2-971bfe49b242","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"eb5f8961-d40c-4bf3-9b2e-5b496a83d914","type":"text/javascript","exec":[""]}}],"_postman_id":"9c88b08e-80d3-46e3-9456-a126598e8bce"},{"name":"Contacts (Users) ","item":[{"name":"Country list","event":[{"listen":"test","script":{"id":"00a9bba8-e0b7-4697-8440-8316c32d497e","exec":[""],"type":"text/javascript"}}],"id":"ad5591b5-498d-4173-9008-b54f8938170c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://YOUR-CAPTURE-DOMAIN/api/contact/country","description":"Response: List of countries
\nUse:: Used to provide a list of countries that will be accepted by a registration POST request
\n","urlObject":{"protocol":"https","path":["api","contact","country"],"host":["YOUR-CAPTURE-DOMAIN"],"query":[],"variable":[]}},"response":[{"id":"4d9d68cf-0042-4e9a-87ba-9a37b23bc13d","name":"Success","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://YOUR-CAPTURE-DOMAIN/api/contact/country"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Origin","value":"","name":"Access-Control-Allow-Origin","description":"Specifies a URI that may access the resource. For requests without credentials, the server may specify '*' as a wildcard, thereby allowing any origin to access the resource."},{"key":"Connection","value":"Upgrade, Keep-Alive","name":"Connection","description":"Options that are desired for the connection"},{"key":"Content-Encoding","value":"gzip","name":"Content-Encoding","description":"The type of encoding used on the data."},{"key":"Content-Language","value":"en","name":"Content-Language","description":"The language the content is in"},{"key":"Content-Length","value":"4315","name":"Content-Length","description":"The length of the response body in octets (8-bit bytes)"},{"key":"Content-Type","value":"application/json; charset=UTF-8","name":"Content-Type","description":"The mime type of this content"},{"key":"Date","value":"Thu, 03 May 2018 12:48:01 GMT","name":"Date","description":"The date and time that the message was sent"},{"key":"Keep-Alive","value":"timeout=5, max=100","name":"Keep-Alive","description":"Custom header"},{"key":"Server","value":"Apache","name":"Server","description":"A name for the server"},{"key":"Upgrade","value":"h2,h2c","name":"Upgrade","description":"Custom header"},{"key":"Vary","value":"Accept-Encoding","name":"Vary","description":"Tells downstream proxies how to match future request headers to decide whether the cached response can be used rather than requesting a fresh one from the origin server."},{"key":"X-Powered-By","value":"capture API","name":"X-Powered-By","description":"Specifies the technology (ASP.NET, PHP, JBoss, e.g.) supporting the web application (version details are often in X-Runtime, X-Version, or X-AspNet-Version)"}],"cookie":[],"responseTime":null,"body":"{\r\n \"status\": 200,\r\n \"data\": {\r\n \"countryList\": [\r\n {\r\n \"idcountry\": 70,\r\n \"name\": \"Finland\",\r\n \"twolettercode\": \"FI\",\r\n \"threelettercode\": \"FIN\",\r\n \"postcode_pattern\": null\r\n },\r\n {\r\n \"idcountry\": 223,\r\n \"name\": \"United States\",\r\n \"twolettercode\": \"US\",\r\n \"threelettercode\": \"USA\",\r\n \"postcode_pattern\": null\r\n },\r\n {\r\n \"idcountry\": 222,\r\n \"name\": \"United Kingdom\",\r\n \"twolettercode\": \"GB\",\r\n \"threelettercode\": \"GBR\",\r\n \"postcode_pattern\": \"/^[A-Z]{1,2}[0-9][0-9A-Z]? [0-9][A-Z]{2}$/\"\r\n },\r\n {\r\n \"idcountry\": 1,\r\n \"name\": \"Afghanistan\",\r\n \"twolettercode\": \"AF\",\r\n \"threelettercode\": \"AFG\",\r\n \"postcode_pattern\": null\r\n },\r\n {\r\n \"idcountry\": 2,\r\n \"name\": \"Albania\",\r\n \"twolettercode\": \"AL\",\r\n \"threelettercode\": \"ALB\",\r\n \"postcode_pattern\": null\r\n },\r\n {\r\n \"idcountry\": 3,\r\n \"name\": \"Algeria\",\r\n \"twolettercode\": \"DZ\",\r\n \"threelettercode\": \"DZA\",\r\n \"postcode_pattern\": null\r\n },\r\n {\r\n \"idcountry\": 4,\r\n \"name\": \"American Samoa\",\r\n \"twolettercode\": \"AS\",\r\n \"threelettercode\": \"ASM\",\r\n \"postcode_pattern\": null\r\n },\r\n {\r\n \"idcountry\": 5,\r\n \"name\": \"Andorra\",\r\n \"twolettercode\": \"AD\",\r\n \"threelettercode\": \"AND\",\r\n \"postcode_pattern\": null\r\n },\r\n {\r\n \"idcountry\": 6,\r\n \"name\": \"Angola\",\r\n \"twolettercode\": \"AO\",\r\n \"threelettercode\": \"AGO\",\r\n \"postcode_pattern\": null\r\n },\r\n {\r\n \"idcountry\": 7,\r\n \"name\": \"Anguilla\",\r\n \"twolettercode\": \"AI\",\r\n \"threelettercode\": \"AIA\",\r\n \"postcode_pattern\": null\r\n },\r\n {\r\n \"idcountry\": 8,\r\n \"name\": \"Antarctica\",\r\n \"twolettercode\": \"AQ\",\r\n \"threelettercode\": \"ATA\",\r\n \"postcode_pattern\": null\r\n },\r\n {\r\n \"idcountry\": 9,\r\n \"name\": \"Antigua and Barbuda\",\r\n \"twolettercode\": \"AG\",\r\n \"threelettercode\": \"ATG\",\r\n \"postcode_pattern\": null\r\n },\r\n {\r\n \"idcountry\": 10,\r\n \"name\": \"Argentina\",\r\n \"twolettercode\": \"AR\",\r\n \"threelettercode\": \"ARG\",\r\n \"postcode_pattern\": null\r\n },\r\n {\r\n \"idcountry\": 11,\r\n \"name\": \"Armenia\",\r\n \"twolettercode\": \"AM\",\r\n \"threelettercode\": \"ARM\",\r\n \"postcode_pattern\": null\r\n },\r\n {\r\n \"idcountry\": 12,\r\n \"name\": \"Aruba\",\r\n \"twolettercode\": \"AW\",\r\n \"threelettercode\": \"ABW\",\r\n \"postcode_pattern\": null\r\n },\r\n {\r\n \"idcountry\": 13,\r\n \"name\": \"Australia\",\r\n \"twolettercode\": \"AU\",\r\n \"threelettercode\": \"AUS\",\r\n \"postcode_pattern\": null\r\n },\r\n {\r\n \"idcountry\": 14,\r\n \"name\": \"Austria\",\r\n \"twolettercode\": \"AT\",\r\n \"threelettercode\": \"AUT\",\r\n \"postcode_pattern\": null\r\n },\r\n {\r\n \"idcountry\": 15,\r\n \"name\": \"Azerbaijan\",\r\n \"twolettercode\": \"AZ\",\r\n \"threelettercode\": \"AZE\",\r\n \"postcode_pattern\": null\r\n },\r\n {\r\n \"idcountry\": 16,\r\n \"name\": \"Bahamas\",\r\n \"twolettercode\": \"BS\",\r\n \"threelettercode\": \"BHS\",\r\n \"postcode_pattern\": null\r\n },\r\n {\r\n \"idcountry\": 17,\r\n \"name\": \"Bahrain\",\r\n \"twolettercode\": \"BH\",\r\n \"threelettercode\": \"BHR\",\r\n \"postcode_pattern\": null\r\n },\r\n {\r\n \"idcountry\": 18,\r\n \"name\": \"Bangladesh\",\r\n \"twolettercode\": \"BD\",\r\n \"threelettercode\": \"BGD\",\r\n \"postcode_pattern\": null\r\n },\r\n {\r\n \"idcountry\": 19,\r\n \"name\": \"Barbados\",\r\n \"twolettercode\": \"BB\",\r\n \"threelettercode\": \"BRB\",\r\n \"postcode_pattern\": null\r\n },\r\n {\r\n \"idcountry\": 20,\r\n \"name\": \"Belarus\",\r\n \"twolettercode\": \"BY\",\r\n \"threelettercode\": \"BLR\",\r\n \"postcode_pattern\": null\r\n },\r\n {\r\n \"idcountry\": 21,\r\n \"name\": \"Belgium\",\r\n \"twolettercode\": \"BE\",\r\n \"threelettercode\": \"BEL\",\r\n \"postcode_pattern\": null\r\n },\r\n {\r\n \"idcountry\": 22,\r\n \"name\": \"Belize\",\r\n \"twolettercode\": \"BZ\",\r\n \"threelettercode\": \"BLZ\",\r\n \"postcode_pattern\": null\r\n },\r\n {\r\n \"idcountry\": 23,\r\n \"name\": \"Benin\",\r\n \"twolettercode\": \"BJ\",\r\n \"threelettercode\": \"BEN\",\r\n \"postcode_pattern\": null\r\n },\r\n {\r\n \"idcountry\": 24,\r\n \"name\": \"Bermuda\",\r\n \"twolettercode\": \"BM\",\r\n \"threelettercode\": \"BMU\",\r\n \"postcode_pattern\": null\r\n },\r\n {\r\n \"idcountry\": 25,\r\n \"name\": \"Bhutan\",\r\n \"twolettercode\": \"BT\",\r\n \"threelettercode\": \"BTN\",\r\n \"postcode_pattern\": null\r\n },\r\n {\r\n \"idcountry\": 26,\r\n \"name\": \"Bolivia\",\r\n \"twolettercode\": \"BO\",\r\n \"threelettercode\": \"BOL\",\r\n \"postcode_pattern\": null\r\n },\r\n {\r\n \"idcountry\": 27,\r\n \"name\": \"Bosnia and Herzegowina\",\r\n \"twolettercode\": \"BA\",\r\n \"threelettercode\": \"BIH\",\r\n \"postcode_pattern\": null\r\n },\r\n {\r\n \"idcountry\": 28,\r\n \"name\": \"Botswana\",\r\n \"twolettercode\": \"BW\",\r\n \"threelettercode\": \"BWA\",\r\n \"postcode_pattern\": null\r\n },\r\n {\r\n \"idcountry\": 29,\r\n \"name\": \"Bouvet Island\",\r\n \"twolettercode\": \"BV\",\r\n \"threelettercode\": \"BVT\",\r\n \"postcode_pattern\": null\r\n },\r\n {\r\n \"idcountry\": 30,\r\n \"name\": \"Brazil\",\r\n \"twolettercode\": \"BR\",\r\n \"threelettercode\": \"BRA\",\r\n \"postcode_pattern\": null\r\n },\r\n {\r\n \"idcountry\": 31,\r\n \"name\": \"British Indian Ocean Territory\",\r\n \"twolettercode\": \"IO\",\r\n \"threelettercode\": \"IOT\",\r\n \"postcode_pattern\": null\r\n },\r\n {\r\n \"idcountry\": 32,\r\n \"name\": \"Brunei Darussalam\",\r\n \"twolettercode\": \"BN\",\r\n \"threelettercode\": \"BRN\",\r\n \"postcode_pattern\": null\r\n },\r\n {\r\n \"idcountry\": 33,\r\n \"name\": \"Bulgaria\",\r\n \"twolettercode\": \"BG\",\r\n \"threelettercode\": \"BGR\",\r\n \"postcode_pattern\": null\r\n },\r\n {\r\n \"idcountry\": 34,\r\n \"name\": \"Burkina Faso\",\r\n \"twolettercode\": \"BF\",\r\n \"threelettercode\": \"BFA\",\r\n \"postcode_pattern\": null\r\n },\r\n {\r\n \"idcountry\": 35,\r\n \"name\": \"Burundi\",\r\n \"twolettercode\": \"BI\",\r\n \"threelettercode\": \"BDI\",\r\n \"postcode_pattern\": null\r\n },\r\n {\r\n \"idcountry\": 36,\r\n \"name\": \"Cambodia\",\r\n \"twolettercode\": \"KH\",\r\n \"threelettercode\": \"KHM\",\r\n \"postcode_pattern\": null\r\n },\r\n {\r\n \"idcountry\": 37,\r\n \"name\": \"Cameroon\",\r\n \"twolettercode\": \"CM\",\r\n \"threelettercode\": \"CMR\",\r\n \"postcode_pattern\": null\r\n },\r\n {\r\n \"idcountry\": 38,\r\n \"name\": \"Canada\",\r\n \"twolettercode\": \"CA\",\r\n \"threelettercode\": \"CAN\",\r\n \"postcode_pattern\": null\r\n },\r\n {\r\n \"idcountry\": 39,\r\n \"name\": \"Cape Verde\",\r\n \"twolettercode\": \"CV\",\r\n \"threelettercode\": \"CPV\",\r\n \"postcode_pattern\": null\r\n },\r\n {\r\n \"idcountry\": 40,\r\n \"name\": \"Cayman Islands\",\r\n \"twolettercode\": \"KY\",\r\n \"threelettercode\": \"CYM\",\r\n \"postcode_pattern\": null\r\n },\r\n {\r\n \"idcountry\": 41,\r\n \"name\": \"Central African Republic\",\r\n \"twolettercode\": \"CF\",\r\n \"threelettercode\": \"CAF\",\r\n \"postcode_pattern\": null\r\n },\r\n {\r\n \"idcountry\": 42,\r\n \"name\": \"Chad\",\r\n \"twolettercode\": \"TD\",\r\n \"threelettercode\": \"TCD\",\r\n \"postcode_pattern\": null\r\n },\r\n {\r\n \"idcountry\": 43,\r\n \"name\": \"Chile\",\r\n \"twolettercode\": \"CL\",\r\n \"threelettercode\": \"CHL\",\r\n \"postcode_pattern\": null\r\n },\r\n {\r\n \"idcountry\": 44,\r\n \"name\": \"China\",\r\n \"twolettercode\": \"CN\",\r\n \"threelettercode\": \"CHN\",\r\n \"postcode_pattern\": null\r\n },\r\n {\r\n \"idcountry\": 45,\r\n \"name\": \"Christmas Island\",\r\n \"twolettercode\": \"CX\",\r\n \"threelettercode\": \"CXR\",\r\n \"postcode_pattern\": null\r\n },\r\n {\r\n \"idcountry\": 46,\r\n \"name\": \"Cocos (Keeling) Islands\",\r\n \"twolettercode\": \"CC\",\r\n \"threelettercode\": \"CCK\",\r\n \"postcode_pattern\": null\r\n },\r\n {\r\n \"idcountry\": 47,\r\n \"name\": \"Colombia\",\r\n \"twolettercode\": \"CO\",\r\n \"threelettercode\": \"COL\",\r\n \"postcode_pattern\": null\r\n },\r\n {\r\n \"idcountry\": 48,\r\n \"name\": \"Comoros\",\r\n \"twolettercode\": \"KM\",\r\n \"threelettercode\": \"COM\",\r\n \"postcode_pattern\": null\r\n },\r\n {\r\n \"idcountry\": 49,\r\n \"name\": \"Congo\",\r\n \"twolettercode\": \"CG\",\r\n \"threelettercode\": \"COG\",\r\n \"postcode_pattern\": null\r\n },\r\n {\r\n \"idcountry\": 50,\r\n \"name\": \"Congo, the Democratic Republic of the\",\r\n \"twolettercode\": \"CD\",\r\n \"threelettercode\": \"COD\",\r\n \"postcode_pattern\": null\r\n },\r\n {\r\n \"idcountry\": 51,\r\n \"name\": \"Cook Islands\",\r\n \"twolettercode\": \"CK\",\r\n \"threelettercode\": \"COK\",\r\n \"postcode_pattern\": null\r\n },\r\n {\r\n \"idcountry\": 52,\r\n \"name\": \"Costa Rica\",\r\n \"twolettercode\": \"CR\",\r\n \"threelettercode\": \"CRI\",\r\n \"postcode_pattern\": null\r\n },\r\n {\r\n \"idcountry\": 53,\r\n \"name\": \"Cote d'Ivoire\",\r\n \"twolettercode\": \"CI\",\r\n \"threelettercode\": \"CIV\",\r\n \"postcode_pattern\": null\r\n },\r\n {\r\n \"idcountry\": 54,\r\n \"name\": \"Croatia (local name: Hrvatska)\",\r\n \"twolettercode\": \"HR\",\r\n \"threelettercode\": \"HRV\",\r\n \"postcode_pattern\": null\r\n },\r\n {\r\n \"idcountry\": 55,\r\n \"name\": \"Cuba\",\r\n \"twolettercode\": \"CU\",\r\n \"threelettercode\": \"CUB\",\r\n \"postcode_pattern\": null\r\n },\r\n {\r\n \"idcountry\": 56,\r\n \"name\": \"Cyprus\",\r\n \"twolettercode\": \"CY\",\r\n \"threelettercode\": \"CYP\",\r\n \"postcode_pattern\": null\r\n },\r\n {\r\n \"idcountry\": 57,\r\n \"name\": \"Czech Republic\",\r\n \"twolettercode\": \"CZ\",\r\n \"threelettercode\": \"CZE\",\r\n \"postcode_pattern\": null\r\n },\r\n {\r\n \"idcountry\": 58,\r\n \"name\": \"Denmark\",\r\n \"twolettercode\": \"DK\",\r\n \"threelettercode\": \"DNK\",\r\n \"postcode_pattern\": null\r\n },\r\n {\r\n \"idcountry\": 59,\r\n \"name\": \"Djibouti\",\r\n \"twolettercode\": \"DJ\",\r\n \"threelettercode\": \"DJI\",\r\n \"postcode_pattern\": null\r\n },\r\n {\r\n \"idcountry\": 60,\r\n \"name\": \"Dominica\",\r\n \"twolettercode\": \"DM\",\r\n \"threelettercode\": \"DMA\",\r\n \"postcode_pattern\": null\r\n },\r\n {\r\n \"idcountry\": 61,\r\n \"name\": \"Dominican Republic\",\r\n \"twolettercode\": \"DO\",\r\n \"threelettercode\": \"DOM\",\r\n \"postcode_pattern\": null\r\n },\r\n {\r\n \"idcountry\": 62,\r\n \"name\": \"East Timor\",\r\n \"twolettercode\": \"TP\",\r\n \"threelettercode\": \"TMP\",\r\n \"postcode_pattern\": null\r\n },\r\n {\r\n \"idcountry\": 63,\r\n \"name\": \"Ecuador\",\r\n \"twolettercode\": \"EC\",\r\n \"threelettercode\": \"ECU\",\r\n \"postcode_pattern\": null\r\n },\r\n {\r\n \"idcountry\": 64,\r\n \"name\": \"Egypt\",\r\n \"twolettercode\": \"EG\",\r\n \"threelettercode\": \"EGY\",\r\n \"postcode_pattern\": null\r\n },\r\n {\r\n \"idcountry\": 65,\r\n \"name\": \"El Salvador\",\r\n \"twolettercode\": \"SV\",\r\n \"threelettercode\": \"SLV\",\r\n \"postcode_pattern\": null\r\n },\r\n {\r\n \"idcountry\": 66,\r\n \"name\": \"Estonia\",\r\n \"twolettercode\": \"EE\",\r\n \"threelettercode\": \"EST\",\r\n \"postcode_pattern\": null\r\n },\r\n {\r\n \"idcountry\": 67,\r\n \"name\": \"Falkland Islands (Malvinas)\",\r\n \"twolettercode\": \"FK\",\r\n \"threelettercode\": \"FLK\",\r\n \"postcode_pattern\": null\r\n },\r\n {\r\n \"idcountry\": 68,\r\n \"name\": \"Faroe Islands\",\r\n \"twolettercode\": \"FO\",\r\n \"threelettercode\": \"FRO\",\r\n \"postcode_pattern\": null\r\n },\r\n {\r\n \"idcountry\": 69,\r\n \"name\": \"Fiji\",\r\n \"twolettercode\": \"FJ\",\r\n \"threelettercode\": \"FJI\",\r\n \"postcode_pattern\": null\r\n },\r\n {\r\n \"idcountry\": 71,\r\n \"name\": \"France\",\r\n \"twolettercode\": \"FR\",\r\n \"threelettercode\": \"FRA\",\r\n \"postcode_pattern\": null\r\n },\r\n {\r\n \"idcountry\": 72,\r\n \"name\": \"France, Metropolitan\",\r\n \"twolettercode\": \"FX\",\r\n \"threelettercode\": \"FXX\",\r\n \"postcode_pattern\": null\r\n },\r\n {\r\n \"idcountry\": 73,\r\n \"name\": \"French Guiana\",\r\n \"twolettercode\": \"GF\",\r\n \"threelettercode\": \"GUF\",\r\n \"postcode_pattern\": null\r\n },\r\n {\r\n \"idcountry\": 74,\r\n \"name\": \"French Polynesia\",\r\n \"twolettercode\": \"PF\",\r\n \"threelettercode\": \"PYF\",\r\n \"postcode_pattern\": null\r\n },\r\n {\r\n \"idcountry\": 75,\r\n \"name\": \"French Southern Territories\",\r\n \"twolettercode\": \"TF\",\r\n \"threelettercode\": \"ATF\",\r\n \"postcode_pattern\": null\r\n },\r\n {\r\n \"idcountry\": 76,\r\n \"name\": \"Gabon\",\r\n \"twolettercode\": \"GA\",\r\n \"threelettercode\": \"GAB\",\r\n \"postcode_pattern\": null\r\n },\r\n {\r\n \"idcountry\": 77,\r\n \"name\": \"Gambia\",\r\n \"twolettercode\": \"GM\",\r\n \"threelettercode\": \"GMB\",\r\n \"postcode_pattern\": null\r\n },\r\n {\r\n \"idcountry\": 78,\r\n \"name\": \"Georgia\",\r\n \"twolettercode\": \"GE\",\r\n \"threelettercode\": \"GEO\",\r\n \"postcode_pattern\": null\r\n },\r\n {\r\n \"idcountry\": 79,\r\n \"name\": \"Germany\",\r\n \"twolettercode\": \"DE\",\r\n \"threelettercode\": \"DEU\",\r\n \"postcode_pattern\": null\r\n },\r\n {\r\n \"idcountry\": 80,\r\n \"name\": \"Ghana\",\r\n \"twolettercode\": \"GH\",\r\n \"threelettercode\": \"GHA\",\r\n \"postcode_pattern\": null\r\n },\r\n {\r\n \"idcountry\": 81,\r\n \"name\": \"Gibraltar\",\r\n \"twolettercode\": \"GI\",\r\n \"threelettercode\": \"GIB\",\r\n \"postcode_pattern\": null\r\n },\r\n {\r\n \"idcountry\": 82,\r\n \"name\": \"Greece\",\r\n \"twolettercode\": \"GR\",\r\n \"threelettercode\": \"GRC\",\r\n \"postcode_pattern\": null\r\n },\r\n {\r\n \"idcountry\": 83,\r\n \"name\": \"Greenland\",\r\n \"twolettercode\": \"GL\",\r\n \"threelettercode\": \"GRL\",\r\n \"postcode_pattern\": null\r\n },\r\n {\r\n \"idcountry\": 84,\r\n \"name\": \"Grenada\",\r\n \"twolettercode\": \"GD\",\r\n \"threelettercode\": \"GRD\",\r\n \"postcode_pattern\": null\r\n },\r\n {\r\n \"idcountry\": 85,\r\n \"name\": \"Guadeloupe\",\r\n \"twolettercode\": \"GP\",\r\n \"threelettercode\": \"GLP\",\r\n \"postcode_pattern\": null\r\n },\r\n {\r\n \"idcountry\": 86,\r\n \"name\": \"Guam\",\r\n \"twolettercode\": \"GU\",\r\n \"threelettercode\": \"GUM\",\r\n \"postcode_pattern\": null\r\n },\r\n {\r\n \"idcountry\": 87,\r\n \"name\": \"Guatemala\",\r\n \"twolettercode\": \"GT\",\r\n \"threelettercode\": \"GTM\",\r\n \"postcode_pattern\": null\r\n },\r\n {\r\n \"idcountry\": 88,\r\n \"name\": \"Guinea\",\r\n \"twolettercode\": \"GN\",\r\n \"threelettercode\": \"GIN\",\r\n \"postcode_pattern\": null\r\n },\r\n {\r\n \"idcountry\": 89,\r\n \"name\": \"Guinea-Bissau\",\r\n \"twolettercode\": \"GW\",\r\n \"threelettercode\": \"GNB\",\r\n \"postcode_pattern\": null\r\n },\r\n {\r\n \"idcountry\": 90,\r\n \"name\": \"Guyana\",\r\n \"twolettercode\": \"GY\",\r\n \"threelettercode\": \"GUY\",\r\n \"postcode_pattern\": null\r\n },\r\n {\r\n \"idcountry\": 91,\r\n \"name\": \"Haiti\",\r\n \"twolettercode\": \"HT\",\r\n \"threelettercode\": \"HTI\",\r\n \"postcode_pattern\": null\r\n },\r\n {\r\n \"idcountry\": 92,\r\n \"name\": \"Heard and Mc Donald Islands\",\r\n \"twolettercode\": \"HM\",\r\n \"threelettercode\": \"HMD\",\r\n \"postcode_pattern\": null\r\n },\r\n {\r\n \"idcountry\": 93,\r\n \"name\": \"Holy see (Vatican City State)\",\r\n \"twolettercode\": \"VA\",\r\n \"threelettercode\": \"VAT\",\r\n \"postcode_pattern\": null\r\n },\r\n {\r\n \"idcountry\": 94,\r\n \"name\": \"Honduras\",\r\n \"twolettercode\": \"HN\",\r\n \"threelettercode\": \"HND\",\r\n \"postcode_pattern\": null\r\n },\r\n {\r\n \"idcountry\": 95,\r\n \"name\": \"Hong Kong\",\r\n \"twolettercode\": \"HK\",\r\n \"threelettercode\": \"HKG\",\r\n \"postcode_pattern\": null\r\n },\r\n {\r\n \"idcountry\": 96,\r\n \"name\": \"Hungary\",\r\n \"twolettercode\": \"HU\",\r\n \"threelettercode\": \"HUN\",\r\n \"postcode_pattern\": null\r\n },\r\n {\r\n \"idcountry\": 97,\r\n \"name\": \"Iceland\",\r\n \"twolettercode\": \"IS\",\r\n \"threelettercode\": \"ISL\",\r\n \"postcode_pattern\": null\r\n },\r\n {\r\n \"idcountry\": 98,\r\n \"name\": \"India\",\r\n \"twolettercode\": \"IN\",\r\n \"threelettercode\": \"IND\",\r\n \"postcode_pattern\": null\r\n },\r\n {\r\n \"idcountry\": 99,\r\n \"name\": \"Indonesia\",\r\n \"twolettercode\": \"ID\",\r\n \"threelettercode\": \"IDN\",\r\n \"postcode_pattern\": null\r\n },\r\n {\r\n \"idcountry\": 100,\r\n \"name\": \"Iran (Islamic Republic of)\",\r\n \"twolettercode\": \"IR\",\r\n \"threelettercode\": \"IRN\",\r\n \"postcode_pattern\": null\r\n },\r\n {\r\n \"idcountry\": 101,\r\n \"name\": \"Iraq\",\r\n \"twolettercode\": \"IQ\",\r\n \"threelettercode\": \"IRQ\",\r\n \"postcode_pattern\": null\r\n },\r\n {\r\n \"idcountry\": 102,\r\n \"name\": \"Ireland\",\r\n \"twolettercode\": \"IE\",\r\n \"threelettercode\": \"IRL\",\r\n \"postcode_pattern\": null\r\n },\r\n {\r\n \"idcountry\": 103,\r\n \"name\": \"Israel\",\r\n \"twolettercode\": \"IL\",\r\n \"threelettercode\": \"ISR\",\r\n \"postcode_pattern\": null\r\n },\r\n {\r\n \"idcountry\": 104,\r\n \"name\": \"Italy\",\r\n \"twolettercode\": \"IT\",\r\n \"threelettercode\": \"ITA\",\r\n \"postcode_pattern\": null\r\n },\r\n {\r\n \"idcountry\": 105,\r\n \"name\": \"Jamaica\",\r\n \"twolettercode\": \"JM\",\r\n \"threelettercode\": \"JAM\",\r\n \"postcode_pattern\": null\r\n },\r\n {\r\n \"idcountry\": 106,\r\n \"name\": \"Japan\",\r\n \"twolettercode\": \"JP\",\r\n \"threelettercode\": \"JPN\",\r\n \"postcode_pattern\": null\r\n },\r\n {\r\n \"idcountry\": 107,\r\n \"name\": \"Jordan\",\r\n \"twolettercode\": \"JO\",\r\n \"threelettercode\": \"JOR\",\r\n \"postcode_pattern\": null\r\n },\r\n {\r\n \"idcountry\": 108,\r\n \"name\": \"Kazakhstan\",\r\n \"twolettercode\": \"KZ\",\r\n \"threelettercode\": \"KAZ\",\r\n \"postcode_pattern\": null\r\n },\r\n {\r\n \"idcountry\": 109,\r\n \"name\": \"Kenya\",\r\n \"twolettercode\": \"KE\",\r\n \"threelettercode\": \"KEN\",\r\n \"postcode_pattern\": null\r\n },\r\n {\r\n \"idcountry\": 110,\r\n \"name\": \"Kiribati\",\r\n \"twolettercode\": \"KI\",\r\n \"threelettercode\": \"KIR\",\r\n \"postcode_pattern\": null\r\n },\r\n {\r\n \"idcountry\": 111,\r\n \"name\": \"Korea, Democratic People's Republic of\",\r\n \"twolettercode\": \"KP\",\r\n \"threelettercode\": \"PRK\",\r\n \"postcode_pattern\": null\r\n },\r\n {\r\n \"idcountry\": 112,\r\n \"name\": \"Korea, Republic of\",\r\n \"twolettercode\": \"KR\",\r\n \"threelettercode\": \"KOR\",\r\n \"postcode_pattern\": null\r\n },\r\n {\r\n \"idcountry\": 113,\r\n \"name\": \"Kuwait\",\r\n \"twolettercode\": \"KW\",\r\n \"threelettercode\": \"KWT\",\r\n \"postcode_pattern\": null\r\n },\r\n {\r\n \"idcountry\": 114,\r\n \"name\": \"Kyrgyzstan\",\r\n \"twolettercode\": \"KG\",\r\n \"threelettercode\": \"KGZ\",\r\n \"postcode_pattern\": null\r\n },\r\n {\r\n \"idcountry\": 115,\r\n \"name\": \"Lao People's Democratic Republic\",\r\n \"twolettercode\": \"LA\",\r\n \"threelettercode\": \"LAO\",\r\n \"postcode_pattern\": null\r\n },\r\n {\r\n \"idcountry\": 116,\r\n \"name\": \"Latvia\",\r\n \"twolettercode\": \"LV\",\r\n \"threelettercode\": \"LVA\",\r\n \"postcode_pattern\": null\r\n },\r\n {\r\n \"idcountry\": 117,\r\n \"name\": \"Lebanon\",\r\n \"twolettercode\": \"LB\",\r\n \"threelettercode\": \"LBN\",\r\n \"postcode_pattern\": null\r\n },\r\n {\r\n \"idcountry\": 118,\r\n \"name\": \"Lesotho\",\r\n \"twolettercode\": \"LS\",\r\n \"threelettercode\": \"LSO\",\r\n \"postcode_pattern\": null\r\n },\r\n {\r\n \"idcountry\": 119,\r\n \"name\": \"Liberia\",\r\n \"twolettercode\": \"LR\",\r\n \"threelettercode\": \"LBR\",\r\n \"postcode_pattern\": null\r\n },\r\n {\r\n \"idcountry\": 120,\r\n \"name\": \"Libyan Arab Jamahiriya\",\r\n \"twolettercode\": \"LY\",\r\n \"threelettercode\": \"LBY\",\r\n \"postcode_pattern\": null\r\n },\r\n {\r\n \"idcountry\": 121,\r\n \"name\": \"Liechtenstein\",\r\n \"twolettercode\": \"LI\",\r\n \"threelettercode\": \"LIE\",\r\n \"postcode_pattern\": null\r\n },\r\n {\r\n \"idcountry\": 122,\r\n \"name\": \"Lithuania\",\r\n \"twolettercode\": \"LT\",\r\n \"threelettercode\": \"LTU\",\r\n \"postcode_pattern\": null\r\n },\r\n {\r\n \"idcountry\": 123,\r\n \"name\": \"Luxembourg\",\r\n \"twolettercode\": \"LU\",\r\n \"threelettercode\": \"LUX\",\r\n \"postcode_pattern\": null\r\n },\r\n {\r\n \"idcountry\": 124,\r\n \"name\": \"Macau\",\r\n \"twolettercode\": \"MO\",\r\n \"threelettercode\": \"MAC\",\r\n \"postcode_pattern\": null\r\n },\r\n {\r\n \"idcountry\": 125,\r\n \"name\": \"Macedonia, the former Yugoslav Republic of\",\r\n \"twolettercode\": \"MK\",\r\n \"threelettercode\": \"MKD\",\r\n \"postcode_pattern\": null\r\n },\r\n {\r\n \"idcountry\": 126,\r\n \"name\": \"Madagascar\",\r\n \"twolettercode\": \"MG\",\r\n \"threelettercode\": \"MDG\",\r\n \"postcode_pattern\": null\r\n },\r\n {\r\n \"idcountry\": 127,\r\n \"name\": \"Malawi\",\r\n \"twolettercode\": \"MW\",\r\n \"threelettercode\": \"MWI\",\r\n \"postcode_pattern\": null\r\n },\r\n {\r\n \"idcountry\": 128,\r\n \"name\": \"Malaysia\",\r\n \"twolettercode\": \"MY\",\r\n \"threelettercode\": \"MYS\",\r\n \"postcode_pattern\": null\r\n },\r\n {\r\n \"idcountry\": 129,\r\n \"name\": \"Maldives\",\r\n \"twolettercode\": \"MV\",\r\n \"threelettercode\": \"MDV\",\r\n \"postcode_pattern\": null\r\n },\r\n {\r\n \"idcountry\": 130,\r\n \"name\": \"Mali\",\r\n \"twolettercode\": \"ML\",\r\n \"threelettercode\": \"MLI\",\r\n \"postcode_pattern\": null\r\n },\r\n {\r\n \"idcountry\": 131,\r\n \"name\": \"Malta\",\r\n \"twolettercode\": \"MT\",\r\n \"threelettercode\": \"MLT\",\r\n \"postcode_pattern\": null\r\n },\r\n {\r\n \"idcountry\": 132,\r\n \"name\": \"Marshall Islands\",\r\n \"twolettercode\": \"MH\",\r\n \"threelettercode\": \"MHL\",\r\n \"postcode_pattern\": null\r\n },\r\n {\r\n \"idcountry\": 133,\r\n \"name\": \"Martinique\",\r\n \"twolettercode\": \"MQ\",\r\n \"threelettercode\": \"MTQ\",\r\n \"postcode_pattern\": null\r\n },\r\n {\r\n \"idcountry\": 134,\r\n \"name\": \"Mauritania\",\r\n \"twolettercode\": \"MR\",\r\n \"threelettercode\": \"MRT\",\r\n \"postcode_pattern\": null\r\n },\r\n {\r\n \"idcountry\": 135,\r\n \"name\": \"Mauritius\",\r\n \"twolettercode\": \"MU\",\r\n \"threelettercode\": \"MUS\",\r\n \"postcode_pattern\": null\r\n },\r\n {\r\n \"idcountry\": 136,\r\n \"name\": \"Mayotte\",\r\n \"twolettercode\": \"YT\",\r\n \"threelettercode\": \"MYT\",\r\n \"postcode_pattern\": null\r\n },\r\n {\r\n \"idcountry\": 137,\r\n \"name\": \"Mexico\",\r\n \"twolettercode\": \"MX\",\r\n \"threelettercode\": \"MEX\",\r\n \"postcode_pattern\": null\r\n },\r\n {\r\n \"idcountry\": 138,\r\n \"name\": \"Micronesia, Federated States of\",\r\n \"twolettercode\": \"FM\",\r\n \"threelettercode\": \"FSM\",\r\n \"postcode_pattern\": null\r\n },\r\n {\r\n \"idcountry\": 139,\r\n \"name\": \"Moldova, Republic of\",\r\n \"twolettercode\": \"MD\",\r\n \"threelettercode\": \"MDA\",\r\n \"postcode_pattern\": null\r\n },\r\n {\r\n \"idcountry\": 140,\r\n \"name\": \"Monaco\",\r\n \"twolettercode\": \"MC\",\r\n \"threelettercode\": \"MCO\",\r\n \"postcode_pattern\": null\r\n },\r\n {\r\n \"idcountry\": 141,\r\n \"name\": \"Mongolia\",\r\n \"twolettercode\": \"MN\",\r\n \"threelettercode\": \"MNG\",\r\n \"postcode_pattern\": null\r\n },\r\n {\r\n \"idcountry\": 142,\r\n \"name\": \"Montserrat\",\r\n \"twolettercode\": \"MS\",\r\n \"threelettercode\": \"MSR\",\r\n \"postcode_pattern\": null\r\n },\r\n {\r\n \"idcountry\": 143,\r\n \"name\": \"Morocco\",\r\n \"twolettercode\": \"MA\",\r\n \"threelettercode\": \"MAR\",\r\n \"postcode_pattern\": null\r\n },\r\n {\r\n \"idcountry\": 144,\r\n \"name\": \"Mozambique\",\r\n \"twolettercode\": \"MZ\",\r\n \"threelettercode\": \"MOZ\",\r\n \"postcode_pattern\": null\r\n },\r\n {\r\n \"idcountry\": 145,\r\n \"name\": \"Myanmar\",\r\n \"twolettercode\": \"MM\",\r\n \"threelettercode\": \"MMR\",\r\n \"postcode_pattern\": null\r\n },\r\n {\r\n \"idcountry\": 146,\r\n \"name\": \"Namibia\",\r\n \"twolettercode\": \"NA\",\r\n \"threelettercode\": \"NAM\",\r\n \"postcode_pattern\": null\r\n },\r\n {\r\n \"idcountry\": 147,\r\n \"name\": \"Nauru\",\r\n \"twolettercode\": \"NR\",\r\n \"threelettercode\": \"NRU\",\r\n \"postcode_pattern\": null\r\n },\r\n {\r\n \"idcountry\": 148,\r\n \"name\": \"Nepal\",\r\n \"twolettercode\": \"NP\",\r\n \"threelettercode\": \"NPL\",\r\n \"postcode_pattern\": null\r\n },\r\n {\r\n \"idcountry\": 149,\r\n \"name\": \"Netherlands\",\r\n \"twolettercode\": \"NL\",\r\n \"threelettercode\": \"NLD\",\r\n \"postcode_pattern\": null\r\n },\r\n {\r\n \"idcountry\": 150,\r\n \"name\": \"Netherlands Antilles\",\r\n \"twolettercode\": \"AN\",\r\n \"threelettercode\": \"ANT\",\r\n \"postcode_pattern\": null\r\n },\r\n {\r\n \"idcountry\": 151,\r\n \"name\": \"New Caledonia\",\r\n \"twolettercode\": \"NC\",\r\n \"threelettercode\": \"NCL\",\r\n \"postcode_pattern\": null\r\n },\r\n {\r\n \"idcountry\": 152,\r\n \"name\": \"New Zealand\",\r\n \"twolettercode\": \"NZ\",\r\n \"threelettercode\": \"NZL\",\r\n \"postcode_pattern\": null\r\n },\r\n {\r\n \"idcountry\": 153,\r\n \"name\": \"Nicaragua\",\r\n \"twolettercode\": \"NI\",\r\n \"threelettercode\": \"NIC\",\r\n \"postcode_pattern\": null\r\n },\r\n {\r\n \"idcountry\": 154,\r\n \"name\": \"Niger\",\r\n \"twolettercode\": \"NE\",\r\n \"threelettercode\": \"NER\",\r\n \"postcode_pattern\": null\r\n },\r\n {\r\n \"idcountry\": 155,\r\n \"name\": \"Nigeria\",\r\n \"twolettercode\": \"NG\",\r\n \"threelettercode\": \"NGA\",\r\n \"postcode_pattern\": null\r\n },\r\n {\r\n \"idcountry\": 156,\r\n \"name\": \"Niue\",\r\n \"twolettercode\": \"NU\",\r\n \"threelettercode\": \"NIU\",\r\n \"postcode_pattern\": null\r\n },\r\n {\r\n \"idcountry\": 157,\r\n \"name\": \"Norfolk Island\",\r\n \"twolettercode\": \"NF\",\r\n \"threelettercode\": \"NFK\",\r\n \"postcode_pattern\": null\r\n },\r\n {\r\n \"idcountry\": 158,\r\n \"name\": \"Northern Mariana Islands\",\r\n \"twolettercode\": \"MP\",\r\n \"threelettercode\": \"MNP\",\r\n \"postcode_pattern\": null\r\n },\r\n {\r\n \"idcountry\": 159,\r\n \"name\": \"Norway\",\r\n \"twolettercode\": \"NO\",\r\n \"threelettercode\": \"NOR\",\r\n \"postcode_pattern\": null\r\n },\r\n {\r\n \"idcountry\": 160,\r\n \"name\": \"Oman\",\r\n \"twolettercode\": \"OM\",\r\n \"threelettercode\": \"OMN\",\r\n \"postcode_pattern\": null\r\n },\r\n {\r\n \"idcountry\": 161,\r\n \"name\": \"Pakistan\",\r\n \"twolettercode\": \"PK\",\r\n \"threelettercode\": \"PAK\",\r\n \"postcode_pattern\": null\r\n },\r\n {\r\n \"idcountry\": 162,\r\n \"name\": \"Palau\",\r\n \"twolettercode\": \"PW\",\r\n \"threelettercode\": \"PLW\",\r\n \"postcode_pattern\": null\r\n },\r\n {\r\n \"idcountry\": 163,\r\n \"name\": \"Palestinian Territory, occupied\",\r\n \"twolettercode\": \"PS\",\r\n \"threelettercode\": \"PSE\",\r\n \"postcode_pattern\": null\r\n },\r\n {\r\n \"idcountry\": 164,\r\n \"name\": \"Panama\",\r\n \"twolettercode\": \"PA\",\r\n \"threelettercode\": \"PAN\",\r\n \"postcode_pattern\": null\r\n },\r\n {\r\n \"idcountry\": 165,\r\n \"name\": \"Papua New Guinea\",\r\n \"twolettercode\": \"PG\",\r\n \"threelettercode\": \"PNG\",\r\n \"postcode_pattern\": null\r\n },\r\n {\r\n \"idcountry\": 166,\r\n \"name\": \"Paraguay\",\r\n \"twolettercode\": \"PY\",\r\n \"threelettercode\": \"PRY\",\r\n \"postcode_pattern\": null\r\n },\r\n {\r\n \"idcountry\": 167,\r\n \"name\": \"Peru\",\r\n \"twolettercode\": \"PE\",\r\n \"threelettercode\": \"PER\",\r\n \"postcode_pattern\": null\r\n },\r\n {\r\n \"idcountry\": 168,\r\n \"name\": \"Philippines\",\r\n \"twolettercode\": \"PH\",\r\n \"threelettercode\": \"PHL\",\r\n \"postcode_pattern\": null\r\n },\r\n {\r\n \"idcountry\": 169,\r\n \"name\": \"Pitcairn\",\r\n \"twolettercode\": \"PN\",\r\n \"threelettercode\": \"PCN\",\r\n \"postcode_pattern\": null\r\n },\r\n {\r\n \"idcountry\": 170,\r\n \"name\": \"Poland\",\r\n \"twolettercode\": \"PL\",\r\n \"threelettercode\": \"POL\",\r\n \"postcode_pattern\": null\r\n },\r\n {\r\n \"idcountry\": 171,\r\n \"name\": \"Portugal\",\r\n \"twolettercode\": \"PT\",\r\n \"threelettercode\": \"PRT\",\r\n \"postcode_pattern\": null\r\n },\r\n {\r\n \"idcountry\": 172,\r\n \"name\": \"Puerto Rico\",\r\n \"twolettercode\": \"PR\",\r\n \"threelettercode\": \"PRI\",\r\n \"postcode_pattern\": null\r\n },\r\n {\r\n \"idcountry\": 173,\r\n \"name\": \"Qatar\",\r\n \"twolettercode\": \"QA\",\r\n \"threelettercode\": \"QAT\",\r\n \"postcode_pattern\": null\r\n },\r\n {\r\n \"idcountry\": 174,\r\n \"name\": \"Reunion\",\r\n \"twolettercode\": \"RE\",\r\n \"threelettercode\": \"REU\",\r\n \"postcode_pattern\": null\r\n },\r\n {\r\n \"idcountry\": 175,\r\n \"name\": \"Romania\",\r\n \"twolettercode\": \"RO\",\r\n \"threelettercode\": \"ROM\",\r\n \"postcode_pattern\": null\r\n },\r\n {\r\n \"idcountry\": 176,\r\n \"name\": \"Russian Federation\",\r\n \"twolettercode\": \"RU\",\r\n \"threelettercode\": \"RUS\",\r\n \"postcode_pattern\": null\r\n },\r\n {\r\n \"idcountry\": 177,\r\n \"name\": \"Rwanda\",\r\n \"twolettercode\": \"RW\",\r\n \"threelettercode\": \"RWA\",\r\n \"postcode_pattern\": null\r\n },\r\n {\r\n \"idcountry\": 178,\r\n \"name\": \"Saint Kitts and Nevis\",\r\n \"twolettercode\": \"KN\",\r\n \"threelettercode\": \"KNA\",\r\n \"postcode_pattern\": null\r\n },\r\n {\r\n \"idcountry\": 179,\r\n \"name\": \"Saint Lucia\",\r\n \"twolettercode\": \"LC\",\r\n \"threelettercode\": \"LCA\",\r\n \"postcode_pattern\": null\r\n },\r\n {\r\n \"idcountry\": 180,\r\n \"name\": \"Saint Vincent and the Grenadines\",\r\n \"twolettercode\": \"VC\",\r\n \"threelettercode\": \"VCT\",\r\n \"postcode_pattern\": null\r\n },\r\n {\r\n \"idcountry\": 181,\r\n \"name\": \"Samoa\",\r\n \"twolettercode\": \"WS\",\r\n \"threelettercode\": \"WSM\",\r\n \"postcode_pattern\": null\r\n },\r\n {\r\n \"idcountry\": 182,\r\n \"name\": \"San Marino\",\r\n \"twolettercode\": \"SM\",\r\n \"threelettercode\": \"SMR\",\r\n \"postcode_pattern\": null\r\n },\r\n {\r\n \"idcountry\": 183,\r\n \"name\": \"Sao Tome and Principe\",\r\n \"twolettercode\": \"ST\",\r\n \"threelettercode\": \"STP\",\r\n \"postcode_pattern\": null\r\n },\r\n {\r\n \"idcountry\": 184,\r\n \"name\": \"Saudi Arabia\",\r\n \"twolettercode\": \"SA\",\r\n \"threelettercode\": \"SAU\",\r\n \"postcode_pattern\": null\r\n },\r\n {\r\n \"idcountry\": 185,\r\n \"name\": \"Senegal\",\r\n \"twolettercode\": \"SN\",\r\n \"threelettercode\": \"SEN\",\r\n \"postcode_pattern\": null\r\n },\r\n {\r\n \"idcountry\": 186,\r\n \"name\": \"Seychelles\",\r\n \"twolettercode\": \"SC\",\r\n \"threelettercode\": \"SYC\",\r\n \"postcode_pattern\": null\r\n },\r\n {\r\n \"idcountry\": 187,\r\n \"name\": \"Sierra Leone\",\r\n \"twolettercode\": \"SL\",\r\n \"threelettercode\": \"SLE\",\r\n \"postcode_pattern\": null\r\n },\r\n {\r\n \"idcountry\": 188,\r\n \"name\": \"Singapore\",\r\n \"twolettercode\": \"SG\",\r\n \"threelettercode\": \"SGP\",\r\n \"postcode_pattern\": null\r\n },\r\n {\r\n \"idcountry\": 189,\r\n \"name\": \"Slovakia (Slovak Republic)\",\r\n \"twolettercode\": \"SK\",\r\n \"threelettercode\": \"SVK\",\r\n \"postcode_pattern\": null\r\n },\r\n {\r\n \"idcountry\": 190,\r\n \"name\": \"Slovenia\",\r\n \"twolettercode\": \"SI\",\r\n \"threelettercode\": \"SVN\",\r\n \"postcode_pattern\": null\r\n },\r\n {\r\n \"idcountry\": 191,\r\n \"name\": \"Solomon Islands\",\r\n \"twolettercode\": \"SB\",\r\n \"threelettercode\": \"SLB\",\r\n \"postcode_pattern\": null\r\n },\r\n {\r\n \"idcountry\": 192,\r\n \"name\": \"Somalia\",\r\n \"twolettercode\": \"SO\",\r\n \"threelettercode\": \"SOM\",\r\n \"postcode_pattern\": null\r\n },\r\n {\r\n \"idcountry\": 193,\r\n \"name\": \"South Africa\",\r\n \"twolettercode\": \"ZA\",\r\n \"threelettercode\": \"ZAF\",\r\n \"postcode_pattern\": null\r\n },\r\n {\r\n \"idcountry\": 194,\r\n \"name\": \"South Georgia and the South Sandwich Islands\",\r\n \"twolettercode\": \"GS\",\r\n \"threelettercode\": \"SGS\",\r\n \"postcode_pattern\": null\r\n },\r\n {\r\n \"idcountry\": 195,\r\n \"name\": \"Spain\",\r\n \"twolettercode\": \"ES\",\r\n \"threelettercode\": \"ESP\",\r\n \"postcode_pattern\": null\r\n },\r\n {\r\n \"idcountry\": 196,\r\n \"name\": \"Sri Lanka\",\r\n \"twolettercode\": \"LK\",\r\n \"threelettercode\": \"LKA\",\r\n \"postcode_pattern\": null\r\n },\r\n {\r\n \"idcountry\": 197,\r\n \"name\": \"St. Helena\",\r\n \"twolettercode\": \"SH\",\r\n \"threelettercode\": \"SHN\",\r\n \"postcode_pattern\": null\r\n },\r\n {\r\n \"idcountry\": 198,\r\n \"name\": \"St. Pierre and Miquelon\",\r\n \"twolettercode\": \"PM\",\r\n \"threelettercode\": \"SPM\",\r\n \"postcode_pattern\": null\r\n },\r\n {\r\n \"idcountry\": 199,\r\n \"name\": \"Sudan\",\r\n \"twolettercode\": \"SD\",\r\n \"threelettercode\": \"SDN\",\r\n \"postcode_pattern\": null\r\n },\r\n {\r\n \"idcountry\": 200,\r\n \"name\": \"Suriname\",\r\n \"twolettercode\": \"SR\",\r\n \"threelettercode\": \"SUR\",\r\n \"postcode_pattern\": null\r\n },\r\n {\r\n \"idcountry\": 201,\r\n \"name\": \"Svalbard and Jan Mayen Islands\",\r\n \"twolettercode\": \"SJ\",\r\n \"threelettercode\": \"SJM\",\r\n \"postcode_pattern\": null\r\n },\r\n {\r\n \"idcountry\": 202,\r\n \"name\": \"Swaziland\",\r\n \"twolettercode\": \"SZ\",\r\n \"threelettercode\": \"SWZ\",\r\n \"postcode_pattern\": null\r\n },\r\n {\r\n \"idcountry\": 203,\r\n \"name\": \"Sweden\",\r\n \"twolettercode\": \"SE\",\r\n \"threelettercode\": \"SWE\",\r\n \"postcode_pattern\": null\r\n },\r\n {\r\n \"idcountry\": 204,\r\n \"name\": \"Switzerland\",\r\n \"twolettercode\": \"CH\",\r\n \"threelettercode\": \"CHE\",\r\n \"postcode_pattern\": null\r\n },\r\n {\r\n \"idcountry\": 205,\r\n \"name\": \"Syrian Arab Republic\",\r\n \"twolettercode\": \"SY\",\r\n \"threelettercode\": \"SYR\",\r\n \"postcode_pattern\": null\r\n },\r\n {\r\n \"idcountry\": 206,\r\n \"name\": \"Taiwan, Republic of China\",\r\n \"twolettercode\": \"TW\",\r\n \"threelettercode\": \"TWN\",\r\n \"postcode_pattern\": null\r\n },\r\n {\r\n \"idcountry\": 207,\r\n \"name\": \"Tajikistan\",\r\n \"twolettercode\": \"TJ\",\r\n \"threelettercode\": \"TJK\",\r\n \"postcode_pattern\": null\r\n },\r\n {\r\n \"idcountry\": 208,\r\n \"name\": \"Tanzania, United Republic of\",\r\n \"twolettercode\": \"TZ\",\r\n \"threelettercode\": \"TZA\",\r\n \"postcode_pattern\": null\r\n },\r\n {\r\n \"idcountry\": 209,\r\n \"name\": \"Thailand\",\r\n \"twolettercode\": \"TH\",\r\n \"threelettercode\": \"THA\",\r\n \"postcode_pattern\": null\r\n },\r\n {\r\n \"idcountry\": 210,\r\n \"name\": \"Togo\",\r\n \"twolettercode\": \"TG\",\r\n \"threelettercode\": \"TGO\",\r\n \"postcode_pattern\": null\r\n },\r\n {\r\n \"idcountry\": 211,\r\n \"name\": \"Tokelau\",\r\n \"twolettercode\": \"TK\",\r\n \"threelettercode\": \"TKL\",\r\n \"postcode_pattern\": null\r\n },\r\n {\r\n \"idcountry\": 212,\r\n \"name\": \"Tonga\",\r\n \"twolettercode\": \"TO\",\r\n \"threelettercode\": \"TON\",\r\n \"postcode_pattern\": null\r\n },\r\n {\r\n \"idcountry\": 213,\r\n \"name\": \"Trinidad and Tobago\",\r\n \"twolettercode\": \"TT\",\r\n \"threelettercode\": \"TTO\",\r\n \"postcode_pattern\": null\r\n },\r\n {\r\n \"idcountry\": 214,\r\n \"name\": \"Tunisia\",\r\n \"twolettercode\": \"TN\",\r\n \"threelettercode\": \"TUN\",\r\n \"postcode_pattern\": null\r\n },\r\n {\r\n \"idcountry\": 215,\r\n \"name\": \"Turkey\",\r\n \"twolettercode\": \"TR\",\r\n \"threelettercode\": \"TUR\",\r\n \"postcode_pattern\": null\r\n },\r\n {\r\n \"idcountry\": 216,\r\n \"name\": \"Turkmenistan\",\r\n \"twolettercode\": \"TM\",\r\n \"threelettercode\": \"TKM\",\r\n \"postcode_pattern\": null\r\n },\r\n {\r\n \"idcountry\": 217,\r\n \"name\": \"Turks and Caicos Islands\",\r\n \"twolettercode\": \"TC\",\r\n \"threelettercode\": \"TCA\",\r\n \"postcode_pattern\": null\r\n },\r\n {\r\n \"idcountry\": 218,\r\n \"name\": \"Tuvalu\",\r\n \"twolettercode\": \"TV\",\r\n \"threelettercode\": \"TUV\",\r\n \"postcode_pattern\": null\r\n },\r\n {\r\n \"idcountry\": 219,\r\n \"name\": \"Uganda\",\r\n \"twolettercode\": \"UG\",\r\n \"threelettercode\": \"UGA\",\r\n \"postcode_pattern\": null\r\n },\r\n {\r\n \"idcountry\": 220,\r\n \"name\": \"Ukraine\",\r\n \"twolettercode\": \"UA\",\r\n \"threelettercode\": \"UKR\",\r\n \"postcode_pattern\": null\r\n },\r\n {\r\n \"idcountry\": 221,\r\n \"name\": \"United Arab Emirates\",\r\n \"twolettercode\": \"AE\",\r\n \"threelettercode\": \"ARE\",\r\n \"postcode_pattern\": null\r\n },\r\n {\r\n \"idcountry\": 224,\r\n \"name\": \"United States minor outlying islands\",\r\n \"twolettercode\": \"UM\",\r\n \"threelettercode\": \"UMI\",\r\n \"postcode_pattern\": null\r\n },\r\n {\r\n \"idcountry\": 225,\r\n \"name\": \"Uruguay\",\r\n \"twolettercode\": \"UY\",\r\n \"threelettercode\": \"URY\",\r\n \"postcode_pattern\": null\r\n },\r\n {\r\n \"idcountry\": 226,\r\n \"name\": \"Uzbekistan\",\r\n \"twolettercode\": \"UZ\",\r\n \"threelettercode\": \"UZB\",\r\n \"postcode_pattern\": null\r\n },\r\n {\r\n \"idcountry\": 227,\r\n \"name\": \"Vanuatu\",\r\n \"twolettercode\": \"VU\",\r\n \"threelettercode\": \"VUT\",\r\n \"postcode_pattern\": null\r\n },\r\n {\r\n \"idcountry\": 228,\r\n \"name\": \"Venezuela\",\r\n \"twolettercode\": \"VE\",\r\n \"threelettercode\": \"VEN\",\r\n \"postcode_pattern\": null\r\n },\r\n {\r\n \"idcountry\": 229,\r\n \"name\": \"Viet Nam\",\r\n \"twolettercode\": \"VN\",\r\n \"threelettercode\": \"VNM\",\r\n \"postcode_pattern\": null\r\n },\r\n {\r\n \"idcountry\": 230,\r\n \"name\": \"Virgin Islands (British)\",\r\n \"twolettercode\": \"VG\",\r\n \"threelettercode\": \"VGB\",\r\n \"postcode_pattern\": null\r\n },\r\n {\r\n \"idcountry\": 231,\r\n \"name\": \"Virgin Islands (U.S.)\",\r\n \"twolettercode\": \"VI\",\r\n \"threelettercode\": \"VIR\",\r\n \"postcode_pattern\": null\r\n },\r\n {\r\n \"idcountry\": 232,\r\n \"name\": \"Wallis and Futuna Islands\",\r\n \"twolettercode\": \"WF\",\r\n \"threelettercode\": \"WLF\",\r\n \"postcode_pattern\": null\r\n },\r\n {\r\n \"idcountry\": 233,\r\n \"name\": \"Western Sahara\",\r\n \"twolettercode\": \"EH\",\r\n \"threelettercode\": \"ESH\",\r\n \"postcode_pattern\": null\r\n },\r\n {\r\n \"idcountry\": 234,\r\n \"name\": \"Yemen\",\r\n \"twolettercode\": \"YE\",\r\n \"threelettercode\": \"YEM\",\r\n \"postcode_pattern\": null\r\n },\r\n {\r\n \"idcountry\": 235,\r\n \"name\": \"Yugoslavia\",\r\n \"twolettercode\": \"YU\",\r\n \"threelettercode\": \"YUG\",\r\n \"postcode_pattern\": null\r\n },\r\n {\r\n \"idcountry\": 236,\r\n \"name\": \"Zambia\",\r\n \"twolettercode\": \"ZM\",\r\n \"threelettercode\": \"ZMB\",\r\n \"postcode_pattern\": null\r\n },\r\n {\r\n \"idcountry\": 237,\r\n \"name\": \"Zimbabwe\",\r\n \"twolettercode\": \"ZW\",\r\n \"threelettercode\": \"ZWE\",\r\n \"postcode_pattern\": null\r\n }\r\n ]\r\n }\r\n}"}],"_postman_id":"ad5591b5-498d-4173-9008-b54f8938170c"},{"name":"Category list","event":[{"listen":"test","script":{"id":"51f66d0b-9df6-4873-9ac9-e23d7a9498a1","exec":[""],"type":"text/javascript"}}],"id":"5554ea30-a101-4b4b-b1b7-513cf210cc75","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://YOUR-CAPTURE-DOMAIN/api/contact/category","description":"Response: List of possible contact categories
\nUse: During registration a contact category may be required, this returns the controlled list to be used.
\n","urlObject":{"protocol":"https","path":["api","contact","category"],"host":["YOUR-CAPTURE-DOMAIN"],"query":[],"variable":[]}},"response":[{"id":"64e0a804-e1fb-4306-b238-6a38ea791d2b","name":"Success","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://YOUR-CAPTURE-DOMAIN/api/contact/category"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Origin","value":"","name":"Access-Control-Allow-Origin","description":"Specifies a URI that may access the resource. For requests without credentials, the server may specify '*' as a wildcard, thereby allowing any origin to access the resource."},{"key":"Connection","value":"Upgrade, Keep-Alive","name":"Connection","description":"Options that are desired for the connection"},{"key":"Content-Encoding","value":"gzip","name":"Content-Encoding","description":"The type of encoding used on the data."},{"key":"Content-Language","value":"en","name":"Content-Language","description":"The language the content is in"},{"key":"Content-Length","value":"552","name":"Content-Length","description":"The length of the response body in octets (8-bit bytes)"},{"key":"Content-Type","value":"application/json; charset=UTF-8","name":"Content-Type","description":"The mime type of this content"},{"key":"Date","value":"Thu, 03 May 2018 14:31:29 GMT","name":"Date","description":"The date and time that the message was sent"},{"key":"Keep-Alive","value":"timeout=5, max=100","name":"Keep-Alive","description":"Custom header"},{"key":"Server","value":"Apache","name":"Server","description":"A name for the server"},{"key":"Upgrade","value":"h2,h2c","name":"Upgrade","description":"Custom header"},{"key":"Vary","value":"Accept-Encoding","name":"Vary","description":"Tells downstream proxies how to match future request headers to decide whether the cached response can be used rather than requesting a fresh one from the origin server."},{"key":"X-Powered-By","value":"capture API","name":"X-Powered-By","description":"Specifies the technology (ASP.NET, PHP, JBoss, e.g.) supporting the web application (version details are often in X-Runtime, X-Version, or X-AspNet-Version)"}],"cookie":[],"responseTime":null,"body":"{\r\n \"status\": 200,\r\n \"data\": {\r\n \"contactCategoryList\": [\r\n {\r\n \"idcontact_category\": 4,\r\n \"name\": \"Ad Company\"\r\n },\r\n {\r\n \"idcontact_category\": 5,\r\n \"name\": \"Airline\"\r\n },\r\n {\r\n \"idcontact_category\": 6,\r\n \"name\": \"Business intermediary\"\r\n },\r\n {\r\n \"idcontact_category\": 7,\r\n \"name\": \"Business/industry\"\r\n },\r\n {\r\n \"idcontact_category\": 8,\r\n \"name\": \"Cards/calendar printers\"\r\n },\r\n {\r\n \"idcontact_category\": 9,\r\n \"name\": \"Computer contact\"\r\n },\r\n {\r\n \"idcontact_category\": 10,\r\n \"name\": \"Consultant\"\r\n },\r\n {\r\n \"idcontact_category\": 11,\r\n \"name\": \"Designers\"\r\n },\r\n {\r\n \"idcontact_category\": 12,\r\n \"name\": \"Exhibition firms\"\r\n },\r\n {\r\n \"idcontact_category\": 13,\r\n \"name\": \"Government sectors\"\r\n },\r\n {\r\n \"idcontact_category\": 14,\r\n \"name\": \"Hotel/Club\"\r\n },\r\n {\r\n \"idcontact_category\": 15,\r\n \"name\": \"Magazine - controlled circulation\"\r\n },\r\n {\r\n \"idcontact_category\": 16,\r\n \"name\": \"Magazine - foreign\"\r\n },\r\n {\r\n \"idcontact_category\": 17,\r\n \"name\": \"Magazine - national\"\r\n },\r\n {\r\n \"idcontact_category\": 18,\r\n \"name\": \"Magazine - specialist\"\r\n },\r\n {\r\n \"idcontact_category\": 19,\r\n \"name\": \"Magazines - contract publishers\"\r\n },\r\n {\r\n \"idcontact_category\": 20,\r\n \"name\": \"Mail order firm\"\r\n },\r\n {\r\n \"idcontact_category\": 21,\r\n \"name\": \"Marketing\"\r\n },\r\n {\r\n \"idcontact_category\": 22,\r\n \"name\": \"Multi-media firm\"\r\n },\r\n {\r\n \"idcontact_category\": 23,\r\n \"name\": \"National tourist organisation\"\r\n },\r\n {\r\n \"idcontact_category\": 24,\r\n \"name\": \"News agency\"\r\n },\r\n {\r\n \"idcontact_category\": 25,\r\n \"name\": \"Newspaper - foreign\"\r\n },\r\n {\r\n \"idcontact_category\": 26,\r\n \"name\": \"Newspaper - national\"\r\n },\r\n {\r\n \"idcontact_category\": 27,\r\n \"name\": \"Newspaper - regional\"\r\n },\r\n {\r\n \"idcontact_category\": 28,\r\n \"name\": \"Picture research agency\"\r\n },\r\n {\r\n \"idcontact_category\": 29,\r\n \"name\": \"Picture researcher\"\r\n },\r\n {\r\n \"idcontact_category\": 30,\r\n \"name\": \"Public relations firm\"\r\n },\r\n {\r\n \"idcontact_category\": 31,\r\n \"name\": \"Publisher – periodicals\"\r\n },\r\n {\r\n \"idcontact_category\": 32,\r\n \"name\": \"Publishers - audio visual\"\r\n },\r\n {\r\n \"idcontact_category\": 33,\r\n \"name\": \"Publishers - books\"\r\n },\r\n {\r\n \"idcontact_category\": 34,\r\n \"name\": \"Publishers - educational\"\r\n },\r\n {\r\n \"idcontact_category\": 35,\r\n \"name\": \"Publishers - maps\"\r\n },\r\n {\r\n \"idcontact_category\": 36,\r\n \"name\": \"Regional newspaper group\"\r\n },\r\n {\r\n \"idcontact_category\": 37,\r\n \"name\": \"Travel firm/organisation\"\r\n },\r\n {\r\n \"idcontact_category\": 38,\r\n \"name\": \"TV company\"\r\n },\r\n {\r\n \"idcontact_category\": 39,\r\n \"name\": \"Web company\"\r\n }\r\n ]\r\n }\r\n}"}],"_postman_id":"5554ea30-a101-4b4b-b1b7-513cf210cc75"},{"name":"Language list","event":[{"listen":"test","script":{"id":"512f0e43-ebd4-4aed-8985-4dd412c8f603","exec":[""],"type":"text/javascript"}}],"id":"bb531694-8b41-4927-8f16-7f9b0d63f324","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://YOUR-CAPTURE-DOMAIN/api/contact/language","description":"Response: List of system languages
\nUse: Used to obtain the list of languages supported by the site. Assign a user to a specific language upon registration.
\n","urlObject":{"protocol":"https","path":["api","contact","language"],"host":["YOUR-CAPTURE-DOMAIN"],"query":[],"variable":[]}},"response":[{"id":"730a31c4-f854-40e0-be6a-a369470f8ef4","name":"Success","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://YOUR-CAPTURE-DOMAIN/api/contact/language"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Origin","value":"","name":"Access-Control-Allow-Origin","description":"Specifies a URI that may access the resource. For requests without credentials, the server may specify '*' as a wildcard, thereby allowing any origin to access the resource."},{"key":"Connection","value":"Upgrade, Keep-Alive","name":"Connection","description":"Options that are desired for the connection"},{"key":"Content-Encoding","value":"gzip","name":"Content-Encoding","description":"The type of encoding used on the data."},{"key":"Content-Language","value":"en","name":"Content-Language","description":"The language the content is in"},{"key":"Content-Length","value":"175","name":"Content-Length","description":"The length of the response body in octets (8-bit bytes)"},{"key":"Content-Type","value":"application/json; charset=UTF-8","name":"Content-Type","description":"The mime type of this content"},{"key":"Date","value":"Thu, 03 May 2018 14:44:56 GMT","name":"Date","description":"The date and time that the message was sent"},{"key":"Keep-Alive","value":"timeout=5, max=100","name":"Keep-Alive","description":"Custom header"},{"key":"Server","value":"Apache","name":"Server","description":"A name for the server"},{"key":"Upgrade","value":"h2,h2c","name":"Upgrade","description":"Custom header"},{"key":"Vary","value":"Accept-Encoding","name":"Vary","description":"Tells downstream proxies how to match future request headers to decide whether the cached response can be used rather than requesting a fresh one from the origin server."},{"key":"X-Powered-By","value":"capture API","name":"X-Powered-By","description":"Specifies the technology (ASP.NET, PHP, JBoss, e.g.) supporting the web application (version details are often in X-Runtime, X-Version, or X-AspNet-Version)"}],"cookie":[],"responseTime":null,"body":"{\r\n \"status\":200,\r\n \"data\":{\r\n \"languageList\":[\r\n {\r\n \"idlanguage\":\"1\",\r\n \"name\":\"English\",\r\n \"transcode\":\"en\",\r\n \"flagImage\":\"http://demo.dev2.captureweb.net/coo/app/images/flags/1.gif\"\r\n },\r\n {\r\n \"idlanguage\":\"2\",\r\n \"name\":\"French\",\r\n \"transcode\":\"fr\",\r\n \"flagImage\":\"http://demo.dev2.captureweb.net/coo/app/images/flags/2.gif\"\r\n }\r\n ]\r\n }\r\n}"}],"_postman_id":"bb531694-8b41-4927-8f16-7f9b0d63f324"},{"name":"US State list","event":[{"listen":"test","script":{"id":"d83afe3c-2020-48f4-b11e-790ccc9ed052","exec":[""],"type":"text/javascript"}}],"id":"f5d4d676-5bd7-41d2-8952-035da8f15baa","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://YOUR-CAPTURE-DOMAIN/api/contact/usstate","description":"Response: Returns a list of US States
\nUse: Some payment gateways require that the State field for US customers are from a controlled list, this endpoint provides that controlled list
\n","urlObject":{"protocol":"https","path":["api","contact","usstate"],"host":["YOUR-CAPTURE-DOMAIN"],"query":[],"variable":[]}},"response":[{"id":"4ef64ae7-057a-4276-b77e-bbece96e6da3","name":"Success","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://YOUR-CAPTURE-DOMAIN/api/contact/usstate"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Origin","value":"","name":"Access-Control-Allow-Origin","description":"Specifies a URI that may access the resource. For requests without credentials, the server may specify '*' as a wildcard, thereby allowing any origin to access the resource."},{"key":"Connection","value":"Upgrade, Keep-Alive","name":"Connection","description":"Options that are desired for the connection"},{"key":"Content-Encoding","value":"gzip","name":"Content-Encoding","description":"The type of encoding used on the data."},{"key":"Content-Language","value":"en","name":"Content-Language","description":"The language the content is in"},{"key":"Content-Length","value":"545","name":"Content-Length","description":"The length of the response body in octets (8-bit bytes)"},{"key":"Content-Type","value":"application/json; charset=UTF-8","name":"Content-Type","description":"The mime type of this content"},{"key":"Date","value":"Thu, 03 May 2018 14:48:04 GMT","name":"Date","description":"The date and time that the message was sent"},{"key":"Keep-Alive","value":"timeout=5, max=100","name":"Keep-Alive","description":"Custom header"},{"key":"Server","value":"Apache","name":"Server","description":"A name for the server"},{"key":"Upgrade","value":"h2,h2c","name":"Upgrade","description":"Custom header"},{"key":"Vary","value":"Accept-Encoding","name":"Vary","description":"Tells downstream proxies how to match future request headers to decide whether the cached response can be used rather than requesting a fresh one from the origin server."},{"key":"X-Powered-By","value":"capture API","name":"X-Powered-By","description":"Specifies the technology (ASP.NET, PHP, JBoss, e.g.) supporting the web application (version details are often in X-Runtime, X-Version, or X-AspNet-Version)"}],"cookie":[],"responseTime":null,"body":"{\r\n \"status\": 200,\r\n \"data\": [\r\n {\r\n \"state\": \"Alabama\",\r\n \"abbreviation\": \"AL\"\r\n },\r\n {\r\n \"state\": \"Alaska\",\r\n \"abbreviation\": \"AK\"\r\n },\r\n {\r\n \"state\": \"Arizona\",\r\n \"abbreviation\": \"AZ\"\r\n },\r\n {\r\n \"state\": \"Arkansas\",\r\n \"abbreviation\": \"AR\"\r\n },\r\n {\r\n \"state\": \"California\",\r\n \"abbreviation\": \"CA\"\r\n },\r\n {\r\n \"state\": \"Colorado\",\r\n \"abbreviation\": \"CO\"\r\n },\r\n {\r\n \"state\": \"Connecticut\",\r\n \"abbreviation\": \"CT\"\r\n },\r\n {\r\n \"state\": \"Delaware\",\r\n \"abbreviation\": \"DE\"\r\n },\r\n {\r\n \"state\": \"District of Columbia\",\r\n \"abbreviation\": \"DC\"\r\n },\r\n {\r\n \"state\": \"Florida\",\r\n \"abbreviation\": \"FL\"\r\n },\r\n {\r\n \"state\": \"Georgia\",\r\n \"abbreviation\": \"GA\"\r\n },\r\n {\r\n \"state\": \"Hawaii\",\r\n \"abbreviation\": \"HI\"\r\n },\r\n {\r\n \"state\": \"Idaho\",\r\n \"abbreviation\": \"ID\"\r\n },\r\n {\r\n \"state\": \"Illinois\",\r\n \"abbreviation\": \"IL\"\r\n },\r\n {\r\n \"state\": \"Indiana\",\r\n \"abbreviation\": \"IN\"\r\n },\r\n {\r\n \"state\": \"Iowa\",\r\n \"abbreviation\": \"IA\"\r\n },\r\n {\r\n \"state\": \"Kansas\",\r\n \"abbreviation\": \"KS\"\r\n },\r\n {\r\n \"state\": \"Kentucky\",\r\n \"abbreviation\": \"KY\"\r\n },\r\n {\r\n \"state\": \"Louisiana\",\r\n \"abbreviation\": \"LA\"\r\n },\r\n {\r\n \"state\": \"Maine\",\r\n \"abbreviation\": \"ME\"\r\n },\r\n {\r\n \"state\": \"Montana\",\r\n \"abbreviation\": \"MT\"\r\n },\r\n {\r\n \"state\": \"Nebraska\",\r\n \"abbreviation\": \"NE\"\r\n },\r\n {\r\n \"state\": \"Nevada\",\r\n \"abbreviation\": \"NV\"\r\n },\r\n {\r\n \"state\": \"New Hampshire\",\r\n \"abbreviation\": \"NH\"\r\n },\r\n {\r\n \"state\": \"New Jersey\",\r\n \"abbreviation\": \"NJ\"\r\n },\r\n {\r\n \"state\": \"New Mexico\",\r\n \"abbreviation\": \"NM\"\r\n },\r\n {\r\n \"state\": \"New York\",\r\n \"abbreviation\": \"NY\"\r\n },\r\n {\r\n \"state\": \"North Carolina\",\r\n \"abbreviation\": \"NC\"\r\n },\r\n {\r\n \"state\": \"North Dakota\",\r\n \"abbreviation\": \"ND\"\r\n },\r\n {\r\n \"state\": \"Ohio\",\r\n \"abbreviation\": \"OH\"\r\n },\r\n {\r\n \"state\": \"Oklahoma\",\r\n \"abbreviation\": \"OK\"\r\n },\r\n {\r\n \"state\": \"Oregon\",\r\n \"abbreviation\": \"OR\"\r\n },\r\n {\r\n \"state\": \"Maryland\",\r\n \"abbreviation\": \"MD\"\r\n },\r\n {\r\n \"state\": \"Massachusetts\",\r\n \"abbreviation\": \"MA\"\r\n },\r\n {\r\n \"state\": \"Michigan\",\r\n \"abbreviation\": \"MI\"\r\n },\r\n {\r\n \"state\": \"Minnesota\",\r\n \"abbreviation\": \"MN\"\r\n },\r\n {\r\n \"state\": \"Mississippi\",\r\n \"abbreviation\": \"MS\"\r\n },\r\n {\r\n \"state\": \"Missouri\",\r\n \"abbreviation\": \"MO\"\r\n },\r\n {\r\n \"state\": \"Pennsylvania\",\r\n \"abbreviation\": \"PA\"\r\n },\r\n {\r\n \"state\": \"Rhode Island\",\r\n \"abbreviation\": \"RI\"\r\n },\r\n {\r\n \"state\": \"South Carolina\",\r\n \"abbreviation\": \"SC\"\r\n },\r\n {\r\n \"state\": \"South Dakota\",\r\n \"abbreviation\": \"SD\"\r\n },\r\n {\r\n \"state\": \"Tennessee\",\r\n \"abbreviation\": \"TN\"\r\n },\r\n {\r\n \"state\": \"Texas\",\r\n \"abbreviation\": \"TX\"\r\n },\r\n {\r\n \"state\": \"Utah\",\r\n \"abbreviation\": \"UT\"\r\n },\r\n {\r\n \"state\": \"Vermont\",\r\n \"abbreviation\": \"VT\"\r\n },\r\n {\r\n \"state\": \"Virginia\",\r\n \"abbreviation\": \"VA\"\r\n },\r\n {\r\n \"state\": \"Washington\",\r\n \"abbreviation\": \"WA\"\r\n },\r\n {\r\n \"state\": \"West Virginia\",\r\n \"abbreviation\": \"WV\"\r\n },\r\n {\r\n \"state\": \"Wisconsin\",\r\n \"abbreviation\": \"WI\"\r\n },\r\n {\r\n \"state\": \"Wyoming\",\r\n \"abbreviation\": \"WY\"\r\n }\r\n ]\r\n}"}],"_postman_id":"f5d4d676-5bd7-41d2-8952-035da8f15baa"},{"name":"Register user","event":[{"listen":"test","script":{"id":"272e7aff-a39b-47d6-983d-a582d4369b4e","exec":[""],"type":"text/javascript"}},{"listen":"prerequest","script":{"id":"8036a973-b251-4111-a1cf-5b8c373dc723","exec":[""],"type":"text/javascript"}}],"id":"5d628b74-76d5-40aa-be81-d95624948ef9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"first_name\":\"Jane\",\n \"last_name\":\"Last\",\n \"email\":\"jane.last@example.co.uk\",\n \"password\":\"ExamplePassword123\",\n \"idlanguage\":1,\n \"country\":222,\n \"company\":\"Example Company\",\n \"idcontact_type\":2,\n \"self_employed\":0,\n \"idcontact_category\":10\n}"},"url":"https://YOUR-CAPTURE-DOMAIN/api/contact","description":"Response: 200 on success, 4XX on failure, with error message.
\nUse: Checked params are mandatory and will be validated by the API. Email format will be checked, username will be checked for uniqueness. Language will default to English if not specified.
\n -The unchecked params are optional, accepted values can be obtained to populate dropdowns by get calls to\n /contact/language\n /contact/country\n /contact/category\nResponse: 200 on success, 4XX on failure with error message
\nUse:: Used to update a contact record
\n","urlObject":{"protocol":"https","path":["api","contact","CONTACT-ID"],"host":["YOUR-CAPTURE-DOMAIN"],"query":[],"variable":[]}},"response":[{"id":"20e57164-4ebd-4444-b436-e0a986c6469f","name":"update contact","originalRequest":{"method":"PATCH","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"{{vault:bearer-token}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"address1\":\"12 Test Road \",\n \"address2\":\"London UK\"\n}"},"url":"https://YOUR-CAPTURE-DOMAIN/api/contact/CONTACT-ID"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Origin","value":"","name":"Access-Control-Allow-Origin","description":"Specifies a URI that may access the resource. For requests without credentials, the server may specify '*' as a wildcard, thereby allowing any origin to access the resource."},{"key":"Connection","value":"Upgrade, Keep-Alive","name":"Connection","description":"Options that are desired for the connection"},{"key":"Content-Encoding","value":"gzip","name":"Content-Encoding","description":"The type of encoding used on the data."},{"key":"Content-Language","value":"en","name":"Content-Language","description":"The language the content is in"},{"key":"Content-Length","value":"62","name":"Content-Length","description":"The length of the response body in octets (8-bit bytes)"},{"key":"Content-Type","value":"application/json; charset=UTF-8","name":"Content-Type","description":"The mime type of this content"},{"key":"Date","value":"Fri, 04 May 2018 10:18:52 GMT","name":"Date","description":"The date and time that the message was sent"},{"key":"Keep-Alive","value":"timeout=5, max=100","name":"Keep-Alive","description":"Custom header"},{"key":"Server","value":"Apache","name":"Server","description":"A name for the server"},{"key":"Upgrade","value":"h2,h2c","name":"Upgrade","description":"Custom header"},{"key":"Vary","value":"Accept-Encoding","name":"Vary","description":"Tells downstream proxies how to match future request headers to decide whether the cached response can be used rather than requesting a fresh one from the origin server."},{"key":"X-Powered-By","value":"capture API","name":"X-Powered-By","description":"Specifies the technology (ASP.NET, PHP, JBoss, e.g.) supporting the web application (version details are often in X-Runtime, X-Version, or X-AspNet-Version)"}],"cookie":[],"responseTime":null,"body":"{\r\n \"status\":200,\r\n \"data\":{\r\n \"message\":\"updated\"\r\n }\r\n}"}],"_postman_id":"8bc67a68-5833-4bc0-9149-3bb16ed6e028"},{"name":"Current user","event":[{"listen":"test","script":{"id":"3b828717-42b6-4aae-a018-f9f4caaec8b6","exec":[""],"type":"text/javascript"}}],"id":"965ce0cb-8467-439c-bca9-4a7909540beb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{vault:authorization-secret}}"},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"url":"https://YOUR-CAPTURE-DOMAIN/api/contact","description":"Response: Information about the current user
\nUse: Used to get information about the current user
\n","urlObject":{"protocol":"https","path":["api","contact"],"host":["YOUR-CAPTURE-DOMAIN"],"query":[],"variable":[]}},"response":[{"id":"6513afb7-567a-43ef-9cbf-3fed414f2c46","name":"Getting contact details ","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"{{vault:bearer-token}}","type":"text"}],"url":"https://YOUR-CAPTURE-DOMAIN/api/contact"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Origin","value":"","name":"Access-Control-Allow-Origin","description":"Specifies a URI that may access the resource. For requests without credentials, the server may specify '*' as a wildcard, thereby allowing any origin to access the resource."},{"key":"Connection","value":"Upgrade, Keep-Alive","name":"Connection","description":"Options that are desired for the connection"},{"key":"Content-Encoding","value":"gzip","name":"Content-Encoding","description":"The type of encoding used on the data."},{"key":"Content-Language","value":"en","name":"Content-Language","description":"The language the content is in"},{"key":"Content-Length","value":"485","name":"Content-Length","description":"The length of the response body in octets (8-bit bytes)"},{"key":"Content-Type","value":"application/json; charset=UTF-8","name":"Content-Type","description":"The mime type of this content"},{"key":"Date","value":"Thu, 03 May 2018 15:36:08 GMT","name":"Date","description":"The date and time that the message was sent"},{"key":"Keep-Alive","value":"timeout=5, max=100","name":"Keep-Alive","description":"Custom header"},{"key":"Server","value":"Apache","name":"Server","description":"A name for the server"},{"key":"Upgrade","value":"h2,h2c","name":"Upgrade","description":"Custom header"},{"key":"Vary","value":"Accept-Encoding","name":"Vary","description":"Tells downstream proxies how to match future request headers to decide whether the cached response can be used rather than requesting a fresh one from the origin server."},{"key":"X-Powered-By","value":"capture API","name":"X-Powered-By","description":"Specifies the technology (ASP.NET, PHP, JBoss, e.g.) supporting the web application (version details are often in X-Runtime, X-Version, or X-AspNet-Version)"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"data\": {\n \"user\": {\n \"idcontacts\": \"55\",\n \"fname\": \"John\",\n \"lname\": \"Doe\",\n \"email\": \"john.doe@capture.co.uk\",\n \"photo_code\" : \"BC\",\n \"contributor\": true,\n \"hotfolder\": false,\n \"category\": {\n \"idcontact_category\": \"10\",\n \"name\": \"Consultant\",\n \"homepage_category_id\": null\n }\n },\n \"comms\": {\n \"email\": \"john.doe@capture.co.uk\",\n \"address1\": null,\n \"address2\": null,\n \"address3\": null,\n \"town\": null,\n \"county\": null,\n \"post_code\": null,\n \"tel\": null,\n \"mobile\": null,\n \"www\": null\n },\n \"locale\": {\n \"country\": {\n \"idcountry\": \"222\",\n \"name\": \"United Kingdom\",\n \"twolettercode\": \"GB\"\n },\n \"language\": {\n \"idlanguage\": \"1\",\n \"name\": \"English\",\n \"transcode\": \"en\",\n \"flag_url\": \"http://example-site.com/coo/app/images/flags/1.gif\"\n }\n },\n \"permissions\": {\n \"contributor\": true,\n \"name\": \"Full access\",\n \"download\": {\n \"AUTHORIZED_USER_INVOICE_ORDER\": true,\n \"AUTHORIZED_USER_BUY_ORDER\": true,\n \"AUTHORIZED_USER_HI_RES_ASSET_DIRECT_DOWNLOAD\": true,\n \"AUTHORIZED_USER_DAM_DOWNLOAD\": false,\n \"AUTHORIZED_USER_HIDE_PRICE\": false\n }\n },\n \"groups\": []\n }\n}"}],"_postman_id":"965ce0cb-8467-439c-bca9-4a7909540beb"},{"name":"Password change","id":"77b7e70f-5931-4551-95e0-305a0e3a608f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{vault:authorization-secret}}"},"isInherited":false},"method":"PATCH","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"new_password\":\"ExampleNewPassword123\",\n \"old_password\":\"ExampleOldPassword123\"\n}"},"url":"https://YOUR-CAPTURE-DOMAIN/api/contact/password/change","description":"Test :Change the exsting password API endpoint
\nUse Case: When the API is called without giving any option or variable, the user will have to pass the new password along with the old password. Make sure you pass the access token to update the record.
\nResponse Status: 200 OK
\n","urlObject":{"protocol":"https","path":["api","contact","password","change"],"host":["YOUR-CAPTURE-DOMAIN"],"query":[],"variable":[]}},"response":[{"id":"a93a5c28-23c7-4af0-80d9-ff6f929963d7","name":"Password change","originalRequest":{"method":"PATCH","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"{{vault:bearer-token}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"new_password\":\"password111\",\n \"old_password\":\"password1234\"\n}"},"url":"https://YOUR-CAPTURE-DOMAIN/api/contact/password/change"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Origin","value":"","name":"Access-Control-Allow-Origin","description":"Specifies a URI that may access the resource. For requests without credentials, the server may specify '*' as a wildcard, thereby allowing any origin to access the resource."},{"key":"Connection","value":"Upgrade, Keep-Alive","name":"Connection","description":"Options that are desired for the connection"},{"key":"Content-Encoding","value":"gzip","name":"Content-Encoding","description":"The type of encoding used on the data."},{"key":"Content-Language","value":"en","name":"Content-Language","description":"The language the content is in"},{"key":"Content-Length","value":"72","name":"Content-Length","description":"The length of the response body in octets (8-bit bytes)"},{"key":"Content-Type","value":"application/json; charset=UTF-8","name":"Content-Type","description":"The mime type of this content"},{"key":"Date","value":"Mon, 14 May 2018 08:15:20 GMT","name":"Date","description":"The date and time that the message was sent"},{"key":"Keep-Alive","value":"timeout=5, max=100","name":"Keep-Alive","description":"Custom header"},{"key":"Server","value":"Apache","name":"Server","description":"A name for the server"},{"key":"Upgrade","value":"h2,h2c","name":"Upgrade","description":"Custom header"},{"key":"Vary","value":"Accept-Encoding","name":"Vary","description":"Tells downstream proxies how to match future request headers to decide whether the cached response can be used rather than requesting a fresh one from the origin server."},{"key":"X-Powered-By","value":"capture API","name":"X-Powered-By","description":"Specifies the technology (ASP.NET, PHP, JBoss, e.g.) supporting the web application (version details are often in X-Runtime, X-Version, or X-AspNet-Version)"}],"cookie":[],"responseTime":null,"body":"{\r\n \"status\":200,\r\n \"data\":{\r\n \"message\":\"password changed\"\r\n }\r\n}"}],"_postman_id":"77b7e70f-5931-4551-95e0-305a0e3a608f"},{"name":"Password reset notify","event":[{"listen":"test","script":{"id":"903edc0e-12a9-487e-924c-9df64789ea52","exec":[""],"type":"text/javascript"}}],"id":"6f79fb0f-ccd9-42ae-a3bb-ea0df7a1a867","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"email\":\"capture@example.com\"\n}"},"url":"https://YOUR-CAPTURE-DOMAIN/api/contact/password/resetnotify","description":"Request a password reset link. The user's email address is sent in the payload, and if valid registered user, an email with a link to follow.
\n","urlObject":{"protocol":"https","path":["api","contact","password","resetnotify"],"host":["YOUR-CAPTURE-DOMAIN"],"query":[],"variable":[]}},"response":[{"id":"ce8ade04-66a0-4acf-9af8-191ee209b46b","name":"Success","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"email\":\"john.doe@capture.co.uk\"\n}"},"url":"https://YOUR-CAPTURE-DOMAIN/api/contact/password/resetnotify"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Origin","value":"","name":"Access-Control-Allow-Origin","description":"Specifies a URI that may access the resource. For requests without credentials, the server may specify '*' as a wildcard, thereby allowing any origin to access the resource."},{"key":"Connection","value":"Upgrade, Keep-Alive","name":"Connection","description":"Options that are desired for the connection"},{"key":"Content-Encoding","value":"gzip","name":"Content-Encoding","description":"The type of encoding used on the data."},{"key":"Content-Language","value":"en","name":"Content-Language","description":"The language the content is in"},{"key":"Content-Length","value":"95","name":"Content-Length","description":"The length of the response body in octets (8-bit bytes)"},{"key":"Content-Type","value":"application/json; charset=UTF-8","name":"Content-Type","description":"The mime type of this content"},{"key":"Date","value":"Fri, 04 May 2018 10:57:32 GMT","name":"Date","description":"The date and time that the message was sent"},{"key":"Keep-Alive","value":"timeout=5, max=100","name":"Keep-Alive","description":"Custom header"},{"key":"Server","value":"Apache","name":"Server","description":"A name for the server"},{"key":"Upgrade","value":"h2,h2c","name":"Upgrade","description":"Custom header"},{"key":"Vary","value":"Accept-Encoding","name":"Vary","description":"Tells downstream proxies how to match future request headers to decide whether the cached response can be used rather than requesting a fresh one from the origin server."},{"key":"X-Powered-By","value":"capture API","name":"X-Powered-By","description":"Specifies the technology (ASP.NET, PHP, JBoss, e.g.) supporting the web application (version details are often in X-Runtime, X-Version, or X-AspNet-Version)"}],"cookie":[],"responseTime":null,"body":"{\"status\":200,\"data\":{\"security_code\":\"15143b64b360cc7269402820d695d8c7322f31b6\"}}"},{"id":"1976cded-c04e-4081-8232-073e6ed25d14","name":"Failure","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"email\":\"john.doe@capture.co.uk\"\n}"},"url":"https://YOUR-CAPTURE-DOMAIN/api/contact/password/resetnotify"},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Origin","value":"","name":"Access-Control-Allow-Origin","description":"Specifies a URI that may access the resource. For requests without credentials, the server may specify '*' as a wildcard, thereby allowing any origin to access the resource."},{"key":"Connection","value":"Upgrade, Keep-Alive","name":"Connection","description":"Options that are desired for the connection"},{"key":"Content-Encoding","value":"gzip","name":"Content-Encoding","description":"The type of encoding used on the data."},{"key":"Content-Language","value":"en","name":"Content-Language","description":"The language the content is in"},{"key":"Content-Length","value":"95","name":"Content-Length","description":"The length of the response body in octets (8-bit bytes)"},{"key":"Content-Type","value":"application/json; charset=UTF-8","name":"Content-Type","description":"The mime type of this content"},{"key":"Date","value":"Fri, 04 May 2018 10:57:32 GMT","name":"Date","description":"The date and time that the message was sent"},{"key":"Keep-Alive","value":"timeout=5, max=100","name":"Keep-Alive","description":"Custom header"},{"key":"Server","value":"Apache","name":"Server","description":"A name for the server"},{"key":"Upgrade","value":"h2,h2c","name":"Upgrade","description":"Custom header"},{"key":"Vary","value":"Accept-Encoding","name":"Vary","description":"Tells downstream proxies how to match future request headers to decide whether the cached response can be used rather than requesting a fresh one from the origin server."},{"key":"X-Powered-By","value":"capture API","name":"X-Powered-By","description":"Specifies the technology (ASP.NET, PHP, JBoss, e.g.) supporting the web application (version details are often in X-Runtime, X-Version, or X-AspNet-Version)"}],"cookie":[],"responseTime":null,"body":"{\r\n \"status\": 500,\r\n \"error\": {\r\n \"code\": \"user-0018\",\r\n \"message\": \"internal server error\",\r\n \"summary\": \"password reset is currently unavailable; try later or contact support\",\r\n \"verbose\": []\r\n }\r\n}"}],"_postman_id":"6f79fb0f-ccd9-42ae-a3bb-ea0df7a1a867"},{"name":"Password reset change","event":[{"listen":"test","script":{"id":"4ea4d822-3c67-411a-9399-555bfbe3a337","exec":[""],"type":"text/javascript"}}],"id":"70d11943-953f-481a-85fa-48315e04c5db","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"new_password\":\"ExamplePassword1\",\n \"security_code\":\"53cbec6de2c279b445c406ed03fd8c4ff90ecf60\"\n}"},"url":"https://YOUR-CAPTURE-DOMAIN/api/contact/password/resetchange","description":"After an email with a password reset link is recieved containing a security code, this endpoint allows the new password to be set.
\nNote, the security code will only last for a few minutes before it expires.
\n","urlObject":{"protocol":"https","path":["api","contact","password","resetchange"],"host":["YOUR-CAPTURE-DOMAIN"],"query":[],"variable":[]}},"response":[{"id":"ee7a050b-1ddc-4992-9ace-c6197638c7c2","name":"Failure","originalRequest":{"method":"PATCH","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"new_password\":\"password666\",\n \"security_code\":\"7b983fae9494961b65d3c193b5e2efdfe91d6f5f\"\n}"},"url":"https://YOUR-CAPTURE-DOMAIN/api/contact/password/resetchange"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Origin","value":"","name":"Access-Control-Allow-Origin","description":"Specifies a URI that may access the resource. For requests without credentials, the server may specify '*' as a wildcard, thereby allowing any origin to access the resource."},{"key":"Connection","value":"Upgrade, close","name":"Connection","description":"Options that are desired for the connection"},{"key":"Content-Language","value":"en","name":"Content-Language","description":"The language the content is in"},{"key":"Content-Type","value":"application/json; charset=UTF-8","name":"Content-Type","description":"The mime type of this content"},{"key":"Date","value":"Fri, 04 May 2018 12:37:19 GMT","name":"Date","description":"The date and time that the message was sent"},{"key":"Server","value":"Apache","name":"Server","description":"A name for the server"},{"key":"Transfer-Encoding","value":"chunked","name":"Transfer-Encoding","description":"The form of encoding used to safely transfer the entity to the user. Currently defined methods are: chunked, compress, deflate, gzip, identity."},{"key":"Upgrade","value":"h2,h2c","name":"Upgrade","description":"Custom header"},{"key":"X-Powered-By","value":"capture API","name":"X-Powered-By","description":"Specifies the technology (ASP.NET, PHP, JBoss, e.g.) supporting the web application (version details are often in X-Runtime, X-Version, or X-AspNet-Version)"}],"cookie":[],"responseTime":null,"body":"{\r\n \"status\":400,\r\n \"error\":{\r\n \"message\":\"not found\",\r\n \"summary\":\"invalid security code\"\r\n }\r\n}"}],"_postman_id":"70d11943-953f-481a-85fa-48315e04c5db"},{"name":"Activate","id":"6e52f775-af57-4e47-98fa-ae588b56f09e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"activation_code\":\"3296d2b7d11cdb32ed107da4042fe16b348c6a1a\"\n}"},"url":"https://YOUR-CAPTURE-DOMAIN/api/contact/activate","description":"Activate a user account using the activation code from a successful user registration
\n","urlObject":{"protocol":"https","path":["api","contact","activate"],"host":["YOUR-CAPTURE-DOMAIN"],"query":[],"variable":[]}},"response":[],"_postman_id":"6e52f775-af57-4e47-98fa-ae588b56f09e"},{"name":"Register user - sponsor","event":[{"listen":"test","script":{"id":"c64da568-3820-42ad-9330-ccb29a869f71","exec":[""],"type":"text/javascript"}}],"id":"f7b1c0dc-1626-4b69-86e9-fd3ea624aaf0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"first_name\":\"John\",\n \"last_name\":\"Smith\",\n \"email\":\"john.smith@example.com\",\n \"password\":\"ExamplePassword123\",\n \"idlanguage\":1,\n \"self_employed\":1,\n \"country\":222,\n \"sponsor_email\":\"authorised.user@example.com\"\n}"},"url":"https://YOUR-CAPTURE-DOMAIN/api/contact","description":"Create a new contact when sponsored registration is enabled.
\nSponsored registration requires an extra parameter sponsor_email to be passed. This must be the email of a defined user in the system. The sponsor will receive an activation email for the new user, and it is the sponsor who must approve and activate the users account
Under review, update to follow
\n","urlObject":{"protocol":"https","path":["api","sponsor","peek"],"host":["YOUR-CAPTURE-DOMAIN"],"query":[{"key":"email","value":"user@example.com"}],"variable":[]}},"response":[{"id":"d5451ffa-fae8-4853-81da-95dfa4d78df0","name":"sponsor options","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://YOUR-CAPTURE-DOMAIN/api/sponsor/peek?email=user@example.com","protocol":"https","host":["YOUR-CAPTURE-DOMAIN"],"path":["api","sponsor","peek"],"query":[{"key":"email","value":"user@example.com"}]}},"status":"No Content","code":204,"_postman_previewlanguage":"html","header":[{"key":"Access-Control-Allow-Origin","value":"","name":"Access-Control-Allow-Origin","description":"Specifies a URI that may access the resource. For requests without credentials, the server may specify '*' as a wildcard, thereby allowing any origin to access the resource."},{"key":"Connection","value":"Upgrade, Keep-Alive","name":"Connection","description":"Options that are desired for the connection"},{"key":"Content-Language","value":"en","name":"Content-Language","description":"The language the content is in"},{"key":"Content-Type","value":"text/html; charset=UTF-8","name":"Content-Type","description":"The mime type of this content"},{"key":"Date","value":"Fri, 11 May 2018 13:36:52 GMT","name":"Date","description":"The date and time that the message was sent"},{"key":"Keep-Alive","value":"timeout=5, max=100","name":"Keep-Alive","description":"Custom header"},{"key":"Server","value":"Apache","name":"Server","description":"A name for the server"},{"key":"Upgrade","value":"h2,h2c","name":"Upgrade","description":"Custom header"},{"key":"X-Powered-By","value":"capture API","name":"X-Powered-By","description":"Specifies the technology (ASP.NET, PHP, JBoss, e.g.) supporting the web application (version details are often in X-Runtime, X-Version, or X-AspNet-Version)"}],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"1118abb7-3656-46fc-9b47-74faca4c210a"},{"name":"Sponsor activate","id":"8b01d8ed-e09b-4e4d-b11c-06ea816477a2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"activation_code\":\"3296d2b7d11cdb32ed107da4042fe16b348c6a1a\"\n}"},"url":"{{capture_api_url}}/api/sponsor/activate","description":"** API call** : Sponsor Activate an API endpoint
\nUse Case : Activate a user account from a passed security code (effectively unsets the is_disabled flag). this is for sponsor activation
\n","urlObject":{"path":["api","sponsor","activate"],"host":["{{capture_api_url}}"],"query":[],"variable":[]}},"response":[{"id":"80518633-4be6-4caf-9eb2-279cd553cd2f","name":"sponsor activate","originalRequest":{"method":"PATCH","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"activation_code\":\"3296d2b7d11cdb32ed107da4042fe16b348c6a1a\"\n}"},"url":"{{cw3_api_url}}/api/sponsor/activate"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Origin","value":"","name":"Access-Control-Allow-Origin","description":"Specifies a URI that may access the resource. For requests without credentials, the server may specify '*' as a wildcard, thereby allowing any origin to access the resource."},{"key":"Connection","value":"Upgrade, close","name":"Connection","description":"Options that are desired for the connection"},{"key":"Content-Language","value":"en","name":"Content-Language","description":"The language the content is in"},{"key":"Content-Type","value":"application/json; charset=UTF-8","name":"Content-Type","description":"The mime type of this content"},{"key":"Date","value":"Fri, 04 May 2018 14:09:26 GMT","name":"Date","description":"The date and time that the message was sent"},{"key":"Server","value":"Apache","name":"Server","description":"A name for the server"},{"key":"Transfer-Encoding","value":"chunked","name":"Transfer-Encoding","description":"The form of encoding used to safely transfer the entity to the user. Currently defined methods are: chunked, compress, deflate, gzip, identity."},{"key":"Upgrade","value":"h2,h2c","name":"Upgrade","description":"Custom header"},{"key":"X-Powered-By","value":"capture API","name":"X-Powered-By","description":"Specifies the technology (ASP.NET, PHP, JBoss, e.g.) supporting the web application (version details are often in X-Runtime, X-Version, or X-AspNet-Version)"}],"cookie":[],"responseTime":null,"body":"{\"status\":400,\"error\":{\"message\":\"not found\",\"summary\":\"invalid activation security code\"}}"}],"_postman_id":"8b01d8ed-e09b-4e4d-b11c-06ea816477a2"}],"id":"e810982a-4b1c-432c-bb15-7d1c717c2943","description":"All users within the capture system are part of capture CRM. This section allows you to use those contacts for registration, updates and password management.
\nDepending on the contact type in the capture CRM will depend on the permissions they have over the API. This can be changed from the COO CRM page.
\n","event":[{"listen":"prerequest","script":{"id":"ec637792-86b4-4011-bf16-65b8a1fdde79","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"680a3c7e-1bdd-4b58-9447-c4bcfd6659ec","type":"text/javascript","exec":[""]}}],"_postman_id":"e810982a-4b1c-432c-bb15-7d1c717c2943"},{"name":"Assets","item":[{"name":"Getting the asset preview","event":[{"listen":"prerequest","script":{"id":"aa71ae61-c9fd-4f79-934b-38e0699df3cb","exec":["pm.sendRequest({"," url: pm.environment.get(\"cw3_api_url\") + \"/api/oauth/access_token\", "," method: 'POST',"," header: {"," 'Accept': 'application/json',"," 'Content-Type': 'application/x-www-form-urlencoded',"," 'Authorization': 'Basic Abcdefghijk=='"," },"," body: {"," mode: 'urlencoded',"," urlencoded: ["," {key: \"grant_type\", value: \"password\", disabled: false},"," {key: \"username\", value: pm.environment.get(\"email\"), disabled: false},"," {key: \"password\", value: pm.environment.get(\"password\"), disabled: false},"," {key: \"client_id\", value: pm.environment.get(\"client_id\"), disabled: false},"," {key: \"client_secret\", value: pm.environment.get(\"client_secret\"), disabled: false}"," ]"," }"," }, function (err, res) {"," pm.environment.set(\"access_token_capture\", res.json().access_token);"," });"],"type":"text/javascript","packages":{},"requests":{}}},{"listen":"test","script":{"id":"08e2a7d9-252f-4466-b7fb-851fa5deffde","exec":["","// Data Access token Status -> OK","pm.test(\"Ouath Extend Request \", function () {"," var jsonData = pm.response.json();"," pm.expect(jsonData.status).to.eql(200);","});","","// Response in data Asset Summary idasset-> OK","pm.test(\"General response for Data Asset Summary idasset \", function () {"," var jsonData = pm.response.json();"," pm.response.to.have.jsonBody(\"data.asset.summary.idasset\");","});","","","// Response in data Asset Summary idusers-> OK","pm.test(\"General response for Data Asset Summary idusers \", function () {"," var jsonData = pm.response.json();"," pm.response.to.have.jsonBody(\"data.asset.summary.idusers\");","});","","","// Response in data Asset Summary org_filename-> OK","pm.test(\"General response for Data Asset Summary org_filename \", function () {"," var jsonData = pm.response.json();"," pm.response.to.have.jsonBody(\"data.asset.summary.org_filename\");","});","","","// Response in data Asset Summary filesize-> OK","pm.test(\"General response for Data Asset Summary filesize \", function () {"," var jsonData = pm.response.json();"," pm.response.to.have.jsonBody(\"data.asset.summary.filesize\");","});","","// Response in data Asset Summary filesize-> OK","pm.test(\"General response for Data Asset Summary height \", function () {"," var jsonData = pm.response.json();"," pm.response.to.have.jsonBody(\"data.asset.summary.height\");","});","","// Response in data Asset Summary width-> OK","pm.test(\"General response for Data Asset Summary width \", function () {"," var jsonData = pm.response.json();"," pm.response.to.have.jsonBody(\"data.asset.summary.width\");","});","","// Response in data Asset Summary batchname-> OK","pm.test(\"General response for Data Asset Summary batchname \", function () {"," var jsonData = pm.response.json();"," pm.response.to.have.jsonBody(\"data.asset.summary.batchname\");","});","","// Response in data Asset Summary upload_date-> OK","pm.test(\"General response for Data Asset Summary upload_date \", function () {"," var jsonData = pm.response.json();"," pm.response.to.have.jsonBody(\"data.asset.summary.upload_date\");","});","","// Response in data Asset Summary externalid1-> OK","pm.test(\"General response for Data Asset Summary externalid1 \", function () {"," var jsonData = pm.response.json();"," pm.response.to.have.jsonBody(\"data.asset.summary.externalid1\");","});","","// Response in data Asset Summary call_me_price-> OK","pm.test(\"General response for Data Asset Summary call_me_price \", function () {"," var jsonData = pm.response.json();"," pm.response.to.have.jsonBody(\"data.asset.summary.call_me_price\");","});","","","// Response in data Asset Summary publishing_date-> OK","pm.test(\"General response for Data Asset Summary publishing_date \", function () {"," var jsonData = pm.response.json();"," pm.response.to.have.jsonBody(\"data.asset.summary.publishing_date\");","});","","// Response in data Asset Summary mime_type-> OK","pm.test(\"General response for Data Asset Summary mime_type\", function () {"," var jsonData = pm.response.json();"," pm.response.to.have.jsonBody(\"data.asset.summary.mime_type\");","});","","// Response in data Asset Summary exif_datetimeoriginal-> OK","pm.test(\"General response for Data Asset Summary exif_datetimeoriginal\", function () {"," var jsonData = pm.response.json();"," pm.response.to.have.jsonBody(\"data.asset.summary.exif_datetimeoriginal\");","});","","// Response in data Asset Summary exclusive_code-> OK","pm.test(\"General response for Data Asset Summary exclusive_code\", function () {"," var jsonData = pm.response.json();"," pm.response.to.have.jsonBody(\"data.asset.summary.exclusive_code\");","});","","// Response in data Asset metadata md60 label-> OK","pm.test(\"General response for Data Asset metadata md60 label\", function () {"," var jsonData = pm.response.json();"," pm.response.to.have.jsonBody(\"data.asset.metadata.md60.label\");","});","","// Response in data Asset metadata md60 value-> OK","pm.test(\"General response for Data Asset metadata md60 value\", function () {"," var jsonData = pm.response.json();"," pm.response.to.have.jsonBody(\"data.asset.metadata.md60.value\");","});","","// Response in data Asset metadata md60 value-> OK","pm.test(\"General response for Data Asset metadata md60 value\", function () {"," var jsonData = pm.response.json();"," pm.response.to.have.jsonBody(\"data.asset.metadata.md60.value\");","});","","// Response in data Asset metadata md60 notes-> OK","pm.test(\"General response for Data Asset metadata md60 notes\", function () {"," var jsonData = pm.response.json();"," pm.response.to.have.jsonBody(\"data.asset.metadata.md60.notes\");","});","","// Response in data Asset review exists-> OK","pm.test(\"General response for Data Asset preview exists\", function () {"," var jsonData = pm.response.json();"," pm.response.to.have.jsonBody(\"data.asset.preview.exists\");","});","","// Response in data Asset preview mimetype-> OK","pm.test(\"General response for Data Asset preview mimetype\", function () {"," var jsonData = pm.response.json();"," pm.response.to.have.jsonBody(\"data.asset.preview.mimetype\");","});","","// Response in data Asset preview url-> OK","pm.test(\"General response for Data Asset preview url\", function () {"," var jsonData = pm.response.json();"," pm.response.to.have.jsonBody(\"data.asset.preview.url\");","});","","","","// Catching the error message and display the status ","","pm.test(\"General response Status(500)\", function () {"," pm.response.to.be.ok; //HTTP 500","})","","pm.test(\"General error response\", function () {"," pm.response.to.not.have.jsonBody(\"error\"); ","});","","pm.test(\"General error response with the message\", function () {"," pm.response.to.not.have.jsonBody(\"error.message\"); ","});","","pm.test(\"showing the summary response \", function () {"," pm.response.to.not.have.jsonBody(\"error.summary\"); ","});","","","//The Below test should be in ALL API calls as it is a general test. Response time may need tweaking for some queries.","pm.test(\"General response (Response Time)\", function () {"," pm.expect(pm.response.responseTime).to.be.below(2619); //Quicker than 150ms","});",""],"type":"text/javascript","packages":{},"requests":{}}}],"id":"ecdbdcb6-8c23-42c0-a613-36ca5f7081f2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{access_key_user}}"},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"{{cw3_api_url}}/api/asset/{{asset_id}}/preview","description":"fetch asset preview. preview images are generally 1024 pixels along the longest edge, however this can be changed on a per site basis
\nUse Case: When the API is called by passing with the ID asset followed by an access token on URL, it will return all assets and summary of assets from the database which belongs to the users current log.
\nUse Case: 200 OK
\n","urlObject":{"path":["api","asset","{{asset_id}}","preview"],"host":["{{cw3_api_url}}"],"query":[],"variable":[]}},"response":[{"id":"472e47de-9381-43c0-97ff-7e81a5d1f3b4","name":"Getting the asset preview","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"{{access_key_user}}","type":"text"}],"url":"{{cw3_api_url}}/api/asset/468000/preview"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Origin","value":"","description":"Specifies a URI that may access the resource. For requests without credentials, the server may specify '*' as a wildcard, thereby allowing any origin to access the resource."},{"key":"Connection","value":"Keep-Alive","description":"Options that are desired for the connection"},{"key":"Content-Encoding","value":"gzip","description":"The type of encoding used on the data."},{"key":"Content-Language","value":"en","description":"The language the content is in"},{"key":"Content-Length","value":"1252","description":"The length of the response body in octets (8-bit bytes)"},{"key":"Content-Type","value":"application/json; charset=UTF-8","description":"The mime type of this content"},{"key":"Date","value":"Tue, 08 May 2018 14:53:24 GMT","description":"The date and time that the message was sent"},{"key":"Keep-Alive","value":"timeout=5, max=99","description":"Custom header"},{"key":"Server","value":"Apache","description":"A name for the server"},{"key":"Vary","value":"Accept-Encoding","description":"Tells downstream proxies how to match future request headers to decide whether the cached response can be used rather than requesting a fresh one from the origin server."},{"key":"X-Powered-By","value":"capture API","description":"Specifies the technology (ASP.NET, PHP, JBoss, e.g.) supporting the web application (version details are often in X-Runtime, X-Version, or X-AspNet-Version)"}],"cookie":[],"responseTime":null,"body":"{\"status\":200,\"data\":{\"asset\":{\"summary\":{\"idasset\":\"468000\",\"idusers\":\"47\",\"org_filename\":\"Rio 2016 Structured Interview Transcript - Ernesto Gubert.pdf\",\"filesize\":\"167401\",\"height\":\"0\",\"width\":\"0\",\"batchname\":\"Role Batch\",\"upload_date\":\"2018-05-03 11:37:25\",\"externalid1\":\"Rio 2016 Structured Interview Transcript - Ernesto Gubert\",\"call_me_price\":\"0\",\"publishing_date\":\"2018-05-03 11:37:29\",\"mime_type\":\"application\\/pdf\",\"exif_datetimeoriginal\":null,\"exclusive_code\":\"0\"},\"metadata\":{\"md60\":{\"label\":\"Question\",\"notes\":\"\",\"value\":\"What is your name, organisation and role supporting the Rio 2016 Olympic and Paralympic Games? How long have you worked on the Games?\"},\"md61\":{\"label\":\"Short question\",\"notes\":\"\",\"value\":\"What is your name, organisation and role?\"},\"md62\":{\"label\":\"Phase name\",\"notes\":\"\",\"value\":\"Games-time (G-8 to G+1)\"},\"md63\":{\"label\":\"FA Name\",\"notes\":\"\",\"value\":\"Accommodation\"},\"md64\":{\"label\":\"Interview date\",\"notes\":\"\",\"value\":\"13-Sep-2016\"},\"md65\":{\"label\":\"Interviewee name\",\"notes\":\"\",\"value\":\"Ernesto Gubert\"},\"md2\":{\"label\":\"Description\",\"notes\":\"IPTC 120 - Capture, Abstract, Description\",\"value\":\"\"},\"md1\":{\"label\":\"Subject\",\"notes\":\"IPTC 105 - Headline\",\"value\":\"\"},\"md4\":{\"label\":\"Date created\",\"notes\":\"IPTC 55 - Date Created\",\"value\":\"\"},\"md5\":{\"label\":\"City\",\"notes\":\"IPTC 90 - City\",\"value\":\"\"},\"md6\":{\"label\":\"Province\\/State\",\"notes\":\"IPTC 95 - State\\/Province\",\"value\":\"\"},\"md7\":{\"label\":\"Country\",\"notes\":\"IPTC 101 - Country\",\"value\":\"\"},\"md8\":{\"label\":\"Instructions\",\"notes\":\"IPTC 40 - Special instructions\",\"value\":\"\"},\"md9\":{\"label\":\"Creator\",\"notes\":\"IPTC 80 - Author, Creator, Byline. Can also tie in with account screen in CRM.\",\"value\":\"CN\"},\"md10\":{\"label\":\"Credit\",\"notes\":\"IPTC 110 - Credit, Provider. Enter who should be credited when this image is published.\",\"value\":\"\"},\"md11\":{\"label\":\"Asset reference\",\"notes\":\"IPTC 05 - Object Name, Title, Document Title. This is intended to be a numeric reference to the asset, not descriptive like Headline.\",\"value\":\"\"},\"md12\":{\"label\":\"Ethnicity\",\"notes\":\"Particularly useful for publishers.\",\"value\":\"\"},\"md18\":{\"label\":\"Licence type\",\"notes\":\"Relates to control field RD4 - Licence type\",\"value\":\"Wholly owned\"},\"md22\":{\"label\":\"Rights allowed\",\"notes\":\"Free text field for further details of how an asset can be used.\",\"value\":\"\"},\"md23\":{\"label\":\"Rights restrictions\",\"notes\":\"Used as an alert field - to flag up any restrictions. A value in this field causes the red hand alert icon to appear in Browse & search.\",\"value\":\"\"},\"md19\":{\"label\":\"Release status\",\"notes\":\"\",\"value\":\"\"},\"md20\":{\"label\":\"Release filenames\",\"notes\":\"List of release document files.\",\"value\":\"\"},\"md68\":{\"label\":\"Storage Location\",\"notes\":\"\",\"value\":\"\"},\"md16\":{\"label\":\"Original purpose\\/publication\",\"notes\":\"Particularly useful for publishers.\",\"value\":\"\"},\"md17\":{\"label\":\"Original ISBN\",\"notes\":\"Particularly useful for publishers.\",\"value\":\"\"}},\"preview\":{\"exists\":true,\"mimetype\":\"application\\/octet-stream\",\"url\":\"https:\\/\\/olympic-vh.akamaihd.net\\/i\\/OGKM\\/Rio2016Interviews\\/ErnestoGubert\\/Q1_2.mp4\\/master.m3u8\"}}}}"}],"_postman_id":"ecdbdcb6-8c23-42c0-a613-36ca5f7081f2"},{"name":"Getting sharing token","event":[{"listen":"prerequest","script":{"id":"652ddc77-b6b5-4a4a-97ff-c844e27e5b51","exec":["pm.sendRequest({"," url: pm.environment.get(\"cw3_api_url\") + \"/api/oauth/access_token\", "," method: 'POST',"," header: {"," 'Accept': 'application/json',"," 'Content-Type': 'application/x-www-form-urlencoded',"," 'Authorization': 'Basic Abcdefghijk=='"," },"," body: {"," mode: 'urlencoded',"," urlencoded: ["," {key: \"grant_type\", value: \"password\", disabled: false},"," {key: \"username\", value: pm.environment.get(\"email\"), disabled: false},"," {key: \"password\", value: pm.environment.get(\"password\"), disabled: false},"," {key: \"client_id\", value: pm.environment.get(\"client_id\"), disabled: false},"," {key: \"client_secret\", value: pm.environment.get(\"client_secret\"), disabled: false}"," ]"," }"," }, function (err, res) {"," pm.environment.set(\"access_token_capture\", res.json().access_token);"," });"],"type":"text/javascript","packages":{},"requests":{}}},{"listen":"test","script":{"id":"a6e536e2-6925-4f45-b8cd-6292ba59a74e","exec":["","// Data Access token Status -> OK","pm.test(\"Ouath Extend Request \", function () {"," var jsonData = pm.response.json();"," pm.expect(jsonData.status).to.eql(200);","});","","//Getting data share_token-> OK","pm.test(\"General response for Data share_token \", function () {"," pm.response.to.have.jsonBody(\"data.share_token\");","});","","","//Getting data asset_id-> OK","pm.test(\"General response for Data share_token \", function () {"," pm.response.to.have.jsonBody(\"data.asset_id\");","});","","//Catching the error message and display the status ","","pm.test(\"General response Status(500)\", function () {"," pm.response.to.be.ok; //HTTP 500","})","","pm.test(\"General error response\", function () {"," pm.response.to.not.have.jsonBody(\"error\"); ","});","","//General error response with the message","pm.test(\"General error response with the message\", function () {"," pm.response.to.not.have.jsonBody(\"error.message\"); ","});","","pm.test(\"showing the summary response \", function () {"," pm.response.to.not.have.jsonBody(\"error.summary\"); ","});","","","//The Below test should be in ALL API calls as it is a general test. Response time may need tweaking for some queries.","pm.test(\"General response (Response Time)\", function () {"," pm.expect(pm.response.responseTime).to.be.below( 9828); //Quicker than 150ms","});","",""],"type":"text/javascript","packages":{},"requests":{}}}],"id":"865873fc-6ab5-421c-a6bf-94443cf159b1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{access_key_user}}"},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"{{cw3_api_url}}/api/asset/{{asset_id}}/shared","description":"Test: Get the shared token API call endpoint
\nUse Case : When the API is called by passing the assett ID with a shared token, followed by an access token in the params, it will return the share token.
\nResponse Status: 200 OK
\n","urlObject":{"path":["api","asset","{{asset_id}}","shared"],"host":["{{cw3_api_url}}"],"query":[],"variable":[]}},"response":[{"id":"8313bd7c-9b2b-41b5-805e-9fb19dd3c5c5","name":"Getting sharing token","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"X-Api-Key","value":"{{access_key_user}}","type":"text"}],"url":"{{cw3_api_url}}/api/asset/{{asset_id}}/shared"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Origin","value":"","description":"Specifies a URI that may access the resource. For requests without credentials, the server may specify '*' as a wildcard, thereby allowing any origin to access the resource."},{"key":"Connection","value":"Keep-Alive","description":"Options that are desired for the connection"},{"key":"Content-Encoding","value":"gzip","description":"The type of encoding used on the data."},{"key":"Content-Language","value":"en","description":"The language the content is in"},{"key":"Content-Length","value":"106","description":"The length of the response body in octets (8-bit bytes)"},{"key":"Content-Type","value":"application/json; charset=UTF-8","description":"The mime type of this content"},{"key":"Date","value":"Wed, 09 May 2018 10:18:44 GMT","description":"The date and time that the message was sent"},{"key":"Keep-Alive","value":"timeout=5, max=99","description":"Custom header"},{"key":"Server","value":"Apache","description":"A name for the server"},{"key":"Vary","value":"Accept-Encoding","description":"Tells downstream proxies how to match future request headers to decide whether the cached response can be used rather than requesting a fresh one from the origin server."},{"key":"X-Powered-By","value":"capture API","description":"Specifies the technology (ASP.NET, PHP, JBoss, e.g.) supporting the web application (version details are often in X-Runtime, X-Version, or X-AspNet-Version)"}],"cookie":[],"responseTime":null,"body":"{\"status\":200,\"data\":{\"share_token\":\"d3a6857b9d8011e7aceed6d413fe4b726483c06e\",\"asset_id\":468000}}"}],"_postman_id":"865873fc-6ab5-421c-a6bf-94443cf159b1"},{"name":"Getting shared asset preview","event":[{"listen":"prerequest","script":{"id":"bbc9e846-8f8e-4c25-8aee-aadf5f72289c","type":"text/javascript","exec":["pm.sendRequest({"," url: pm.environment.get(\"cw3_api_url\") + \"/api/oauth/access_token\", "," method: 'POST',"," header: {"," 'Accept': 'application/json',"," 'Content-Type': 'application/x-www-form-urlencoded',"," 'Authorization': 'Basic Abcdefghijk=='"," },"," body: {"," mode: 'urlencoded',"," urlencoded: ["," {key: \"grant_type\", value: \"password\", disabled: false},"," {key: \"username\", value: pm.environment.get(\"email\"), disabled: false},"," {key: \"password\", value: pm.environment.get(\"password\"), disabled: false},"," {key: \"client_id\", value: pm.environment.get(\"client_id\"), disabled: false},"," {key: \"client_secret\", value: pm.environment.get(\"client_secret\"), disabled: false}"," ]"," }"," }, function (err, res) {"," pm.environment.set(\"access_token_capture\", res.json().access_token);"," });"]}},{"listen":"test","script":{"id":"1fee5667-1c0a-42fe-9b83-510fcc61af0d","type":"text/javascript","exec":["","// Data Access token Status -> OK","pm.test(\"Ouath Extend Request \", function () {"," var jsonData = pm.response.json();"," pm.expect(jsonData.status).to.eql(200);","});","","//Getting data Asset Summary idasset-> OK","pm.test(\"General response for Data Asset Summary idasset \", function () {"," pm.response.to.have.jsonBody(\"data.asset.summary.idasset\");","});","","","//Getting data Asset Summary idusers-> OK","pm.test(\"General response for Data Asset Summary idusers \", function () {"," pm.response.to.have.jsonBody(\"data.asset.summary.idusers\");","});","","//Getting data Asset Summary org_filename-> OK","pm.test(\"General response for Data Asset Summary org_filename \", function () {"," pm.response.to.have.jsonBody(\"data.asset.summary.org_filename\");","});","","//Getting data Asset Summary filesize-> OK","pm.test(\"General response for Data Asset Summary filesize \", function () {"," pm.response.to.have.jsonBody(\"data.asset.summary.filesize\");","});","","//Getting data Asset Summary height-> OK","pm.test(\"General response for Data Asset Summary height \", function () {"," pm.response.to.have.jsonBody(\"data.asset.summary.height\");","});","","//Getting data Asset Summary width-> OK","pm.test(\"General response for Data Asset Summary width \", function () {"," pm.response.to.have.jsonBody(\"data.asset.summary.width\");","});","","","//Getting data Asset Summary batchname-> OK","pm.test(\"General response for Data Asset Summary batchname \", function () {"," pm.response.to.have.jsonBody(\"data.asset.summary.batchname\");","});","","//Getting data Asset Summary upload_date-> OK","pm.test(\"General response for Data Asset Summary upload_date \", function () {"," pm.response.to.have.jsonBody(\"data.asset.summary.upload_date\");","});","","//Getting data Asset Summary externalid1-> OK","pm.test(\"General response for Data Asset Summary externalid1 \", function () {"," pm.response.to.have.jsonBody(\"data.asset.summary.externalid1\");","});","","//Getting data Asset Summary call_me_price-> OK","pm.test(\"General response for Data Asset Summary call_me_price \", function () {"," pm.response.to.have.jsonBody(\"data.asset.summary.call_me_price\");","});","","//Getting data Asset Summary publishing_date-> OK","pm.test(\"General response for Data Asset Summary publishing_date \", function () {"," pm.response.to.have.jsonBody(\"data.asset.summary.publishing_date\");","});","","//Getting data Asset Summary mime_type-> OK","pm.test(\"General response for Data Asset Summary mime_type \", function () {"," pm.response.to.have.jsonBody(\"data.asset.summary.mime_type\");","});","","","//Getting data Asset Summary mime_type-> OK","pm.test(\"General response for Data Asset Summary exif_datetimeoriginal \", function () {"," pm.response.to.have.jsonBody(\"data.asset.summary.exif_datetimeoriginal\");","});","","//Getting data Asset Summary exclusive_code-> OK","pm.test(\"General response for Data Asset Summary exclusive_code\", function () {"," pm.response.to.have.jsonBody(\"data.asset.summary.exclusive_code\");","});","","","//Getting data Asset Metadata md60 label-> OK","pm.test(\"General response for Data Asset Metadata md60 label\", function () {"," pm.response.to.have.jsonBody(\"data.asset.metadata.md60.label\");","});","","//Getting data Asset Metadata md60 notes-> OK","pm.test(\"General response for Data Asset Metadata md60 notes\", function () {"," pm.response.to.have.jsonBody(\"data.asset.metadata.md60.notes\");","});","","//Getting data Asset Metadata md60 value-> OK","pm.test(\"General response for Data Asset Metadata md60 value\", function () {"," pm.response.to.have.jsonBody(\"data.asset.metadata.md60.value\");","});","","//Getting data Asset Metadata md60 value-> OK","pm.test(\"General response for Data Asset Metadata md60 value\", function () {"," pm.response.to.have.jsonBody(\"data.asset.metadata.md60.value\");","});","","","//Getting data Asset Preview exist-> OK","pm.test(\"General response for Data Asset Preview exists\", function () {"," pm.response.to.have.jsonBody(\"data.asset.preview.exists\");","});","","//Getting data Asset Preview mimetype-> OK","pm.test(\"General response for Data Asset Preview mimetype\", function () {"," pm.response.to.have.jsonBody(\"data.asset.preview.mimetype\");","});","","//Getting data Asset Preview URL-> OK","pm.test(\"General response for Data Asset Preview mimetype\", function () {"," pm.response.to.have.jsonBody(\"data.asset.preview.url\");","});","","","// Catching the error message and display the status ","","pm.test(\"General response Status(500)\", function () {"," pm.response.to.be.ok; //HTTP 500","})","","pm.test(\"General error response\", function () {"," pm.response.to.not.have.jsonBody(\"error\"); ","});","","pm.test(\"General error response with the message\", function () {"," pm.response.to.not.have.jsonBody(\"error.message\"); ","});","","pm.test(\"showing the summary response \", function () {"," pm.response.to.not.have.jsonBody(\"error.summary\"); ","});","","","//The Below test should be in ALL API calls as it is a general test. Response time may need tweaking for some queries.","pm.test(\"General response (Response Time)\", function () {"," pm.expect(pm.response.responseTime).to.be.below(2619); //Quicker than 150ms","});",""]}}],"id":"24aa225e-9f45-464e-8eb1-aababbf8510f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"{{cw3_api_url}}/api/asset/2b8a159a8d636471dc56eb4a66ca4c426f7be9fd/preview","description":"Test: Get shared asset preview
\nUse Case : The API is called to enable the view of shared asset preview. A user will have to generate the share token call before accessing the endpoint.After passing the share token the API will return the asset and the summary of the object.\n-Remember to pass in 40char hex token from the 'get sharing' token call.
\nResponse Status : 200 ok
\n","urlObject":{"path":["api","asset","2b8a159a8d636471dc56eb4a66ca4c426f7be9fd","preview"],"host":["{{cw3_api_url}}"],"query":[{"disabled":true,"key":"share_token","value":"57c2017e52eed3bb66d29f4e6627a7a62097f0dc"}],"variable":[]}},"response":[{"id":"4a0b0ec5-f34f-40de-b234-f8d6c23202c7","name":"get shared asset preview","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"{{cw3_api_url}}/api/asset/2b8a159a8d636471dc56eb4a66ca4c426f7be9fd/preview","host":["{{cw3_api_url}}"],"path":["api","asset","2b8a159a8d636471dc56eb4a66ca4c426f7be9fd","preview"],"query":[{"key":"share_token","value":"2b8a159a8d636471dc56eb4a66ca4c426f7be9fd","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Origin","value":"","name":"Access-Control-Allow-Origin","description":"Specifies a URI that may access the resource. For requests without credentials, the server may specify '*' as a wildcard, thereby allowing any origin to access the resource."},{"key":"Connection","value":"Keep-Alive","name":"Connection","description":"Options that are desired for the connection"},{"key":"Content-Encoding","value":"gzip","name":"Content-Encoding","description":"The type of encoding used on the data."},{"key":"Content-Language","value":"en","name":"Content-Language","description":"The language the content is in"},{"key":"Content-Length","value":"1252","name":"Content-Length","description":"The length of the response body in octets (8-bit bytes)"},{"key":"Content-Type","value":"application/json; charset=UTF-8","name":"Content-Type","description":"The mime type of this content"},{"key":"Date","value":"Wed, 09 May 2018 08:33:24 GMT","name":"Date","description":"The date and time that the message was sent"},{"key":"Keep-Alive","value":"timeout=5, max=99","name":"Keep-Alive","description":"Custom header"},{"key":"Server","value":"Apache","name":"Server","description":"A name for the server"},{"key":"Vary","value":"Accept-Encoding","name":"Vary","description":"Tells downstream proxies how to match future request headers to decide whether the cached response can be used rather than requesting a fresh one from the origin server."},{"key":"X-Powered-By","value":"capture API","name":"X-Powered-By","description":"Specifies the technology (ASP.NET, PHP, JBoss, e.g.) supporting the web application (version details are often in X-Runtime, X-Version, or X-AspNet-Version)"}],"cookie":[],"responseTime":null,"body":"{\"status\":200,\"data\":{\"asset\":{\"summary\":{\"idasset\":\"468000\",\"idusers\":\"47\",\"org_filename\":\"Rio 2016 Structured Interview Transcript - Ernesto Gubert.pdf\",\"filesize\":\"167401\",\"height\":\"0\",\"width\":\"0\",\"batchname\":\"Role Batch\",\"upload_date\":\"2018-05-03 11:37:25\",\"externalid1\":\"Rio 2016 Structured Interview Transcript - Ernesto Gubert\",\"call_me_price\":\"0\",\"publishing_date\":\"2018-05-03 11:37:29\",\"mime_type\":\"application\\/pdf\",\"exif_datetimeoriginal\":null,\"exclusive_code\":\"0\"},\"metadata\":{\"md60\":{\"label\":\"Question\",\"notes\":\"\",\"value\":\"What is your name, organisation and role supporting the Rio 2016 Olympic and Paralympic Games? How long have you worked on the Games?\"},\"md61\":{\"label\":\"Short question\",\"notes\":\"\",\"value\":\"What is your name, organisation and role?\"},\"md62\":{\"label\":\"Phase name\",\"notes\":\"\",\"value\":\"Games-time (G-8 to G+1)\"},\"md63\":{\"label\":\"FA Name\",\"notes\":\"\",\"value\":\"Accommodation\"},\"md64\":{\"label\":\"Interview date\",\"notes\":\"\",\"value\":\"13-Sep-2016\"},\"md65\":{\"label\":\"Interviewee name\",\"notes\":\"\",\"value\":\"Ernesto Gubert\"},\"md2\":{\"label\":\"Description\",\"notes\":\"IPTC 120 - Capture, Abstract, Description\",\"value\":\"\"},\"md1\":{\"label\":\"Subject\",\"notes\":\"IPTC 105 - Headline\",\"value\":\"\"},\"md4\":{\"label\":\"Date created\",\"notes\":\"IPTC 55 - Date Created\",\"value\":\"\"},\"md5\":{\"label\":\"City\",\"notes\":\"IPTC 90 - City\",\"value\":\"\"},\"md6\":{\"label\":\"Province\\/State\",\"notes\":\"IPTC 95 - State\\/Province\",\"value\":\"\"},\"md7\":{\"label\":\"Country\",\"notes\":\"IPTC 101 - Country\",\"value\":\"\"},\"md8\":{\"label\":\"Instructions\",\"notes\":\"IPTC 40 - Special instructions\",\"value\":\"\"},\"md9\":{\"label\":\"Creator\",\"notes\":\"IPTC 80 - Author, Creator, Byline. Can also tie in with account screen in CRM.\",\"value\":\"CN\"},\"md10\":{\"label\":\"Credit\",\"notes\":\"IPTC 110 - Credit, Provider. Enter who should be credited when this image is published.\",\"value\":\"\"},\"md11\":{\"label\":\"Asset reference\",\"notes\":\"IPTC 05 - Object Name, Title, Document Title. This is intended to be a numeric reference to the asset, not descriptive like Headline.\",\"value\":\"\"},\"md12\":{\"label\":\"Ethnicity\",\"notes\":\"Particularly useful for publishers.\",\"value\":\"\"},\"md18\":{\"label\":\"Licence type\",\"notes\":\"Relates to control field RD4 - Licence type\",\"value\":\"Wholly owned\"},\"md22\":{\"label\":\"Rights allowed\",\"notes\":\"Free text field for further details of how an asset can be used.\",\"value\":\"\"},\"md23\":{\"label\":\"Rights restrictions\",\"notes\":\"Used as an alert field - to flag up any restrictions. A value in this field causes the red hand alert icon to appear in Browse & search.\",\"value\":\"\"},\"md19\":{\"label\":\"Release status\",\"notes\":\"\",\"value\":\"\"},\"md20\":{\"label\":\"Release filenames\",\"notes\":\"List of release document files.\",\"value\":\"\"},\"md68\":{\"label\":\"Storage Location\",\"notes\":\"\",\"value\":\"\"},\"md16\":{\"label\":\"Original purpose\\/publication\",\"notes\":\"Particularly useful for publishers.\",\"value\":\"\"},\"md17\":{\"label\":\"Original ISBN\",\"notes\":\"Particularly useful for publishers.\",\"value\":\"\"}},\"preview\":{\"exists\":true,\"mimetype\":\"application\\/octet-stream\",\"url\":\"https:\\/\\/olympic-vh.akamaihd.net\\/i\\/OGKM\\/Rio2016Interviews\\/ErnestoGubert\\/Q1_2.mp4\\/master.m3u8\"}}}}"}],"_postman_id":"24aa225e-9f45-464e-8eb1-aababbf8510f"},{"name":"download hires","event":[{"listen":"test","script":{"id":"e22bb08f-1485-494f-82ad-59d783cb5543","exec":["// Data Access token Status -> OK","pm.test(\"Ouath Extend Request \", function () {"," var jsonData = pm.response.json();"," pm.expect(jsonData.status).to.eql(200);","});","","//Getting data filename-> OK","pm.test(\"General response for Data filename \", function () {"," pm.response.to.have.jsonBody(\"data.filename\");","});","","//Getting data mime_type-> OK","pm.test(\"General response for Data mime_type \", function () {"," pm.response.to.have.jsonBody(\"data.mime_type\");","});","","//Getting data filesize-> OK","pm.test(\"General response for Data filesize \", function () {"," pm.response.to.have.jsonBody(\"data.filesize\");","});","","//Getting data url-> OK","pm.test(\"General response for Data url \", function () {"," pm.response.to.have.jsonBody(\"data.url\");","});","","","//Getting data order_id-> OK","pm.test(\"General response for Data order_id \", function () {"," pm.response.to.have.jsonBody(\"data.order_id\");","});","","","","","","","//Catching the error message and display the status ","","pm.test(\"General response Status(500)\", function () {"," pm.response.to.be.ok; //HTTP 500","})","","pm.test(\"General error response\", function () {"," pm.response.to.not.have.jsonBody(\"error\"); ","});","","//General error response with the message","pm.test(\"General error response with the message\", function () {"," pm.response.to.not.have.jsonBody(\"error.message\"); ","});","","pm.test(\"showing the summary response \", function () {"," pm.response.to.not.have.jsonBody(\"error.summary\"); ","});","","","//The Below test should be in ALL API calls as it is a general test. Response time may need tweaking for some queries.","pm.test(\"General response (Response Time)\", function () {"," pm.expect(pm.response.responseTime).to.be.below( 9828); //Quicker than 150ms","});",""],"type":"text/javascript","packages":{},"requests":{}}}],"id":"d60d2cd9-65c5-4865-9ce1-94a07e31f715","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{access_key_user}}"},"isInherited":false},"method":"POST","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"assets\":[\r\n {\r\n \"asset_id\":468000,\r\n \"usage\": {\r\n \"project_title\": \"test\"\r\n }\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"{{cw3_api_url}}/api/asset/download/direct","description":"Request a link to a downloadable file of the specified asset
\nThe API does not provide the file by pushing or initiating download using the http content-disposition method. Instead the download resquests to the API are to ask for a downloadable file or files to be prepared, and if successful the response will contain a URL to the downloadable file.
\nThis allows the client application use whatever means are appropriate to retrieve the file.
\nRequest data must be provided as JSON array called \"assets\". Each array item should also be an array containing one ot more of the following;
\nasset_id - required. integer value, the internal asset id.
\nusage - optional. array, values depend on the response from the download/peek call - the usage section in the response describes what (if any) information fields are required to be supplied per asset to allow download. As these are configurable by clients they will be different for every site. See download/options for details. Usage data array keys are the form_name field.
\n\n\nnote at time of writing there is a bug that means usage fields which are optional (have is_required: false) are still being required -so they must be passed. This bug is being addressed, and when rolled out this notice will be removed
\n
A successful response does not initiate a download or push the file towards the client (e.g. such as triggering browser download with content-disposition header).
\nInstead the URL to the downloadable file can be found in response.data.url
\n","urlObject":{"path":["api","asset","download","direct"],"host":["{{cw3_api_url}}"],"query":[],"variable":[]}},"response":[{"id":"3dcf9483-f14e-4c85-8552-2bb27e285b4b","name":"success","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"{{access_key_user}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"assets\":[\r\n {\r\n \"asset_id\":468000,\r\n \"usage\": {\r\n \"project_title\": \"test\"\r\n }\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"{{cw3_api_url}}/api/asset/download/direct"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Origin","value":"","description":"Specifies a URI that may access the resource. For requests without credentials, the server may specify '*' as a wildcard, thereby allowing any origin to access the resource."},{"key":"Connection","value":"Upgrade, Keep-Alive","description":"Options that are desired for the connection"},{"key":"Content-Encoding","value":"gzip","description":"The type of encoding used on the data."},{"key":"Content-Language","value":"en","description":"The language the content is in"},{"key":"Content-Length","value":"425","description":"The length of the response body in octets (8-bit bytes)"},{"key":"Content-Type","value":"application/json; charset=UTF-8","description":"The mime type of this content"},{"key":"Date","value":"Wed, 09 May 2018 09:13:03 GMT","description":"The date and time that the message was sent"},{"key":"Keep-Alive","value":"timeout=5, max=100","description":"Custom header"},{"key":"Server","value":"Apache","description":"A name for the server"},{"key":"Upgrade","value":"h2,h2c","description":"Custom header"},{"key":"Vary","value":"Accept-Encoding","description":"Tells downstream proxies how to match future request headers to decide whether the cached response can be used rather than requesting a fresh one from the origin server."},{"key":"X-Powered-By","value":"capture API","description":"Specifies the technology (ASP.NET, PHP, JBoss, e.g.) supporting the web application (version details are often in X-Runtime, X-Version, or X-AspNet-Version)"}],"cookie":[],"responseTime":null,"body":"{\r\n \"status\": 200,\r\n \"data\": {\r\n \"filename\": \"468000.jpg\",\r\n \"mime_type\": \"image/jpeg\",\r\n \"filesize\": 1379777,\r\n \"url\": \"https://demo.captureweb.net/ddl/2023-03-10/25/468000.jpg\",\r\n \"order_id\": \"1063\",\r\n \"debug\": {}\r\n }\r\n}"}],"_postman_id":"d60d2cd9-65c5-4865-9ce1-94a07e31f715"},{"name":"download lowres","event":[{"listen":"test","script":{"id":"e4c01203-cd2a-4ebf-9e96-8f10ed7ad0a0","exec":["","// Data Access token Status -> OK","pm.test(\"Ouath Extend Request \", function () {"," var jsonData = pm.response.json();"," pm.expect(jsonData.status).to.eql(200);","});","","//Getting data filename-> OK","pm.test(\"General response for Data filename\", function () {"," pm.response.to.have.jsonBody(\"data.filename\");","});","","//Getting data mime_type-> OK","pm.test(\"General response for Data mime_type\", function () {"," pm.response.to.have.jsonBody(\"data.mime_type\");","});","","//Getting data mime_type-> OK","pm.test(\"General response for Data mime_type\", function () {"," pm.response.to.have.jsonBody(\"data.mime_type\");","});","","//Getting data url-> OK","pm.test(\"General response for Data url\", function () {"," pm.response.to.have.jsonBody(\"data.url\");","});","","//Getting data order_id-> OK","pm.test(\"General response for Data order_id\", function () {"," pm.response.to.have.jsonBody(\"data.order_id\");","});","","//Catching the error message and display the status ","","pm.test(\"General response Status(500)\", function () {"," pm.response.to.be.ok; //HTTP 500","})","","pm.test(\"General error response\", function () {"," pm.response.to.not.have.jsonBody(\"error\"); ","});","","//General error response with the message","pm.test(\"General error response with the message\", function () {"," pm.response.to.not.have.jsonBody(\"error.message\"); ","});","","pm.test(\"showing the summary response \", function () {"," pm.response.to.not.have.jsonBody(\"error.summary\"); ","});","","","//The Below test should be in ALL API calls as it is a general test. Response time may need tweaking for some queries.","pm.test(\"General response (Response Time)\", function () {"," pm.expect(pm.response.responseTime).to.be.below(27896); //Quicker than 150ms","});"],"type":"text/javascript","packages":{},"requests":{}}},{"listen":"prerequest","script":{"id":"07063019-8d99-49f3-b8b0-03771addcaf6","exec":["pm.sendRequest({"," url: pm.environment.get(\"cw3_api_url\") + \"/api/oauth/access_token\", "," method: 'POST',"," header: {"," 'Accept': 'application/json',"," 'Content-Type': 'application/x-www-form-urlencoded',"," 'Authorization': 'Basic Abcdefghijk=='"," },"," body: {"," mode: 'urlencoded',"," urlencoded: ["," {key: \"grant_type\", value: \"password\", disabled: false},"," {key: \"username\", value: pm.environment.get(\"email\"), disabled: false},"," {key: \"password\", value: pm.environment.get(\"password\"), disabled: false},"," {key: \"client_id\", value: pm.environment.get(\"client_id\"), disabled: false},"," {key: \"client_secret\", value: pm.environment.get(\"client_secret\"), disabled: false}"," ]"," }"," }, function (err, res) {"," pm.environment.set(\"access_token_capture\", res.json().access_token);"," });"],"type":"text/javascript","packages":{},"requests":{}}}],"id":"9b33e5a6-72ac-4d44-9e73-dd80619b6470","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{access_key_user}}"},"isInherited":false},"method":"POST","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"assets\":[\r\n {\r\n \"asset_id\":468000\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"{{cw3_api_url}}/api/asset/download/comp","description":"Documentation being revised. Please try again Monday 13th March
\n","urlObject":{"path":["api","asset","download","comp"],"host":["{{cw3_api_url}}"],"query":[],"variable":[]}},"response":[{"id":"17f7f3da-8f89-4e20-8a96-1823f2e19bb9","name":"success","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"{{access_key_user}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"assets\":[\r\n {\r\n \"asset_id\":468000,\r\n \"usage\": {\r\n \"project_title\": \"test\"\r\n }\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"{{cw3_api_url}}/api/asset/download/comp"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Origin","value":"","description":"Specifies a URI that may access the resource. For requests without credentials, the server may specify '*' as a wildcard, thereby allowing any origin to access the resource."},{"key":"Connection","value":"Upgrade, Keep-Alive","description":"Options that are desired for the connection"},{"key":"Content-Encoding","value":"gzip","description":"The type of encoding used on the data."},{"key":"Content-Language","value":"en","description":"The language the content is in"},{"key":"Content-Length","value":"496","description":"The length of the response body in octets (8-bit bytes)"},{"key":"Content-Type","value":"application/json; charset=UTF-8","description":"The mime type of this content"},{"key":"Date","value":"Wed, 09 May 2018 10:33:42 GMT","description":"The date and time that the message was sent"},{"key":"Keep-Alive","value":"timeout=5, max=100","description":"Custom header"},{"key":"Server","value":"Apache","description":"A name for the server"},{"key":"Upgrade","value":"h2,h2c","description":"Custom header"},{"key":"Vary","value":"Accept-Encoding","description":"Tells downstream proxies how to match future request headers to decide whether the cached response can be used rather than requesting a fresh one from the origin server."},{"key":"X-Powered-By","value":"capture API","description":"Specifies the technology (ASP.NET, PHP, JBoss, e.g.) supporting the web application (version details are often in X-Runtime, X-Version, or X-AspNet-Version)"}],"cookie":[],"responseTime":null,"body":"{\r\n \"status\": 200,\r\n \"data\": {\r\n \"filename\": \"100111964.jpg\",\r\n \"mime_type\": \"image/jpeg\",\r\n \"filesize\": 33958,\r\n \"url\": \"https://lehtikuva.uat.captureweb.net/ddl/2023-03-10/25/100111964.jpg\",\r\n \"order_id\": \"1064\",\r\n \"debug\": {}\r\n }\r\n}"}],"_postman_id":"9b33e5a6-72ac-4d44-9e73-dd80619b6470"},{"name":"download as zip/pptx/odp/pdf","event":[{"listen":"test","script":{"id":"6b4b6703-8cad-4545-bb9c-0d3e52bd3ddd","exec":["// Data Access token Status -> OK","pm.test(\"Ouath Extend Request \", function () {"," var jsonData = pm.response.json();"," pm.expect(jsonData.status).to.eql(200);","});","","//Getting data filename-> OK","pm.test(\"General response for Data filename \", function () {"," pm.response.to.have.jsonBody(\"data.filename\");","});","","//Getting data mime_type-> OK","pm.test(\"General response for Data mime_type \", function () {"," pm.response.to.have.jsonBody(\"data.mime_type\");","});","","//Getting data filesize-> OK","pm.test(\"General response for Data filesize \", function () {"," pm.response.to.have.jsonBody(\"data.filesize\");","});","","//Getting data url-> OK","pm.test(\"General response for Data url \", function () {"," pm.response.to.have.jsonBody(\"data.url\");","});","","","//Catching the error message and display the status ","","pm.test(\"General response Status(500)\", function () {"," pm.response.to.be.ok; //HTTP 500","})","","pm.test(\"General error response\", function () {"," pm.response.to.not.have.jsonBody(\"error\"); ","});","","//General error response with the message","pm.test(\"General error response with the message\", function () {"," pm.response.to.not.have.jsonBody(\"error.message\"); ","});","","pm.test(\"showing the summary response \", function () {"," pm.response.to.not.have.jsonBody(\"error.summary\"); ","});","","","//The Below test should be in ALL API calls as it is a general test. Response time may need tweaking for some queries.","pm.test(\"General response (Response Time)\", function () {"," pm.expect(pm.response.responseTime).to.be.below( 9828); //Quicker than 150ms","});",""],"type":"text/javascript","packages":{},"requests":{}}}],"id":"9bb64e25-f440-48a8-9bb0-00921a9b44eb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{access_key_user}}"},"isInherited":false},"method":"POST","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"saveas\":\"zip\",\r\n \"assets\":[\r\n {\r\n \"asset_id\":468000,\r\n \"size_id\": 7,\r\n \"usage\": {\r\n \"project_title\": \"test\"\r\n }\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"{{cw3_api_url}}/api/asset/download/zip","description":"Documentation being revised. Please try agan Monday 13th March.
\n","urlObject":{"path":["api","asset","download","zip"],"host":["{{cw3_api_url}}"],"query":[],"variable":[]}},"response":[{"id":"52f490e6-25c6-4a3e-ab78-8b36540b4cd6","name":"success","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"{{access_key_user}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"saveas\":\"zip\",\r\n \"assets\":[\r\n {\r\n \"asset_id\":100111964,\r\n \"size_id\": 7,\r\n \"usage\": {\r\n \"project_title\": \"test\"\r\n }\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"{{cw3_api_url}}/api/asset/download/zip"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Origin","value":"","description":"Specifies a URI that may access the resource. For requests without credentials, the server may specify '*' as a wildcard, thereby allowing any origin to access the resource."},{"key":"Connection","value":"Upgrade, Keep-Alive","description":"Options that are desired for the connection"},{"key":"Content-Encoding","value":"gzip","description":"The type of encoding used on the data."},{"key":"Content-Language","value":"en","description":"The language the content is in"},{"key":"Content-Length","value":"485","description":"The length of the response body in octets (8-bit bytes)"},{"key":"Content-Type","value":"application/json; charset=UTF-8","description":"The mime type of this content"},{"key":"Date","value":"Wed, 09 May 2018 10:25:24 GMT","description":"The date and time that the message was sent"},{"key":"Keep-Alive","value":"timeout=5, max=100","description":"Custom header"},{"key":"Server","value":"Apache","description":"A name for the server"},{"key":"Upgrade","value":"h2,h2c","description":"Custom header"},{"key":"Vary","value":"Accept-Encoding","description":"Tells downstream proxies how to match future request headers to decide whether the cached response can be used rather than requesting a fresh one from the origin server."},{"key":"X-Powered-By","value":"capture API","description":"Specifies the technology (ASP.NET, PHP, JBoss, e.g.) supporting the web application (version details are often in X-Runtime, X-Version, or X-AspNet-Version)"}],"cookie":[],"responseTime":null,"body":"{\r\n \"status\": 202,\r\n \"data\": {\r\n \"message\": \"download is being prepared\",\r\n \"job_id\": \"54\",\r\n \"order_id\": \"1066\",\r\n \"download_async\": true,\r\n \"debug\": {\r\n \"contents\": {\r\n \"message\": \"JOB_QUEUED\",\r\n \"summary\": \"Awaiting Processing\"\r\n },\r\n \"assetIdList\": [\r\n \"468000\"\r\n ],\r\n \"sizeIdList\": [\r\n 7\r\n ]\r\n }\r\n }\r\n}"}],"_postman_id":"9bb64e25-f440-48a8-9bb0-00921a9b44eb"},{"name":"download options","event":[{"listen":"prerequest","script":{"id":"4609f3ba-1dcf-49fe-9924-6e0880269096","exec":["pm.sendRequest({"," url: pm.environment.get(\"cw3_api_url\") + \"/api/oauth/access_token\", "," method: 'POST',"," header: {"," 'Accept': 'application/json',"," 'Content-Type': 'application/x-www-form-urlencoded',"," 'Authorization': 'Basic Abcdefghijk=='"," },"," body: {"," mode: 'urlencoded',"," urlencoded: ["," {key: \"grant_type\", value: \"password\", disabled: false},"," {key: \"username\", value: pm.environment.get(\"email\"), disabled: false},"," {key: \"password\", value: pm.environment.get(\"password\"), disabled: false},"," {key: \"client_id\", value: pm.environment.get(\"client_id\"), disabled: false},"," {key: \"client_secret\", value: pm.environment.get(\"client_secret\"), disabled: false}"," ]"," }"," }, function (err, res) {"," pm.environment.set(\"access_token_capture\", res.json().access_token);"," });"],"type":"text/javascript","packages":{},"requests":{}}},{"listen":"test","script":{"id":"6b7cc3b2-f7ad-40d5-a7df-d694d7588b5c","exec":["// Data Access token Status -> OK","pm.test(\"Ouath Extend Request \", function () {"," var jsonData = pm.response.json();"," pm.expect(jsonData.status).to.eql(200);","});","","//Getting data available-> OK","pm.test(\"General response for Data available \", function () {"," pm.response.to.have.jsonBody(\"data.available\");","});","","","//Getting data available 142 allowHR-> OK","pm.test(\"General response for Data available 142 allowHR \", function () {"," pm.response.to.have.jsonBody(\"data.available.142.allowHR\");","});","","//Getting data available 142 allowLR-> OK","pm.test(\"General response for Data available 142 allowLR \", function () {"," pm.response.to.have.jsonBody(\"data.available.142.allowLR\");","});",""],"type":"text/javascript","packages":{},"requests":{}}}],"id":"12118054-0362-46d1-9de7-4394f0fbd99f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{access_key_user}}"},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"{{cw3_api_url}}/api/asset/download/peek/{{asset_id}}","description":"before attempting to download an asset (or multiple assets), the download peek call fetches information describing what the download request must provide.
for example, download/peek will return if the asset is available as high or low resolution (or both), if any usage information is required (e.g. project title, reason for download, etc)
\nthere are no parameters, but a comma separated list of asset id's should be passed as the last component of the url. this allows a single request to return download information for one or more assets.
\nthe information returned will be relative to the rights and permissions of the user making the request.
\nfor users with an account, the access token should be passed in the http Authorization: Bearer token header
for anonymous users, the request should be made with the http Authorization: Basic base64string header. in this case the token is a base64 encoded string of the form base64(username:password), where username should be a session id or similar, unique to this user for the duration of their interaction with the site; password should be their ipv4 address
Test : Get job queue check API endpoint
\nUse Case: When the API is called, it will check the queue of the assets that have been downloaded. The user will need the access token to perform the request.
\nResponse Status : 200 OK
\n","urlObject":{"path":["api","asset","download","queue","{{asset_id}}"],"host":["{{cw3_api_url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"9035c9c8-fad7-47ea-a7be-da94f4ca7268"},{"name":"Tag with keyword","event":[{"listen":"test","script":{"id":"9181a86b-375a-4187-a0de-27690d1e3a4b","exec":["","// Data Access token Status -> OK","pm.test(\"Oauth Access Token Status is OK \", function () {"," var jsonData = pm.response.json();"," pm.expect(jsonData.status).to.eql(200);","});","","// Data Oath Access token -> OK","pm.test(\"General response for Data Oauth Token \", function () {"," pm.response.to.have.jsonBody(\"data.oauth.access_token\");","});","","","// Data Oauth Expire in ","pm.test(\"General response which show the Oauth Expires in \", function () {"," pm.response.to.have.jsonBody(\"data.oauth.expires_in\");","});","","// Data Oauth Refresh Token ","pm.test(\"Response Refresh Token \", function () {"," pm.response.to.have.jsonBody(\"data.oauth.refresh_token\");","});",""," //Showing the User Information After Registration"," ","pm.test(\"Showing the User Id afetr registration \", function () {"," pm.response.to.have.jsonBody(\"data.user.userId\");","});","","pm.test(\"Showing the User First Name afetr registration \", function () {"," pm.response.to.have.jsonBody(\"data.user.firstName\");","});","","pm.test(\"Showing the User Last Name afetr registration \", function () {"," pm.response.to.have.jsonBody(\"data.user.lastName\");","});","","pm.test(\"Showing the User Email afetr registration \", function () {"," pm.response.to.have.jsonBody(\"data.user.email\");","});","","","//The Below test should be in ALL API calls as it is a general test. Response time may need tweaking for some queries.","pm.test(\"General response test (200)\", function () {"," pm.response.to.be.ok; //HTTP 200","});","","pm.test(\"General response test (Body)\", function () {"," pm.response.to.be.withBody; // Has Body","});","pm.test(\"General response test (JSON)\", function () {"," pm.response.to.be.json; //Body is Json","});","pm.test(\"General response test (Response Time)\", function () {"," pm.expect(pm.response.responseTime).to.be.below(368); //Quicker than 150ms","});",""],"type":"text/javascript","packages":{},"requests":{}}}],"id":"b12058c3-5064-4f39-939e-9349d014d68c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{access_key_user}}"},"isInherited":false},"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"access_token\":\"{{access_token_capture}}\",\n \"keywords\":[112250]\n}"},"url":"{{cw3_api_url}}/api/asset/{{asset_id}}/keywordtag","description":"Test: Tag with keyword endpoint API call
\nUse Case: When the API is called via a URL, the user will be able to create new tag keyword assocaited with assest ID . Although the user will have to be authenticated and provide the access token in params.
\nResponse Status: 200 OK
\n","urlObject":{"path":["api","asset","{{asset_id}}","keywordtag"],"host":["{{cw3_api_url}}"],"query":[],"variable":[]}},"response":[{"id":"fed77dc4-4abc-493f-9031-cc65f7944df8","name":"Tag with keyword","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"{{access_key_user}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"access_token\":\"{{access_token_capture}}\",\n \"keywords\":[112250]\n}"},"url":"{{cw3_api_url}}/api/asset/468000/keywordtag"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Origin","value":"","description":"Specifies a URI that may access the resource. For requests without credentials, the server may specify '*' as a wildcard, thereby allowing any origin to access the resource."},{"key":"Connection","value":"Upgrade, Keep-Alive","description":"Options that are desired for the connection"},{"key":"Content-Encoding","value":"gzip","description":"The type of encoding used on the data."},{"key":"Content-Language","value":"en","description":"The language the content is in"},{"key":"Content-Length","value":"72","description":"The length of the response body in octets (8-bit bytes)"},{"key":"Content-Type","value":"application/json; charset=UTF-8","description":"The mime type of this content"},{"key":"Date","value":"Wed, 16 May 2018 08:56:47 GMT","description":"The date and time that the message was sent"},{"key":"Keep-Alive","value":"timeout=5, max=100","description":"Custom header"},{"key":"Server","value":"Apache","description":"A name for the server"},{"key":"Upgrade","value":"h2,h2c","description":"Custom header"},{"key":"Vary","value":"Accept-Encoding","description":"Tells downstream proxies how to match future request headers to decide whether the cached response can be used rather than requesting a fresh one from the origin server."},{"key":"X-Powered-By","value":"capture API","description":"Specifies the technology (ASP.NET, PHP, JBoss, e.g.) supporting the web application (version details are often in X-Runtime, X-Version, or X-AspNet-Version)"}],"cookie":[],"responseTime":null,"body":"{\"status\":200,\"data\":{\"message\":\"tag added to asset\"}}"}],"_postman_id":"b12058c3-5064-4f39-939e-9349d014d68c"}],"id":"73cab59c-a3b2-47f2-8aa0-6b2e7832e0b9","description":"Any asset retrieval operation, e.g. get preview, download, check job progress. Asset create / update / delete (crud) ops are handled withing the Admin collection.
\n","event":[{"listen":"prerequest","script":{"id":"ac1702eb-03cd-47b8-a55d-1a84707ada2e","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"357e9df6-577a-4d24-9847-aceaaa3f4e95","type":"text/javascript","exec":[""]}}],"_postman_id":"73cab59c-a3b2-47f2-8aa0-6b2e7832e0b9"},{"name":"Collections (Groups)","item":[{"name":"list collections","event":[{"listen":"test","script":{"id":"0dce2569-ceb7-4d90-ad39-43f5ac7e01c6","exec":[""],"type":"text/javascript","packages":{},"requests":{}}},{"listen":"prerequest","script":{"id":"b14ebbf8-9da6-4102-9f75-7be90f28be53","exec":[""],"type":"text/javascript","packages":{},"requests":{}}}],"id":"0f822a3f-5eec-436d-83a8-7a64ca42be21","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"password":"{{ip_address}}","username":"{{session_id}}"},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"{{cw3_api_url}}/api/groups","description":"fetch collections marked as 'show in gallery'.
\nwithout an id all collections at root level that are accessible by the user are returned.
\nwith an id, this request will list child collections of the specified parent id
\nanonymous user request can only see public collections, authorised (logged in) user request can see public and restricted collections that the user account has been granted access to.
\nall collections must be marked as published to be accessible from the public facing site.
\n","urlObject":{"path":["api","groups"],"host":["{{cw3_api_url}}"],"query":[{"disabled":true,"key":"itemsPerPage","value":"5"},{"disabled":true,"key":"page","value":"1"},{"disabled":true,"key":"total","value":"15"},{"disabled":true,"description":{"content":"true or false
\n","type":"text/plain"},"key":"lead_asset_landscape","value":"false"}],"variable":[]}},"response":[{"id":"82dc14c6-a2cc-43a8-a971-b396d55bfa40","name":"list collections at root level","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"{{cw3_api_url}}/api/group/28","host":["{{cw3_api_url}}"],"path":["api","group","28"],"query":[{"key":"itemsPerPage","value":"5","disabled":true},{"key":"total","value":"15","disabled":true},{"key":"page","value":"1","disabled":true},{"key":"gallery_only","value":"false","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Origin","value":"","description":"Specifies a URI that may access the resource. For requests without credentials, the server may specify '*' as a wildcard, thereby allowing any origin to access the resource."},{"key":"Connection","value":"Keep-Alive","description":"Options that are desired for the connection"},{"key":"Content-Encoding","value":"gzip","description":"The type of encoding used on the data."},{"key":"Content-Language","value":"en","description":"The language the content is in"},{"key":"Content-Length","value":"353","description":"The length of the response body in octets (8-bit bytes)"},{"key":"Content-Type","value":"application/json; charset=UTF-8","description":"The mime type of this content"},{"key":"Date","value":"Tue, 08 May 2018 10:29:47 GMT","description":"The date and time that the message was sent"},{"key":"Keep-Alive","value":"timeout=5, max=99","description":"Custom header"},{"key":"Server","value":"Apache","description":"A name for the server"},{"key":"Vary","value":"Accept-Encoding","description":"Tells downstream proxies how to match future request headers to decide whether the cached response can be used rather than requesting a fresh one from the origin server."},{"key":"X-Powered-By","value":"capture API","description":"Specifies the technology (ASP.NET, PHP, JBoss, e.g.) supporting the web application (version details are often in X-Runtime, X-Version, or X-AspNet-Version)"}],"cookie":[],"responseTime":null,"body":"{\r\n \"status\": 200,\r\n \"data\": {\r\n \"meta\": {\r\n \"total\": 2,\r\n \"found\": 2,\r\n \"returned\": 2,\r\n \"pages\": 1,\r\n \"page\": 1,\r\n \"from\": 1,\r\n \"to\": 2,\r\n \"time_index\": 0.302,\r\n \"time_rtrip\": 0.518\r\n },\r\n \"group\": [],\r\n \"groups\": [\r\n {\r\n \"collection_id\": 18,\r\n \"id_category\": 18,\r\n \"id_parent\": 0,\r\n \"id\": 18,\r\n \"name\": \"Test 2\",\r\n \"description\": null,\r\n \"is_public\": true,\r\n \"is_published\": true,\r\n \"call_me_price\": 0,\r\n \"is_searchable\": false,\r\n \"colour_code\": 0,\r\n \"gallery\": true,\r\n \"render_type\": \"grid\",\r\n \"numbering_scheme\": {\r\n \"type\": \"asset_count\",\r\n \"total\": 0\r\n },\r\n \"metadata\": {\r\n \"md1\": {\r\n \"column_name\": \"md1\",\r\n \"label\": \"Subject\",\r\n \"value\": \"value\"\r\n },\r\n \"md2\": {\r\n \"column_name\": \"md2\",\r\n \"label\": \"Description\",\r\n \"value\": \"value\"\r\n }\r\n },\r\n \"download_rights\": [],\r\n \"asset_count\": 0,\r\n \"child_count\": 2,\r\n \"display_order\": 0,\r\n \"created\": \"2024-08-14 14:58:54\",\r\n \"lead_asset\": {\r\n \"summary\": {\r\n \"idasset\": 1001,\r\n \"idusers\": 1,\r\n \"file_extension\": \"jpg\",\r\n \"org_filename\": \"sea-turtle.jpg\",\r\n \"filesize\": 109570,\r\n \"height\": 576,\r\n \"width\": 1024,\r\n \"batchname\": \"FTP1518018689\",\r\n \"upload_date\": \"2018-02-07 15:51:30\",\r\n \"externalid1\": \"sea turtle\",\r\n \"externalid2\": \"0\",\r\n \"call_me_price\": 0,\r\n \"publishing_date\": \"2023-05-25 12:25:21\",\r\n \"mime_type\": \"image/*\",\r\n \"exif_datetimeoriginal\": null,\r\n \"file_duration\": null,\r\n \"idasset_status\": 1,\r\n \"exclusive_code\": 0,\r\n \"colour_code\": 0,\r\n \"compliance_code\": 0,\r\n \"base_type\": \"image\",\r\n \"license_types\": [],\r\n \"publication_status_id\": 2,\r\n \"is_published\": true,\r\n \"contact_id\": 22,\r\n \"response_data\": \"JIT\"\r\n },\r\n \"thumb\": {\r\n \"exists\": true,\r\n \"thumb_mimetype\": \"image/jpeg\",\r\n \"griditem_width\": 360,\r\n \"griditem_height\": 203,\r\n \"url\": {\r\n \"1\": \"https://thumb-url.jpg\",\r\n \"3\": \"https://thumb-url.jpg\"\r\n }\r\n },\r\n \"preview\": {\r\n \"exists\": true,\r\n \"mimetype\": \"image/jpeg\",\r\n \"url\": \"https://preview-url.jpg\"\r\n }\r\n }\r\n },\r\n {\r\n \"collection_id\": 15,\r\n \"id_category\": 15,\r\n \"id_parent\": 0,\r\n \"id\": 15,\r\n \"name\": \"test 2\",\r\n \"description\": \"\",\r\n \"is_public\": true,\r\n \"is_published\": true,\r\n \"call_me_price\": 0,\r\n \"is_searchable\": true,\r\n \"colour_code\": 0,\r\n \"gallery\": true,\r\n \"render_type\": \"grid\",\r\n \"numbering_scheme\": {\r\n \"type\": \"asset_count\",\r\n \"total\": 6\r\n },\r\n \"metadata\": {\r\n \"md1\": {\r\n \"column_name\": \"md1\",\r\n \"label\": \"Subject\",\r\n \"value\": null\r\n },\r\n \"md2\": {\r\n \"column_name\": \"md2\",\r\n \"label\": \"Description\",\r\n \"value\": null\r\n }\r\n },\r\n \"download_rights\": [],\r\n \"asset_count\": 6,\r\n \"child_count\": 0,\r\n \"display_order\": 0,\r\n \"created\": \"2024-06-07 11:19:53\",\r\n \"lead_asset\": {\r\n \"summary\": {\r\n \"idasset\": 981,\r\n \"idusers\": 60,\r\n \"file_extension\": \"png\",\r\n \"org_filename\": \"leaving-belfast.png\",\r\n \"filesize\": 347528,\r\n \"height\": 534,\r\n \"width\": 707,\r\n \"batchname\": \"5#60#16:28 7-02-18\",\r\n \"upload_date\": \"2018-02-07 16:28:25\",\r\n \"externalid1\": \"leaving belfast\",\r\n \"externalid2\": \"0\",\r\n \"call_me_price\": 0,\r\n \"publishing_date\": \"2020-02-14 15:04:20\",\r\n \"mime_type\": \"\",\r\n \"exif_datetimeoriginal\": null,\r\n \"file_duration\": null,\r\n \"idasset_status\": 1,\r\n \"exclusive_code\": 0,\r\n \"colour_code\": 0,\r\n \"compliance_code\": 0,\r\n \"base_type\": \"image\",\r\n \"license_types\": [],\r\n \"publication_status_id\": 2,\r\n \"is_published\": true,\r\n \"contact_id\": 25,\r\n \"response_data\": \"JIT\"\r\n },\r\n \"thumb\": {\r\n \"exists\": true,\r\n \"thumb_mimetype\": \"image/png\",\r\n \"griditem_width\": 360,\r\n \"griditem_height\": 272,\r\n \"url\": {\r\n \"1\": \"https:thumb.png\",\r\n \"3\": \"https://thumb.png\"\r\n }\r\n },\r\n \"preview\": {\r\n \"exists\": true,\r\n \"mimetype\": \"image/png\",\r\n \"url\": \"https://preview.png\"\r\n }\r\n }\r\n }\r\n ]\r\n }\r\n}"},{"id":"ac15fa02-ca3a-4826-a7c6-64714455a1ce","name":"list child collections of a parent","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"{{cw3_api_url}}/api/group/{{collection_parent_id}}","host":["{{cw3_api_url}}"],"path":["api","group","{{collection_parent_id}}"],"query":[{"key":"itemsPerPage","value":"5","disabled":true},{"key":"total","value":"15","disabled":true},{"key":"page","value":"1","disabled":true},{"key":"gallery_only","value":"false","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Origin","value":"","description":"Specifies a URI that may access the resource. For requests without credentials, the server may specify '*' as a wildcard, thereby allowing any origin to access the resource."},{"key":"Connection","value":"Keep-Alive","description":"Options that are desired for the connection"},{"key":"Content-Encoding","value":"gzip","description":"The type of encoding used on the data."},{"key":"Content-Language","value":"en","description":"The language the content is in"},{"key":"Content-Length","value":"353","description":"The length of the response body in octets (8-bit bytes)"},{"key":"Content-Type","value":"application/json; charset=UTF-8","description":"The mime type of this content"},{"key":"Date","value":"Tue, 08 May 2018 10:29:47 GMT","description":"The date and time that the message was sent"},{"key":"Keep-Alive","value":"timeout=5, max=99","description":"Custom header"},{"key":"Server","value":"Apache","description":"A name for the server"},{"key":"Vary","value":"Accept-Encoding","description":"Tells downstream proxies how to match future request headers to decide whether the cached response can be used rather than requesting a fresh one from the origin server."},{"key":"X-Powered-By","value":"capture API","description":"Specifies the technology (ASP.NET, PHP, JBoss, e.g.) supporting the web application (version details are often in X-Runtime, X-Version, or X-AspNet-Version)"}],"cookie":[],"responseTime":null,"body":"{\r\n \"status\": 200,\r\n \"data\": {\r\n \"meta\": {\r\n \"total\": 2,\r\n \"found\": 2,\r\n \"returned\": 2,\r\n \"pages\": 1,\r\n \"page\": 1,\r\n \"from\": 1,\r\n \"to\": 2,\r\n \"time_index\": 0.33,\r\n \"time_rtrip\": 0.459\r\n },\r\n \"group\": {\r\n \"collection_id\": 5,\r\n \"id_category\": 5,\r\n \"id_parent\": 0,\r\n \"id\": 5,\r\n \"name\": \"On the Farm\",\r\n \"description\": \"\",\r\n \"is_public\": true,\r\n \"is_published\": true,\r\n \"call_me_price\": 0,\r\n \"is_searchable\": false,\r\n \"colour_code\": 0,\r\n \"gallery\": true,\r\n \"render_type\": \"grid\",\r\n \"numbering_scheme\": {\r\n \"type\": \"asset_count\",\r\n \"total\": 0\r\n },\r\n \"metadata\": {\r\n \"md1\": {\r\n \"column_name\": \"md1\",\r\n \"label\": \"Subject\",\r\n \"value\": \"test\"\r\n },\r\n \"md2\": {\r\n \"column_name\": \"md2\",\r\n \"label\": \"Description\",\r\n \"value\": null\r\n }\r\n },\r\n \"ancestry\": [],\r\n \"lead_asset\": []\r\n },\r\n \"groups\": [\r\n {\r\n \"collection_id\": 7,\r\n \"id_category\": 7,\r\n \"id_parent\": 5,\r\n \"id\": 7,\r\n \"name\": \"test\",\r\n \"description\": \"\",\r\n \"is_public\": true,\r\n \"is_published\": true,\r\n \"call_me_price\": 0,\r\n \"is_searchable\": false,\r\n \"colour_code\": 0,\r\n \"gallery\": true,\r\n \"render_type\": \"grid\",\r\n \"numbering_scheme\": {\r\n \"type\": \"asset_count\",\r\n \"total\": 11\r\n },\r\n \"metadata\": {\r\n \"md1\": {\r\n \"column_name\": \"md1\",\r\n \"label\": \"Subject\",\r\n \"value\": \"value\"\r\n },\r\n \"md2\": {\r\n \"column_name\": \"md2\",\r\n \"label\": \"Description\",\r\n \"value\": null\r\n }\r\n },\r\n \"download_rights\": [],\r\n \"asset_count\": 11,\r\n \"child_count\": 1,\r\n \"display_order\": 0,\r\n \"created\": \"2023-04-11 14:25:34\",\r\n \"lead_asset\": {\r\n \"summary\": {\r\n \"idasset\": 136,\r\n \"idusers\": 69,\r\n \"file_extension\": \"jpg\",\r\n \"org_filename\": \"24047.jpg\",\r\n \"filesize\": 270833,\r\n \"height\": 683,\r\n \"width\": 1024,\r\n \"batchname\": \"355images\",\r\n \"upload_date\": \"2017-02-17 10:17:16\",\r\n \"externalid1\": \"24047\",\r\n \"externalid2\": \"0\",\r\n \"call_me_price\": 0,\r\n \"publishing_date\": \"2017-04-03 19:29:37\",\r\n \"mime_type\": \"image/jpeg\",\r\n \"exif_datetimeoriginal\": null,\r\n \"file_duration\": \"\",\r\n \"idasset_status\": 1,\r\n \"exclusive_code\": 0,\r\n \"colour_code\": 0,\r\n \"compliance_code\": 0,\r\n \"base_type\": \"image\",\r\n \"license_types\": [],\r\n \"publication_status_id\": 2,\r\n \"is_published\": true,\r\n \"contact_id\": 0,\r\n \"response_data\": \"JIT\"\r\n },\r\n \"thumb\": {\r\n \"exists\": true,\r\n \"thumb_mimetype\": \"image/jpeg\",\r\n \"griditem_width\": 360,\r\n \"griditem_height\": 241,\r\n \"url\": {\r\n \"1\": \"https://thumb-url.jpg\",\r\n \"3\": \"https://thumb-url.jpg\"\r\n }\r\n },\r\n \"preview\": {\r\n \"exists\": true,\r\n \"mimetype\": \"image/jpeg\",\r\n \"url\": \"https://preview-url.jpg\"\r\n }\r\n }\r\n },\r\n {\r\n \"collection_id\": 6,\r\n \"id_category\": 6,\r\n \"id_parent\": 5,\r\n \"id_type\": 1,\r\n \"id\": 6,\r\n \"name\": \"Chickens\",\r\n \"description\": \"\",\r\n \"is_public\": true,\r\n \"is_published\": true,\r\n \"call_me_price\": 0,\r\n \"is_searchable\": false,\r\n \"colour_code\": 0,\r\n \"gallery\": true,\r\n \"render_type\": \"grid\",\r\n \"numbering_scheme\": {\r\n \"type\": \"asset_count\",\r\n \"total\": 4\r\n },\r\n \"metadata\": {\r\n \"md1\": {\r\n \"column_name\": \"md1\",\r\n \"label\": \"Subject\",\r\n \"value\": \"Poulet\"\r\n },\r\n \"md2\": {\r\n \"column_name\": \"md2\",\r\n \"label\": \"Description\",\r\n \"value\": null\r\n },\r\n \"md3\": {\r\n \"column_name\": \"md3\",\r\n \"label\": \"Keywords\",\r\n \"value\": \"farm,chickens,chicken,field\"\r\n },\r\n \"md4\": {\r\n \"column_name\": \"md4\",\r\n \"label\": \"City\",\r\n \"value\": null\r\n },\r\n \"md5\": {\r\n \"column_name\": \"md5\",\r\n \"label\": \"Creator\",\r\n \"value\": null\r\n },\r\n \"md6\": {\r\n \"column_name\": \"md6\",\r\n \"label\": \"Publication date\",\r\n \"value\": \"2015-12-31 \"\r\n },\r\n \"md7\": {\r\n \"column_name\": \"md7\",\r\n \"label\": \"Publication year\",\r\n \"value\": \"2015\"\r\n },\r\n \"md8\": {\r\n \"column_name\": \"md8\",\r\n \"label\": \"Asset Type\",\r\n \"value\": null\r\n },\r\n \"md9\": {\r\n \"column_name\": \"md9\",\r\n \"label\": \"Categories\",\r\n \"value\": null\r\n }\r\n },\r\n \"download_rights\": [],\r\n \"asset_count\": 4,\r\n \"child_count\": 1,\r\n \"display_order\": 0,\r\n \"created\": \"2023-04-11 14:25:34\",\r\n \"lead_asset\": {\r\n \"summary\": {\r\n \"idasset\": 376,\r\n \"idusers\": 99,\r\n \"file_extension\": \"jpg\",\r\n \"org_filename\": \"24675.jpg\",\r\n \"filesize\": 291122,\r\n \"height\": 1024,\r\n \"width\": 683,\r\n \"batchname\": \"test\",\r\n \"upload_date\": \"2017-02-17 10:29:02\",\r\n \"externalid1\": \"24675\",\r\n \"externalid2\": \"0\",\r\n \"call_me_price\": 0,\r\n \"publishing_date\": \"2017-04-03 18:11:36\",\r\n \"mime_type\": \"\",\r\n \"exif_datetimeoriginal\": null,\r\n \"file_duration\": \"\",\r\n \"idasset_status\": 1,\r\n \"exclusive_code\": 0,\r\n \"colour_code\": 0,\r\n \"compliance_code\": 0,\r\n \"base_type\": \"image\",\r\n \"license_types\": [],\r\n \"publication_status_id\": 2,\r\n \"is_published\": true,\r\n \"contact_id\": 0,\r\n \"response_data\": \"JIT\"\r\n },\r\n \"thumb\": {\r\n \"exists\": true,\r\n \"thumb_mimetype\": \"image/jpeg\",\r\n \"griditem_width\": 221,\r\n \"griditem_height\": 330,\r\n \"url\": {\r\n \"1\": \"https://thumb-url.jpg\",\r\n \"3\": \"https://thumb-url.jpg\"\r\n }\r\n },\r\n \"preview\": {\r\n \"exists\": true,\r\n \"mimetype\": \"image/jpeg\",\r\n \"url\": \"https://preview-url.jpg\"\r\n }\r\n }\r\n }\r\n ]\r\n }\r\n}"}],"_postman_id":"0f822a3f-5eec-436d-83a8-7a64ca42be21"},{"name":"get a collection by id","event":[{"listen":"prerequest","script":{"id":"e4dcd72e-54a2-4775-92d7-493fe60e6c6e","exec":[""],"type":"text/javascript","packages":{},"requests":{}}},{"listen":"test","script":{"id":"903f2a57-59d1-49e5-8158-9ff42b46b296","exec":[""],"type":"text/javascript","packages":{},"requests":{}}}],"id":"39974ace-5992-43f8-b30d-d44e353251b9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{access_key_user}}"},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"{{cw3_api_url}}/api/group/{{collection_id}}?itemsPerPage=30","description":"Returns the collection specified by the provided id. The data response contains information about the collection (returned in data.group), the leadasset for the collection in data.leadAsset, and assets contained in the collection in the data.assets array.
\nthe assets array supports paging by passing itemsPerPage and page. paging information is returned in data.meta
\n","urlObject":{"path":["api","group","{{collection_id}}"],"host":["{{cw3_api_url}}"],"query":[{"key":"itemsPerPage","value":"30"},{"disabled":true,"key":"page","value":"1"},{"disabled":true,"key":"total","value":"0"},{"disabled":true,"key":"all_metadata","value":"1"},{"disabled":true,"key":"summary_only","value":"true"}],"variable":[]}},"response":[{"id":"80b26c37-5868-4738-a920-863531f6f09f","name":"get a collection by id (success)","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"{{cw3_api_url}}/api/group/{{collection_id}}?itemsPerPage=30","host":["{{cw3_api_url}}"],"path":["api","group","{{collection_id}}"],"query":[{"key":"itemsPerPage","value":"30"},{"key":"page","value":"1","type":"text","disabled":true},{"key":"total","value":"0","type":"text","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Origin","value":"","description":"Specifies a URI that may access the resource. For requests without credentials, the server may specify '*' as a wildcard, thereby allowing any origin to access the resource."},{"key":"Connection","value":"Upgrade, Keep-Alive","description":"Options that are desired for the connection"},{"key":"Content-Encoding","value":"gzip","description":"The type of encoding used on the data."},{"key":"Content-Language","value":"en","description":"The language the content is in"},{"key":"Content-Length","value":"353","description":"The length of the response body in octets (8-bit bytes)"},{"key":"Content-Type","value":"application/json; charset=UTF-8","description":"The mime type of this content"},{"key":"Date","value":"Tue, 08 May 2018 09:34:45 GMT","description":"The date and time that the message was sent"},{"key":"Keep-Alive","value":"timeout=5, max=100","description":"Custom header"},{"key":"Server","value":"Apache","description":"A name for the server"},{"key":"Upgrade","value":"h2,h2c","description":"Custom header"},{"key":"Vary","value":"Accept-Encoding","description":"Tells downstream proxies how to match future request headers to decide whether the cached response can be used rather than requesting a fresh one from the origin server."},{"key":"X-Powered-By","value":"capture API","description":"Specifies the technology (ASP.NET, PHP, JBoss, e.g.) supporting the web application (version details are often in X-Runtime, X-Version, or X-AspNet-Version)"}],"cookie":[],"responseTime":null,"body":"{\r\n \"status\": 200,\r\n \"data\": {\r\n \"meta\": {\r\n \"total\": 2,\r\n \"found\": 2,\r\n \"returned\": 2,\r\n \"pages\": 1,\r\n \"page\": 1,\r\n \"from\": 1,\r\n \"to\": 2,\r\n \"time_rtrip\": 0.634\r\n },\r\n \"group\": {\r\n \"collection_id\": 4,\r\n \"id_category\": 4,\r\n \"id_parent\": 0,\r\n \"id_type\": 1,\r\n \"id\": 4,\r\n \"name\": \"Collection Name\",\r\n \"description\": \"description text\",\r\n \"is_public\": true,\r\n \"is_published\": true,\r\n \"call_me_price\": 0,\r\n \"is_searchable\": false,\r\n \"colour_code\": 0,\r\n \"gallery\": true,\r\n \"render_type\": \"grid\",\r\n \"numbering_scheme\": {\r\n \"type\": \"asset_count\",\r\n \"total\": 14\r\n },\r\n \"metadata\": {\r\n \"md1\": {\r\n \"column_name\": \"md1\",\r\n \"label\": \"Subject\",\r\n \"value\": \"Test Me\"\r\n },\r\n \"md2\": {\r\n \"column_name\": \"md2\",\r\n \"label\": \"Description\",\r\n \"value\": null\r\n },\r\n \"md3\": {\r\n \"column_name\": \"md3\",\r\n \"label\": \"Keywords\",\r\n \"value\": \"keywords,comma,separated\"\r\n }\r\n },\r\n \"ancestry\": [],\r\n \"download_rights\": {\r\n \"allow_buy\": 0,\r\n \"allow_download\": 1,\r\n \"view_only\": 0,\r\n \"hide_price\": 1\r\n },\r\n \"file_types\": {\r\n \"png\": 13,\r\n \"jpg\": 1\r\n }\r\n },\r\n \"leadAsset\": {\r\n \"summary\": {\r\n \"idasset\": 932,\r\n \"idusers\": 60,\r\n \"file_extension\": \"png\",\r\n \"org_filename\": \"carl.png\",\r\n \"filesize\": 34189,\r\n \"height\": 300,\r\n \"width\": 275,\r\n \"batchname\": \"delegates\",\r\n \"upload_date\": \"2017-10-01 22:55:08\",\r\n \"externalid1\": \"carl\",\r\n \"externalid2\": \"0\",\r\n \"call_me_price\": 0,\r\n \"publishing_date\": \"2017-10-02 12:49:27\",\r\n \"mime_type\": \"image/png\",\r\n \"exif_datetimeoriginal\": null,\r\n \"file_duration\": null,\r\n \"idasset_status\": 1,\r\n \"exclusive_code\": 0,\r\n \"colour_code\": 0,\r\n \"compliance_code\": 0,\r\n \"base_type\": \"image\",\r\n \"license_types\": [],\r\n \"publication_status_id\": 2,\r\n \"is_published\": true,\r\n \"contact_id\": 1531,\r\n \"response_data\": \"JIT\"\r\n },\r\n \"thumb\": {\r\n \"exists\": true,\r\n \"thumb_mimetype\": \"image/png\",\r\n \"griditem_width\": 303,\r\n \"griditem_height\": 330,\r\n \"url\": {\r\n \"1\": \"https://thumb-url.png\",\r\n \"3\": \"https://thumb-url.png\"\r\n }\r\n },\r\n \"preview\": {\r\n \"exists\": true,\r\n \"mimetype\": \"image/png\",\r\n \"url\": \"https://preview-url.png\"\r\n }\r\n },\r\n \"assets\": [\r\n {\r\n \"summary\": {\r\n \"idasset\": 933,\r\n \"idusers\": 60,\r\n \"file_extension\": \"png\",\r\n \"org_filename\": \"dave.png\",\r\n \"filesize\": 29602,\r\n \"height\": 300,\r\n \"width\": 275,\r\n \"batchname\": \"delegates\",\r\n \"upload_date\": \"2017-10-01 22:55:15\",\r\n \"externalid1\": \"dave\",\r\n \"externalid2\": \"0\",\r\n \"call_me_price\": 0,\r\n \"publishing_date\": \"2017-10-02 12:49:02\",\r\n \"mime_type\": \"image/png\",\r\n \"exif_datetimeoriginal\": null,\r\n \"file_duration\": null,\r\n \"idasset_status\": 1,\r\n \"exclusive_code\": 0,\r\n \"colour_code\": 0,\r\n \"compliance_code\": 0,\r\n \"base_type\": \"image\",\r\n \"license_types\": [],\r\n \"publication_status_id\": 2,\r\n \"is_published\": true,\r\n \"contact_id\": 22,\r\n \"response_data\": \"JIT\"\r\n },\r\n \"metadata\": {\r\n \"externalid1\": {\r\n \"idmetadata_config\": 400,\r\n \"column_name\": \"externalid1\",\r\n \"label\": \"External identifier\",\r\n \"notes\": \"\",\r\n \"value\": \"dave\"\r\n },\r\n \"md1\": {\r\n \"idmetadata_config\": 18,\r\n \"column_name\": \"md1\",\r\n \"label\": \"Subject\",\r\n \"notes\": \"IPTC 105 - Headline\",\r\n \"value\": \"dave\"\r\n },\r\n \"md2\": {\r\n \"idmetadata_config\": 19,\r\n \"column_name\": \"md2\",\r\n \"label\": \"Description\",\r\n \"notes\": \"IPTC 120 - Capture, Abstract, Description\",\r\n \"value\": \"red\"\r\n },\r\n \"md3\": {\r\n \"idmetadata_config\": 20,\r\n \"column_name\": \"md3\",\r\n \"label\": \"Keywords\",\r\n \"notes\": \"IPTC 25 - Keywords. \",\r\n \"value\": \"minion,minions,dave\"\r\n }\r\n },\r\n \"thumb\": {\r\n \"exists\": true,\r\n \"thumb_mimetype\": \"image/png\",\r\n \"griditem_width\": 303,\r\n \"griditem_height\": 330,\r\n \"url\": {\r\n \"1\": \"https://thumb-url.png\",\r\n \"3\": \"https://thumb-url.png\"\r\n }\r\n },\r\n \"preview\": {\r\n \"exists\": true,\r\n \"mimetype\": \"image/png\",\r\n \"url\": \"https://preview-url.png\"\r\n },\r\n \"pageNumber\": 1,\r\n \"inLightbox\": false\r\n },\r\n {\r\n \"summary\": {\r\n \"idasset\": 932,\r\n \"idusers\": 60,\r\n \"file_extension\": \"png\",\r\n \"org_filename\": \"carl.png\",\r\n \"filesize\": 34189,\r\n \"height\": 300,\r\n \"width\": 275,\r\n \"batchname\": \"delegates\",\r\n \"upload_date\": \"2017-10-01 22:55:08\",\r\n \"externalid1\": \"carl\",\r\n \"externalid2\": \"0\",\r\n \"call_me_price\": 0,\r\n \"publishing_date\": \"2017-10-02 12:49:27\",\r\n \"mime_type\": \"image/png\",\r\n \"exif_datetimeoriginal\": null,\r\n \"file_duration\": null,\r\n \"idasset_status\": 1,\r\n \"exclusive_code\": 0,\r\n \"colour_code\": 0,\r\n \"compliance_code\": 0,\r\n \"base_type\": \"image\",\r\n \"license_types\": [],\r\n \"publication_status_id\": 2,\r\n \"is_published\": true,\r\n \"contact_id\": 1531,\r\n \"response_data\": \"JIT\"\r\n },\r\n \"metadata\": {\r\n \"externalid1\": {\r\n \"idmetadata_config\": 400,\r\n \"column_name\": \"externalid1\",\r\n \"label\": \"External identifier\",\r\n \"notes\": \"\",\r\n \"value\": \"carl\"\r\n },\r\n \"md1\": {\r\n \"idmetadata_config\": 18,\r\n \"column_name\": \"md1\",\r\n \"label\": \"Subject\",\r\n \"notes\": \"IPTC 105 - Headline\",\r\n \"value\": \"carl\"\r\n },\r\n \"md2\": {\r\n \"idmetadata_config\": 19,\r\n \"column_name\": \"md2\",\r\n \"label\": \"Description\",\r\n \"notes\": \"IPTC 120 - Capture, Abstract, Description\",\r\n \"value\": \"blue\"\r\n },\r\n \"md3\": {\r\n \"idmetadata_config\": 20,\r\n \"column_name\": \"md3\",\r\n \"label\": \"Keywords\",\r\n \"notes\": \"IPTC 25 - Keywords. \",\r\n \"value\": \"txt,txt,txt\"\r\n }\r\n },\r\n \"thumb\": {\r\n \"exists\": true,\r\n \"thumb_mimetype\": \"image/png\",\r\n \"griditem_width\": 303,\r\n \"griditem_height\": 330,\r\n \"url\": {\r\n \"1\": \"https://thumb-url.png\",\r\n \"3\": \"https://thumb-url.png\"\r\n }\r\n },\r\n \"preview\": {\r\n \"exists\": true,\r\n \"mimetype\": \"image/png\",\r\n \"url\": \"https://preview-url.png\"\r\n },\r\n \"pageNumber\": 1,\r\n \"inLightbox\": false\r\n }\r\n ]\r\n }\r\n}"}],"_postman_id":"39974ace-5992-43f8-b30d-d44e353251b9"},{"name":"tree view","event":[{"listen":"test","script":{"id":"54dfc865-6e00-4454-b341-bdd3b9c142c9","exec":[""],"type":"text/javascript","packages":{},"requests":{}}},{"listen":"prerequest","script":{"packages":{},"type":"text/javascript"}}],"id":"2c8f0c7b-42ac-4d0a-bbf4-d5944f71b475","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{access_key_user}}"},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"{{cw3_api_url}}/api/group/tree","description":"Get a tree view. use with caution if the collection hierarchy is large
\n","urlObject":{"path":["api","group","tree"],"host":["{{cw3_api_url}}"],"query":[],"variable":[]}},"response":[{"id":"0822451d-20cc-4f30-9831-db96a42e6e8c","name":"tree view","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"{{cw3_api_url}}/api/group/tree"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Origin","value":"","description":"Specifies a URI that may access the resource. For requests without credentials, the server may specify '*' as a wildcard, thereby allowing any origin to access the resource."},{"key":"Connection","value":"Upgrade, Keep-Alive","description":"Options that are desired for the connection"},{"key":"Content-Encoding","value":"gzip","description":"The type of encoding used on the data."},{"key":"Content-Language","value":"en","description":"The language the content is in"},{"key":"Content-Length","value":"272","description":"The length of the response body in octets (8-bit bytes)"},{"key":"Content-Type","value":"application/json; charset=UTF-8","description":"The mime type of this content"},{"key":"Date","value":"Tue, 08 May 2018 11:04:36 GMT","description":"The date and time that the message was sent"},{"key":"Keep-Alive","value":"timeout=5, max=100","description":"Custom header"},{"key":"Server","value":"Apache","description":"A name for the server"},{"key":"Upgrade","value":"h2,h2c","description":"Custom header"},{"key":"Vary","value":"Accept-Encoding","description":"Tells downstream proxies how to match future request headers to decide whether the cached response can be used rather than requesting a fresh one from the origin server."},{"key":"X-Powered-By","value":"capture API","description":"Specifies the technology (ASP.NET, PHP, JBoss, e.g.) supporting the web application (version details are often in X-Runtime, X-Version, or X-AspNet-Version)"}],"cookie":[],"responseTime":null,"body":"{\"status\":200,\"data\":{\"groups\":[{\"id_category\":\"17\",\"id_parent\":\"0\",\"publish\":\"1\",\"public\":\"1\",\"name\":\"World War 1 diary\"},{\"id_category\":\"12\",\"id_parent\":\"0\",\"publish\":\"1\",\"public\":\"1\",\"name\":\"Geometry in Nature\"},{\"id_category\":\"11\",\"id_parent\":\"0\",\"publish\":\"1\",\"public\":\"1\",\"name\":\"Down on the Farm\"},{\"id_category\":\"10\",\"id_parent\":\"0\",\"publish\":\"1\",\"public\":\"1\",\"name\":\"People\",\"children\":[{\"id_category\":\"16\",\"id_parent\":\"10\",\"publish\":\"1\",\"public\":\"1\",\"name\":\"Sailing\"}]},{\"id_category\":\"9\",\"id_parent\":\"0\",\"publish\":\"1\",\"public\":\"1\",\"name\":\"Food\"}]},\"debug\":{\"conditions\":\"id_parent = :pid: and publish = 1 and public = 1 and gallery = 0 and id_type = 1\",\"bind\":{\"pid\":0},\"type\":[1]}}{\r\n \"status\": 200,\r\n \"data\": {\r\n \"groups\": [\r\n {\r\n \"id_category\": 45,\r\n \"id_parent\": 0,\r\n \"publish\": 1,\r\n \"public\": 0,\r\n \"name\": \"Red\",\r\n \"children\": [\r\n {\r\n \"id_category\": 46,\r\n \"id_parent\": 45,\r\n \"publish\": 1,\r\n \"public\": 1,\r\n \"name\": \"Red 1.1\"\r\n }\r\n ]\r\n },\r\n {\r\n \"id_category\": 44,\r\n \"id_parent\": 0,\r\n \"publish\": 1,\r\n \"public\": 1,\r\n \"name\": \"Blue\"\r\n },\r\n {\r\n \"id_category\": 30,\r\n \"id_parent\": 0,\r\n \"publish\": 1,\r\n \"public\": 1,\r\n \"name\": \"Green\",\r\n \"children\": [\r\n {\r\n \"id_category\": 34,\r\n \"id_parent\": 30,\r\n \"publish\": 1,\r\n \"public\": 1,\r\n \"name\": \"Green 1.1\"\r\n }\r\n ]\r\n },\r\n {\r\n \"id_category\": 18,\r\n \"id_parent\": 0,\r\n \"publish\": 1,\r\n \"public\": 1,\r\n \"name\": \"Yellow\",\r\n \"children\": [\r\n {\r\n \"id_category\": 19,\r\n \"id_parent\": 18,\r\n \"publish\": 1,\r\n \"public\": 1,\r\n \"name\": \"Yellow 1.1\"\r\n },\r\n {\r\n \"id_category\": 22,\r\n \"id_parent\": 18,\r\n \"publish\": 1,\r\n \"public\": 1,\r\n \"name\": \"Yellow 1.2\"\r\n }\r\n ]\r\n },\r\n {\r\n \"id_category\": 15,\r\n \"id_parent\": 0,\r\n \"publish\": 1,\r\n \"public\": 1,\r\n \"name\": \"Cyan\"\r\n },\r\n {\r\n \"id_category\": 5,\r\n \"id_parent\": 0,\r\n \"publish\": 1,\r\n \"public\": 1,\r\n \"name\": \"Violet\",\r\n \"children\": [\r\n {\r\n \"id_category\": 6,\r\n \"id_parent\": 5,\r\n \"publish\": 1,\r\n \"public\": 1,\r\n \"name\": \"Violet 1.1\",\r\n \"children\": [\r\n {\r\n \"id_category\": 26,\r\n \"id_parent\": 6,\r\n \"publish\": 1,\r\n \"public\": 1,\r\n \"name\": \"Violet 1.1.1\"\r\n }\r\n ]\r\n },\r\n {\r\n \"id_category\": 7,\r\n \"id_parent\": 5,\r\n \"publish\": 1,\r\n \"public\": 1,\r\n \"name\": \"Violet 2.1\",\r\n \"children\": [\r\n {\r\n \"id_category\": 23,\r\n \"id_parent\": 7,\r\n \"publish\": 1,\r\n \"public\": 1,\r\n \"name\": \"Violet 2.1\"\r\n }\r\n ]\r\n },\r\n {\r\n \"id_category\": 25,\r\n \"id_parent\": 5,\r\n \"publish\": 1,\r\n \"public\": 1,\r\n \"name\": \"Violet 3.0\"\r\n },\r\n {\r\n \"id_category\": 33,\r\n \"id_parent\": 5,\r\n \"publish\": 1,\r\n \"public\": 1,\r\n \"name\": \"Violet 4.0\"\r\n }\r\n ]\r\n }\r\n ]\r\n }\r\n}"}],"_postman_id":"2c8f0c7b-42ac-4d0a-bbf4-d5944f71b475"},{"name":"get download requirements","event":[{"listen":"prerequest","script":{"id":"84c86df4-46d2-44e6-9641-ab6dae89ca59","exec":[""],"type":"text/javascript","packages":{},"requests":{}}},{"listen":"test","script":{"id":"05446171-ce6f-4a0d-8f23-a06f83837d6e","exec":[""],"type":"text/javascript","packages":{},"requests":{}}}],"id":"3841bcda-c392-47f7-a55d-73fa0c758b04","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"{{cw3_api_url}}/api/group/{{collection_id}}/download/peek","description":"Check download availability for the specified collection. This lists each contained asset with download capability, a list of available download types and sizes, and if any usage information is required by the download request, e.g. download reason, project title etc
\n","urlObject":{"path":["api","group","{{collection_id}}","download","peek"],"host":["{{cw3_api_url}}"],"query":[],"variable":[]}},"response":[{"id":"9e0b86e0-a9bb-4a9e-bcaa-bbf1aea31535","name":"download requirements","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"{{cw3_api_url}}/api/group/{{collection_id}}/download/peek"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Origin","value":"","description":"Specifies a URI that may access the resource. For requests without credentials, the server may specify '*' as a wildcard, thereby allowing any origin to access the resource."},{"key":"Connection","value":"Keep-Alive","description":"Options that are desired for the connection"},{"key":"Content-Encoding","value":"gzip","description":"The type of encoding used on the data."},{"key":"Content-Language","value":"en","description":"The language the content is in"},{"key":"Content-Length","value":"210","description":"The length of the response body in octets (8-bit bytes)"},{"key":"Content-Type","value":"application/json; charset=UTF-8","description":"The mime type of this content"},{"key":"Date","value":"Tue, 08 May 2018 12:10:27 GMT","description":"The date and time that the message was sent"},{"key":"Keep-Alive","value":"timeout=5, max=99","description":"Custom header"},{"key":"Server","value":"Apache","description":"A name for the server"},{"key":"Vary","value":"Accept-Encoding","description":"Tells downstream proxies how to match future request headers to decide whether the cached response can be used rather than requesting a fresh one from the origin server."},{"key":"X-Powered-By","value":"capture API","description":"Specifies the technology (ASP.NET, PHP, JBoss, e.g.) supporting the web application (version details are often in X-Runtime, X-Version, or X-AspNet-Version)"}],"cookie":[],"responseTime":null,"body":"{\r\n \"status\": 200,\r\n \"data\": {\r\n \"available\": {\r\n \"932\": {\r\n \"allowHR\": true,\r\n \"allowLR\": true,\r\n \"failMessage\": \"\",\r\n \"explain\": [\r\n \"canDownload - testing asset 932 for user 25\",\r\n \"no stored search override\",\r\n \"download rights for contact `25`\",\r\n {\r\n \"categoryDownloadGroupIds\": null,\r\n \"allowBuy\": 0,\r\n \"allowDownload\": 0,\r\n \"viewOnly\": 0,\r\n \"subscriptionAvailable\": 0,\r\n \"callMePrice\": null,\r\n \"mimeType\": null,\r\n \"assetExist\": 932\r\n },\r\n \"system wide: auth users have hr permission\",\r\n \"category download groups\",\r\n [\r\n \"\"\r\n ],\r\n \"categoryDownloadGroupIds is null or zero, so using organisation permission for hr dl; true\",\r\n \"system wide: auth users have comp permission\"\r\n ],\r\n \"exists\": true,\r\n \"thumb_mimetype\": \"image/png\",\r\n \"griditem_width\": 303,\r\n \"griditem_height\": 330,\r\n \"url\": {\r\n \"1\": \"https://thumb-url.png\",\r\n \"3\": \"https://thumb-url.png\"\r\n },\r\n \"mimetype\": \"image/png\",\r\n \"mime_type\": \"image/png\",\r\n \"base_type\": \"image\"\r\n },\r\n \"933\": {\r\n \"allowHR\": true,\r\n \"allowLR\": true,\r\n \"failMessage\": \"\",\r\n \"explain\": [\r\n \"canDownload - testing asset 933 for user 25\",\r\n \"no stored search override\",\r\n \"download rights for contact `25`\",\r\n {\r\n \"categoryDownloadGroupIds\": null,\r\n \"allowBuy\": 0,\r\n \"allowDownload\": 0,\r\n \"viewOnly\": 0,\r\n \"subscriptionAvailable\": 0,\r\n \"callMePrice\": null,\r\n \"mimeType\": null,\r\n \"assetExist\": 933\r\n },\r\n \"system wide: auth users have hr permission\",\r\n \"category download groups\",\r\n [\r\n \"\"\r\n ],\r\n \"categoryDownloadGroupIds is null or zero, so using organisation permission for hr dl; true\",\r\n \"system wide: auth users have comp permission\"\r\n ],\r\n \"exists\": true,\r\n \"thumb_mimetype\": \"image/png\",\r\n \"griditem_width\": 303,\r\n \"griditem_height\": 330,\r\n \"url\": {\r\n \"1\": \"https://thumb-url.png\",\r\n \"3\": \"https://thumb-url.png\"\r\n },\r\n \"mimetype\": \"image/png\",\r\n \"mime_type\": \"image/png\",\r\n \"base_type\": \"image\"\r\n }\r\n },\r\n \"saveas\": {\r\n \"zip\": \"Zip Archive\",\r\n \"pdf\": \"PDF Contact Sheet\",\r\n \"pptx\": \"Powerpoint Presentation\",\r\n \"odp\": \"OpenDocument Presentation \"\r\n },\r\n \"usage\": [],\r\n \"sizes\": [\r\n {\r\n \"id_download_size\": 0,\r\n \"base_type\": \"other\",\r\n \"name\": \"Original Full Size File\",\r\n \"licencedetails\": null\r\n },\r\n {\r\n \"id_download_size\": 1,\r\n \"base_type\": \"image\",\r\n \"name\": \"Original Full Size File\",\r\n \"licencedetails\": \"\"\r\n },\r\n {\r\n \"id_download_size\": 2,\r\n \"base_type\": \"image\",\r\n \"name\": \"A4 (3508 pixels, 300 dpi)\",\r\n \"licencedetails\": \"\"\r\n },\r\n {\r\n \"id_download_size\": 3,\r\n \"base_type\": \"image\",\r\n \"name\": \"A5 (2480 pixels, 300 dpi)\",\r\n \"licencedetails\": \"\"\r\n },\r\n {\r\n \"id_download_size\": 4,\r\n \"base_type\": \"image\",\r\n \"name\": \"A6 (1754 pixels, 300 dpi)\",\r\n \"licencedetails\": \"\"\r\n },\r\n {\r\n \"id_download_size\": 5,\r\n \"base_type\": \"image\",\r\n \"name\": \"Powerpoint / Word (1024 pixels, 72 dpi)\",\r\n \"licencedetails\": \"\"\r\n },\r\n {\r\n \"id_download_size\": 6,\r\n \"base_type\": \"image\",\r\n \"name\": \"Web Large (768 pixels, 72 dpi)\",\r\n \"licencedetails\": \"\"\r\n },\r\n {\r\n \"id_download_size\": 7,\r\n \"base_type\": \"image\",\r\n \"name\": \"Web Preview (451 pixels, 72 dpi)\",\r\n \"licencedetails\": \"\"\r\n },\r\n {\r\n \"id_download_size\": 8,\r\n \"base_type\": \"image\",\r\n \"name\": \"Web Thumbnail (160 pixels, 72 dpi)\",\r\n \"licencedetails\": \"\"\r\n },\r\n {\r\n \"id_download_size\": 9,\r\n \"base_type\": \"video\",\r\n \"name\": \"High Resolution\",\r\n \"licencedetails\": \"\"\r\n },\r\n {\r\n \"id_download_size\": 12,\r\n \"base_type\": \"video\",\r\n \"name\": \"Low Resolution\",\r\n \"licencedetails\": \"\"\r\n },\r\n {\r\n \"id_download_size\": 13,\r\n \"base_type\": \"image\",\r\n \"name\": \"Magnifi 1920\",\r\n \"licencedetails\": \"\"\r\n }\r\n ]\r\n }\r\n}"}],"_postman_id":"3841bcda-c392-47f7-a55d-73fa0c758b04"},{"name":"download a collection","event":[{"listen":"test","script":{"id":"9441db95-dfc7-45bd-9f68-3409b239121f","exec":["// Data Access token Status -> OK","pm.test(\"Ouath Extend Request \", function () {"," var jsonData = pm.response.json();"," pm.expect(jsonData.status).to.eql(200);","});","","//Getting data filename-> OK","pm.test(\"General response for Data filename \", function () {"," pm.response.to.have.jsonBody(\"data.filename\");","});","","","//Getting data mime_type-> OK","pm.test(\"General response for Data mime_type \", function () {"," pm.response.to.have.jsonBody(\"data.mime_type\");","});","","","//Getting data filesize> OK","pm.test(\"General response for Data filesize \", function () {"," pm.response.to.have.jsonBody(\"data.filesize\");","});","","//Getting data url--> OK","pm.test(\"General response for Data url \", function () {"," pm.response.to.have.jsonBody(\"data.url\");","});","","","// Catching the error message and display the status ","","pm.test(\"General response Status(500)\", function () {"," pm.response.to.be.ok; //HTTP 500","})","","pm.test(\"General error response\", function () {"," pm.response.to.not.have.jsonBody(\"error\"); ","});","","pm.test(\"General error response with the message\", function () {"," pm.response.to.not.have.jsonBody(\"error.message\"); ","});","","pm.test(\"showing the summary response \", function () {"," pm.response.to.not.have.jsonBody(\"error.summary\"); ","});","","pm.test(\"showing the summary order_id \", function () {"," pm.response.to.not.have.jsonBody(\"error.order_id\"); ","});","","","","","//The Below test should be in ALL API calls as it is a general test. Response time may need tweaking for some queries.","pm.test(\"General response (Response Time)\", function () {"," pm.expect(pm.response.responseTime).to.be.below(771); //Quicker than 150ms","});"],"type":"text/javascript","packages":{},"requests":{}}}],"id":"503eb1ae-e75d-48be-b347-c30f5ee946d0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"{{cw3_api_url}}/api/group/{{collection_id}}/download?saveas=pdf&type_of_use=use for this group&project_title=Example Project 1","description":"Test: Download group an API call endpoint.
\nUse Case : When the user downloads the API endpoint, it will downloads a specific group's assets as zip/pptx/odp.
\nResponse Status: 200 OK
\n","urlObject":{"path":["api","group","{{collection_id}}","download"],"host":["{{cw3_api_url}}"],"query":[{"description":{"content":"zip,pdf,pptx,odp
\n","type":"text/plain"},"key":"saveas","value":"pdf"},{"key":"type_of_use","value":"use for this group"},{"key":"project_title","value":"Example Project 1"}],"variable":[]}},"response":[{"id":"34b75200-e0ca-4344-80d8-6f9e988f1c74","name":"Download group","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"{{cw3_api_url}}/api/group/12/download?access_token={{access_token_capture}}&saveas=pdf&type_of_use=use for this group&project_title= test test","host":["{{cw3_api_url}}"],"path":["api","group","12","download"],"query":[{"key":"access_token","value":"{{access_token_capture}}"},{"key":"saveas","value":"pdf","description":"zip,pdf,pptx,odp"},{"key":"type_of_use","value":"use for this group"},{"key":"project_title","value":" test test"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Origin","value":"","name":"Access-Control-Allow-Origin","description":"Specifies a URI that may access the resource. For requests without credentials, the server may specify '*' as a wildcard, thereby allowing any origin to access the resource."},{"key":"Connection","value":"Upgrade, Keep-Alive","name":"Connection","description":"Options that are desired for the connection"},{"key":"Content-Encoding","value":"gzip","name":"Content-Encoding","description":"The type of encoding used on the data."},{"key":"Content-Language","value":"en","name":"Content-Language","description":"The language the content is in"},{"key":"Content-Length","value":"1145","name":"Content-Length","description":"The length of the response body in octets (8-bit bytes)"},{"key":"Content-Type","value":"application/json; charset=UTF-8","name":"Content-Type","description":"The mime type of this content"},{"key":"Date","value":"Fri, 11 May 2018 13:51:26 GMT","name":"Date","description":"The date and time that the message was sent"},{"key":"Keep-Alive","value":"timeout=5, max=100","name":"Keep-Alive","description":"Custom header"},{"key":"Server","value":"Apache","name":"Server","description":"A name for the server"},{"key":"Upgrade","value":"h2,h2c","name":"Upgrade","description":"Custom header"},{"key":"Vary","value":"Accept-Encoding","name":"Vary","description":"Tells downstream proxies how to match future request headers to decide whether the cached response can be used rather than requesting a fresh one from the origin server."},{"key":"X-Powered-By","value":"capture API","name":"X-Powered-By","description":"Specifies the technology (ASP.NET, PHP, JBoss, e.g.) supporting the web application (version details are often in X-Runtime, X-Version, or X-AspNet-Version)"}],"cookie":[],"responseTime":null,"body":"{\"status\":200,\"data\":{\"filename\":\"Geometry_in_Nature.pdf\",\"mime_type\":\"application\\/pdf\",\"filesize\":1916669,\"url\":\"http:\\/\\/demo.dev2.captureweb.net\\/ddl\\/2018-05-11\\/55\\/Geometry_in_Nature.pdf\",\"order_id\":\"101\",\"debug\":{\"rename_status\":true,\"tempfile\":\"H:\\\\hosting\\\\temp\\\\demo\\\\Demo_pdf_5af59fdec1bf2\",\"contents\":{\"message\":\"created pdf file\",\"tempfile\":\"H:\\\\hosting\\\\temp\\\\demo\\\\Demo_pdf_5af59fdec1bf2\",\"mime_type\":\"application\\/pdf\",\"extension\":\"pdf\",\"contents\":[{\"id_asset\":466473,\"size_id\":\"1024\",\"mime_type\":\"\",\"original_filename\":\"3051.jpg\",\"save_as\":\"pdf\",\"pdf_image_path\":\"H:\\\\hosting\\\\cdn\\\\demo\\\\thumbs\\\\1555\\\\3\\\\2498fb766c90e59d2b11bb59328127f1.jpg\",\"pdf_image_caption\":\"3051\"},{\"id_asset\":466472,\"size_id\":\"1024\",\"mime_type\":\"\",\"original_filename\":\"3028.jpg\",\"save_as\":\"pdf\",\"pdf_image_path\":\"H:\\\\hosting\\\\cdn\\\\demo\\\\thumbs\\\\1555\\\\3\\\\603f5b989add2a28f25ecf66ffad39ec.jpg\",\"pdf_image_caption\":\"3028\"},{\"id_asset\":466471,\"size_id\":\"1024\",\"mime_type\":\"\",\"original_filename\":\"2757.jpg\",\"save_as\":\"pdf\",\"pdf_image_path\":\"H:\\\\hosting\\\\cdn\\\\demo\\\\thumbs\\\\1555\\\\3\\\\901ca2d23ec95f6430df721aa17c54df.jpg\",\"pdf_image_caption\":\"2757\"},{\"id_asset\":466470,\"size_id\":\"1024\",\"mime_type\":\"\",\"original_filename\":\"2750.jpg\",\"save_as\":\"pdf\",\"pdf_image_path\":\"H:\\\\hosting\\\\cdn\\\\demo\\\\thumbs\\\\1555\\\\3\\\\5072e4537a733d7cd0a9924ae3b265cf.jpg\",\"pdf_image_caption\":\"2750\"},{\"id_asset\":466469,\"size_id\":\"1024\",\"mime_type\":\"\",\"original_filename\":\"2635.jpg\",\"save_as\":\"pdf\",\"pdf_image_path\":\"H:\\\\hosting\\\\cdn\\\\demo\\\\thumbs\\\\1555\\\\3\\\\387c4cc119e3b07c5edbe8693f080981.jpg\",\"pdf_image_caption\":\"2635\"},{\"id_asset\":466468,\"size_id\":\"1024\",\"mime_type\":\"\",\"original_filename\":\"2295.jpg\",\"save_as\":\"pdf\",\"pdf_image_path\":\"H:\\\\hosting\\\\cdn\\\\demo\\\\thumbs\\\\1555\\\\3\\\\a158a4382f3460884a9955d4b68ecde6.jpg\",\"pdf_image_caption\":\"2295\"},{\"id_asset\":466467,\"size_id\":\"1024\",\"mime_type\":\"\",\"original_filename\":\"2256.jpg\",\"save_as\":\"pdf\",\"pdf_image_path\":\"H:\\\\hosting\\\\cdn\\\\demo\\\\thumbs\\\\1555\\\\3\\\\b9dd6f35a441a3069ac6174607fb3978.jpg\",\"pdf_image_caption\":\"2256\"},{\"id_asset\":466466,\"size_id\":\"1024\",\"mime_type\":\"\",\"original_filename\":\"2093.jpg\",\"save_as\":\"pdf\",\"pdf_image_path\":\"H:\\\\hosting\\\\cdn\\\\demo\\\\thumbs\\\\1555\\\\3\\\\3f4254caaaa4d8b275d7aa0b88cade5d.jpg\",\"pdf_image_caption\":\"2093\"},{\"id_asset\":466465,\"size_id\":\"1024\",\"mime_type\":\"\",\"original_filename\":\"2085.jpg\",\"save_as\":\"pdf\",\"pdf_image_path\":\"H:\\\\hosting\\\\cdn\\\\demo\\\\thumbs\\\\1555\\\\3\\\\2143bf6420361e1938658a27c93e9ca9.jpg\",\"pdf_image_caption\":\"2085\"},{\"id_asset\":466464,\"size_id\":\"1024\",\"mime_type\":\"\",\"original_filename\":\"1989.jpg\",\"save_as\":\"pdf\",\"pdf_image_path\":\"H:\\\\hosting\\\\cdn\\\\demo\\\\thumbs\\\\1555\\\\3\\\\37180cc4d1a880f2554c5be1d0b8ce2f.jpg\",\"pdf_image_caption\":\"1989\"},{\"id_asset\":466463,\"size_id\":\"1024\",\"mime_type\":\"\",\"original_filename\":\"1972.jpg\",\"save_as\":\"pdf\",\"pdf_image_path\":\"H:\\\\hosting\\\\cdn\\\\demo\\\\thumbs\\\\1555\\\\3\\\\5acb28639de466a8100220919f2d92d1.jpg\",\"pdf_image_caption\":\"1972\"},{\"id_asset\":466462,\"size_id\":\"1024\",\"mime_type\":\"\",\"original_filename\":\"1925.jpg\",\"save_as\":\"pdf\",\"pdf_image_path\":\"H:\\\\hosting\\\\cdn\\\\demo\\\\thumbs\\\\1555\\\\3\\\\dcd9ecdee05a52a1347d574dd06ab3f9.jpg\",\"pdf_image_caption\":\"1925\"},{\"id_asset\":466461,\"size_id\":\"1024\",\"mime_type\":\"\",\"original_filename\":\"1693.jpg\",\"save_as\":\"pdf\",\"pdf_image_path\":\"H:\\\\hosting\\\\cdn\\\\demo\\\\thumbs\\\\1555\\\\3\\\\1e1289956c6dfbd20e104822f360d438.jpg\",\"pdf_image_caption\":\"1693\"},{\"id_asset\":466460,\"size_id\":\"1024\",\"mime_type\":\"\",\"original_filename\":\"1654.jpg\",\"save_as\":\"pdf\",\"pdf_image_path\":\"H:\\\\hosting\\\\cdn\\\\demo\\\\thumbs\\\\1555\\\\3\\\\2e63384260a63eeddff4711d76ecdc49.jpg\",\"pdf_image_caption\":\"1654\"},{\"id_asset\":466459,\"size_id\":\"1024\",\"mime_type\":\"\",\"original_filename\":\"1429.jpg\",\"save_as\":\"pdf\",\"pdf_image_path\":\"H:\\\\hosting\\\\cdn\\\\demo\\\\thumbs\\\\1555\\\\3\\\\fed31e9068118ac19e2bf7566d4c6885.jpg\",\"pdf_image_caption\":\"1429\"},{\"id_asset\":466458,\"size_id\":\"1024\",\"mime_type\":\"\",\"original_filename\":\"1360.jpg\",\"save_as\":\"pdf\",\"pdf_image_path\":\"H:\\\\hosting\\\\cdn\\\\demo\\\\thumbs\\\\1555\\\\3\\\\12a75b6eae569dcf9f948372bd4e2c0c.jpg\",\"pdf_image_caption\":\"1360\"},{\"id_asset\":466457,\"size_id\":\"1024\",\"mime_type\":\"\",\"original_filename\":\"1224.jpg\",\"save_as\":\"pdf\",\"pdf_image_path\":\"H:\\\\hosting\\\\cdn\\\\demo\\\\thumbs\\\\1555\\\\3\\\\7edd9614bf49c833786f777ec9eb8023.jpg\",\"pdf_image_caption\":\"1224\"},{\"id_asset\":466456,\"size_id\":\"1024\",\"mime_type\":\"\",\"original_filename\":\"813.jpg\",\"save_as\":\"pdf\",\"pdf_image_path\":\"H:\\\\hosting\\\\cdn\\\\demo\\\\thumbs\\\\1555\\\\3\\\\17078699b9b7f285edff3e1dd8d88a39.jpg\",\"pdf_image_caption\":\"813\"},{\"id_asset\":466455,\"size_id\":\"1024\",\"mime_type\":\"\",\"original_filename\":\"680.jpg\",\"save_as\":\"pdf\",\"pdf_image_path\":\"H:\\\\hosting\\\\cdn\\\\demo\\\\thumbs\\\\1555\\\\3\\\\a3ac597b5b4c381674c32c234b1eaaf5.jpg\",\"pdf_image_caption\":\"680\"},{\"id_asset\":466454,\"size_id\":\"1024\",\"mime_type\":\"\",\"original_filename\":\"639.jpg\",\"save_as\":\"pdf\",\"pdf_image_path\":\"H:\\\\hosting\\\\cdn\\\\demo\\\\thumbs\\\\1555\\\\3\\\\270481c0c24aef52dac2a6f14756ef3e.jpg\",\"pdf_image_caption\":\"639\"},{\"id_asset\":466453,\"size_id\":\"1024\",\"mime_type\":\"\",\"original_filename\":\"517.jpg\",\"save_as\":\"pdf\",\"pdf_image_path\":\"H:\\\\hosting\\\\cdn\\\\demo\\\\thumbs\\\\1555\\\\3\\\\6745a3c6f9a3b974fec7979f55d3050d.jpg\",\"pdf_image_caption\":\"517\"}]},\"assetIdList\":[466473,466472,466471,466470,466469,466468,466467,466466,466465,466464,466463,466462,466461,466460,466459,466458,466457,466456,466455,466454,466453],\"sizeIdList\":[\"1024\",\"1024\",\"1024\",\"1024\",\"1024\",\"1024\",\"1024\",\"1024\",\"1024\",\"1024\",\"1024\",\"1024\",\"1024\",\"1024\",\"1024\",\"1024\",\"1024\",\"1024\",\"1024\",\"1024\",\"1024\"]}}}"}],"_postman_id":"503eb1ae-e75d-48be-b347-c30f5ee946d0"}],"id":"5de88f77-687d-4e6f-9aeb-9ef6ce4eebb8","description":"Collection retrieval. Collections are hierarchichal groupings of assets
\n","event":[{"listen":"prerequest","script":{"id":"7dfb3e36-7571-4b26-aa78-cf072eafaa82","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"ef62a291-7530-443b-8eac-f3d328462735","type":"text/javascript","exec":[""]}}],"_postman_id":"5de88f77-687d-4e6f-9aeb-9ef6ce4eebb8"},{"name":"Contributor","item":[{"name":"Contributor Upload","event":[{"listen":"test","script":{"id":"f3dd6bb1-cf13-4a03-8b9d-cb89b0e4d450","exec":[""],"type":"text/javascript","packages":{},"requests":{}}},{"listen":"prerequest","script":{"id":"37ddad9f-e281-4f74-a03a-09f08b6a117d","exec":[""],"type":"text/javascript","packages":{},"requests":{}}}],"id":"d3021b41-bad8-487f-966a-f1926fb553c6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{access_key_contributor}}"},"isInherited":false},"method":"POST","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"key":"files[]","type":"file","value":null}]},"url":"{{cw3_api_url}}/api/contributor/upload","description":"Test: Contributor Upload API call endpoint
\nUse Case: When the user access an API call endpoint, the user will be able to upload the file as a contributor. The user will be required to supply the access token.
\nResponse Status: 200 OK
\n","urlObject":{"path":["api","contributor","upload"],"host":["{{cw3_api_url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"d3021b41-bad8-487f-966a-f1926fb553c6"},{"name":"Contributor allowed file types (dot extension)","event":[{"listen":"test","script":{"id":"83bbd261-21b7-4fa9-a632-5195cb0d2d1a","exec":[""],"type":"text/javascript","packages":{},"requests":{}}},{"listen":"prerequest","script":{"id":"fa011ac8-a22f-40fa-845a-d9170c23683f","exec":[""],"type":"text/javascript","packages":{},"requests":{}}}],"id":"5d9e6969-03cd-4ec0-b7e9-4e9e678f0029","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{access_key_contributor}}"},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"{{cw3_api_url}}/api/contributor/filetypes","description":"Test: Contributor allowed file types endpoint.
\nUse Case:When you hit the API call endpoint, it will return all the hot folder writeable by the system.
\nResponse Status : 200 OK
\n","urlObject":{"path":["api","contributor","filetypes"],"host":["{{cw3_api_url}}"],"query":[],"variable":[]}},"response":[{"id":"54a82758-4a2b-48b8-9956-d82f002906e2","name":"contributor allowed file types (dot extension)","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"{{access_token_contributor}}","type":"text"}],"url":"{{cw3_api_url}}/api/contributor/filetypes"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Origin","value":"","description":"Specifies a URI that may access the resource. For requests without credentials, the server may specify '*' as a wildcard, thereby allowing any origin to access the resource."},{"key":"Connection","value":"Upgrade, Keep-Alive","description":"Options that are desired for the connection"},{"key":"Content-Encoding","value":"gzip","description":"The type of encoding used on the data."},{"key":"Content-Language","value":"en","description":"The language the content is in"},{"key":"Content-Length","value":"189","description":"The length of the response body in octets (8-bit bytes)"},{"key":"Content-Type","value":"application/json; charset=UTF-8","description":"The mime type of this content"},{"key":"Date","value":"Wed, 09 May 2018 12:47:26 GMT","description":"The date and time that the message was sent"},{"key":"Keep-Alive","value":"timeout=5, max=100","description":"Custom header"},{"key":"Server","value":"Apache","description":"A name for the server"},{"key":"Upgrade","value":"h2,h2c","description":"Custom header"},{"key":"Vary","value":"Accept-Encoding","description":"Tells downstream proxies how to match future request headers to decide whether the cached response can be used rather than requesting a fresh one from the origin server."},{"key":"X-Powered-By","value":"capture API","description":"Specifies the technology (ASP.NET, PHP, JBoss, e.g.) supporting the web application (version details are often in X-Runtime, X-Version, or X-AspNet-Version)"}],"cookie":[],"responseTime":null,"body":"{\"status\":200,\"data\":[\"avi\",\"wmv\",\"mpg\",\"mpeg\",\"flv\",\"mov\",\"dv\",\"mp4\",\"ogv\",\"mkv\",\"m4v\",\"div\",\"aac\",\"wav\",\"wma\",\"m4a\",\"mp3\",\"swf\",\"pdf\",\"psd\",\"eps\",\"eps2\",\"eps3\",\"epsf\",\"epi\",\"epsi\",\"ept\",\"doc\",\"xls\",\"ai\",\"indd\",\"jpg\",\"jpeg\",\"tif\",\"tiff\",\"gif\",\"bmp\",\"png\",\"pcd\",\"dng\",\"txt\",\"log\",\"ini\",\"csv\",\"sql\",\"xml\",\"htm\",\"html\",\"docx\",\"zip\",\"xlsx\"]}"}],"_postman_id":"5d9e6969-03cd-4ec0-b7e9-4e9e678f0029"}],"id":"6b4a9dc4-b68a-4f23-aafc-0bbc0cea426d","description":"Certain users can be set as contributors, in which case they are allowed to see the basic file upload panel and upload files.The system maintains a hotfolder specific to the user where all their uploads are placed and optionally automatically pulled into the system.
Test: Lightbox endpoint API call
\nUse Case: When the API is called via a URL, the user will be able to create a new lightbox record in the database. Although the user will have to be authenticated and provide the access token in params.
\nResponse Status: 200 OK
\n","urlObject":{"path":["api","lightbox"],"host":["{{cw3_api_url}}"],"query":[],"variable":[]}},"response":[{"id":"890e8735-df79-4d50-a242-b7b090cafc75","name":"create lightbox","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"{{access_token_user}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"name\":\"lighty mclightbox\",\n \"notes\":\"yet another lightbox\"\n}\n\n\n"},"url":"{{cw3_api_url}}/api/lightbox"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Origin","value":"","description":"Specifies a URI that may access the resource. For requests without credentials, the server may specify '*' as a wildcard, thereby allowing any origin to access the resource."},{"key":"Connection","value":"Keep-Alive","description":"Options that are desired for the connection"},{"key":"Content-Encoding","value":"gzip","description":"The type of encoding used on the data."},{"key":"Content-Language","value":"en","description":"The language the content is in"},{"key":"Content-Length","value":"103","description":"The length of the response body in octets (8-bit bytes)"},{"key":"Content-Type","value":"application/json; charset=UTF-8","description":"The mime type of this content"},{"key":"Date","value":"Wed, 09 May 2018 13:23:12 GMT","description":"The date and time that the message was sent"},{"key":"Keep-Alive","value":"timeout=5, max=99","description":"Custom header"},{"key":"Server","value":"Apache","description":"A name for the server"},{"key":"Vary","value":"Accept-Encoding","description":"Tells downstream proxies how to match future request headers to decide whether the cached response can be used rather than requesting a fresh one from the origin server."},{"key":"X-Powered-By","value":"capture API","description":"Specifies the technology (ASP.NET, PHP, JBoss, e.g.) supporting the web application (version details are often in X-Runtime, X-Version, or X-AspNet-Version)"}],"cookie":[],"responseTime":null,"body":"{\"status\":200,\"data\":{\"message\":\"created lightbox\",\"idlightbox\":\"191\",\"name\":\"lighty2 mclightbox (7)\"}}"}],"_postman_id":"ffa34fd4-bcd5-4196-aedb-34ccfb8b6910"},{"name":"Delete Lightbox","event":[{"listen":"test","script":{"id":"7869f2df-0c0d-40a2-9170-0d1f13781702","exec":[""],"type":"text/javascript","packages":{},"requests":{}}},{"listen":"prerequest","script":{"packages":{},"type":"text/javascript"}}],"id":"1bb39933-a655-4fea-a021-aa033db65320","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"url":"{{cw3_api_url}}/api/lightbox/{{lightbox_id}}","description":"Test: Deleting the Lightbox API endpoint
\nUse case: This API point will require the access token to be able to delete the record in the database. This will also delete related records, e.g. lightbox items, emails, shares etc - anything that keys off the main lightbox record;
\nResponse Status: 200 OK
\nNB: If you try to delete the record again which has already been deleted, you will see the response 400 as bad request .No record existed in the database.
\n","urlObject":{"path":["api","lightbox","{{lightbox_id}}"],"host":["{{cw3_api_url}}"],"query":[],"variable":[]}},"response":[{"id":"74537a96-91d7-42f8-9162-4dd89358d187","name":"delete lightbox","originalRequest":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"{{access_token_user}}","type":"text"}],"url":"{{cw3_api_url}}/api/lightbox/{{lightbox_id}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Origin","value":"","description":"Specifies a URI that may access the resource. For requests without credentials, the server may specify '*' as a wildcard, thereby allowing any origin to access the resource."},{"key":"Connection","value":"Upgrade, Keep-Alive","description":"Options that are desired for the connection"},{"key":"Content-Encoding","value":"gzip","description":"The type of encoding used on the data."},{"key":"Content-Language","value":"en","description":"The language the content is in"},{"key":"Content-Length","value":"86","description":"The length of the response body in octets (8-bit bytes)"},{"key":"Content-Type","value":"application/json; charset=UTF-8","description":"The mime type of this content"},{"key":"Date","value":"Wed, 09 May 2018 15:20:32 GMT","description":"The date and time that the message was sent"},{"key":"Keep-Alive","value":"timeout=5, max=100","description":"Custom header"},{"key":"Server","value":"Apache","description":"A name for the server"},{"key":"Upgrade","value":"h2,h2c","description":"Custom header"},{"key":"Vary","value":"Accept-Encoding","description":"Tells downstream proxies how to match future request headers to decide whether the cached response can be used rather than requesting a fresh one from the origin server."},{"key":"X-Powered-By","value":"capture API","description":"Specifies the technology (ASP.NET, PHP, JBoss, e.g.) supporting the web application (version details are often in X-Runtime, X-Version, or X-AspNet-Version)"}],"cookie":[],"responseTime":null,"body":"{\r\n \"status\":200,\r\n \"data\":{\r\n \"message\":\"lightbox `lighty mclightbox` deleted\"\r\n }\r\n}"}],"_postman_id":"1bb39933-a655-4fea-a021-aa033db65320"},{"name":"Add Items","event":[{"listen":"test","script":{"id":"f7d669aa-b465-4a07-b6c2-5262d043c144","exec":[""],"type":"text/javascript","packages":{},"requests":{}}}],"id":"ec3a3399-7577-4eef-9986-982b63a11735","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"assets\":[{{asset_id_comma_separated_list}}]\n}\n"},"url":"{{cw3_api_url}}/api/lightbox/{{lightbox_id}}/items","description":"Test: Add Lightbox API call endpoint.
\nUse Case: When the API endpoint is called by passing the Lightbox ID, the authenticated user will be able to move the item into Lightbox.
\nReponses Status: 200 OK if you send the same request you will receive status 409 which means conflict.
\n","urlObject":{"path":["api","lightbox","{{lightbox_id}}","items"],"host":["{{cw3_api_url}}"],"query":[],"variable":[]}},"response":[{"id":"43d86379-eada-481e-9cbc-fddfc80bd598","name":"Add items","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"{{access_token_user}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"assets\":[{{asset_id_comma_separated_list}}]\n}\n"},"url":"{{cw3_api_url}}/api/lightbox/{{lightbox_id}}/items"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Origin","value":"","description":"Specifies a URI that may access the resource. For requests without credentials, the server may specify '*' as a wildcard, thereby allowing any origin to access the resource."},{"key":"Connection","value":"Upgrade, Keep-Alive","description":"Options that are desired for the connection"},{"key":"Content-Encoding","value":"gzip","description":"The type of encoding used on the data."},{"key":"Content-Language","value":"en","description":"The language the content is in"},{"key":"Content-Length","value":"132","description":"The length of the response body in octets (8-bit bytes)"},{"key":"Content-Type","value":"application/json; charset=UTF-8","description":"The mime type of this content"},{"key":"Date","value":"Thu, 10 May 2018 10:55:46 GMT","description":"The date and time that the message was sent"},{"key":"Keep-Alive","value":"timeout=5, max=100","description":"Custom header"},{"key":"Server","value":"Apache","description":"A name for the server"},{"key":"Upgrade","value":"h2,h2c","description":"Custom header"},{"key":"Vary","value":"Accept-Encoding","description":"Tells downstream proxies how to match future request headers to decide whether the cached response can be used rather than requesting a fresh one from the origin server."},{"key":"X-Powered-By","value":"capture API","description":"Specifies the technology (ASP.NET, PHP, JBoss, e.g.) supporting the web application (version details are often in X-Runtime, X-Version, or X-AspNet-Version)"}],"cookie":[],"responseTime":null,"body":"{\"status\":200,\"data\":{\"message\":\"add to lightbox\",\"idlightbox\":\"191\",\"name\":\"lighty2 mclightbox (7)\",\"requested\":[23359,23360,23361],\"added\":1}}"}],"_postman_id":"ec3a3399-7577-4eef-9986-982b63a11735"},{"name":"Add Items to Default","id":"a1fb6149-0b13-4165-943c-8f94e2d89fd2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"assets\":[{{asset_id_comma_separated_list}}]\n}\n"},"url":"{{cw3_api_url}}/api/lightbox/default/items","description":"Purpose: Add assets to default lightbox. Users can have multiple lightboxes, but can have one set as the default to allow quick add operations
\nUsage: the request should contain the users access token in the Authorization:Bearer Token header. The endpoint will look up the correct lightbox to use.
\nResponse Status: 200 OK on success. Attempting to add assets already in the lightbox will return 409 Conflict
\n","urlObject":{"path":["api","lightbox","default","items"],"host":["{{cw3_api_url}}"],"query":[],"variable":[]}},"response":[{"id":"41365f62-0816-41f7-8467-88bbfce473d8","name":"Add items to default","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"assets\":[{{asset_id_comma_separated_list}}]\n}\n"},"url":"{{cw3_api_url}}/api/lightbox/default/items"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Origin","value":"","description":"Specifies a URI that may access the resource. For requests without credentials, the server may specify '*' as a wildcard, thereby allowing any origin to access the resource."},{"key":"Connection","value":"Upgrade, Keep-Alive","description":"Options that are desired for the connection"},{"key":"Content-Encoding","value":"gzip","description":"The type of encoding used on the data."},{"key":"Content-Language","value":"en","description":"The language the content is in"},{"key":"Content-Length","value":"124","description":"The length of the response body in octets (8-bit bytes)"},{"key":"Content-Type","value":"application/json; charset=UTF-8","description":"The mime type of this content"},{"key":"Date","value":"Thu, 10 May 2018 11:23:03 GMT","description":"The date and time that the message was sent"},{"key":"Keep-Alive","value":"timeout=5, max=100","description":"Custom header"},{"key":"Server","value":"Apache","description":"A name for the server"},{"key":"Upgrade","value":"h2,h2c","description":"Custom header"},{"key":"Vary","value":"Accept-Encoding","description":"Tells downstream proxies how to match future request headers to decide whether the cached response can be used rather than requesting a fresh one from the origin server."},{"key":"X-Powered-By","value":"capture API","description":"Specifies the technology (ASP.NET, PHP, JBoss, e.g.) supporting the web application (version details are often in X-Runtime, X-Version, or X-AspNet-Version)"}],"cookie":[],"responseTime":null,"body":"{\"status\":200,\"data\":{\"message\":\"add to lightbox\",\"idlightbox\":\"185\",\"name\":\"lighty2 mclightbox\",\"requested\":[23360,23361],\"added\":2}}"}],"_postman_id":"a1fb6149-0b13-4165-943c-8f94e2d89fd2"},{"name":"Delete Items","id":"bda7d6e6-00ed-43a2-8d80-efd9ddb3d93c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"assets\":[{{asset_id_comma_separated_list}}]\n}\n"},"url":"{{cw3_api_url}}/api/lightbox/{{lightbox_id}}/items","description":"Purpose: Delete multiple items from a lightbox
\nUsage: pass a list of lightbox item id's or a list of asset id's to be deleted from the lightbox
\nResponse Status: 200 OK on success. 400 bad request if the lightbox does not exists. 500 internal error if any failure during delete.
\n","urlObject":{"path":["api","lightbox","{{lightbox_id}}","items"],"host":["{{cw3_api_url}}"],"query":[],"variable":[]}},"response":[{"id":"e7034b9a-1121-4118-88b1-186db91ddb76","name":"Delete items (fail - items not in this lightbox)","originalRequest":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"assets\":[{{asset_id_comma_separated_list}}]\n}\n"},"url":"{{cw3_api_url}}/api/lightbox/{{lightbox_id}}/items"},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Origin","value":"","description":"Specifies a URI that may access the resource. For requests without credentials, the server may specify '*' as a wildcard, thereby allowing any origin to access the resource."},{"key":"Connection","value":"close","description":"Options that are desired for the connection"},{"key":"Content-Language","value":"en","description":"The language the content is in"},{"key":"Content-Type","value":"application/json; charset=UTF-8","description":"The mime type of this content"},{"key":"Date","value":"Thu, 10 May 2018 11:38:46 GMT","description":"The date and time that the message was sent"},{"key":"Server","value":"Apache","description":"A name for the server"},{"key":"Transfer-Encoding","value":"chunked","description":"The form of encoding used to safely transfer the entity to the user. Currently defined methods are: chunked, compress, deflate, gzip, identity."},{"key":"X-Powered-By","value":"capture API","description":"Specifies the technology (ASP.NET, PHP, JBoss, e.g.) supporting the web application (version details are often in X-Runtime, X-Version, or X-AspNet-Version)"}],"cookie":[],"responseTime":null,"body":"{\"status\":500,\"api_status\":{\"code\":\"fail_1000\",\"message\":\"internal system error\",\"description\":\"items not in this lightbox\"},\"error\":{\"message\":\"internal system error\",\"summary\":\"items not in this lightbox\"}}"}],"_postman_id":"bda7d6e6-00ed-43a2-8d80-efd9ddb3d93c"},{"name":"Update Lightbox","event":[{"listen":"test","script":{"id":"4a0719ce-dbd5-4a5b-b301-36751ed4a2bb","exec":[""],"type":"text/javascript","packages":{},"requests":{}}},{"listen":"prerequest","script":{"id":"6b926a4b-cd8e-472a-ac49-cd7672661782","exec":[""],"type":"text/javascript","packages":{},"requests":{}}}],"id":"cdfca3e3-4da9-4522-8724-9c9c7d281de5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"name\":\"change of name\"\n}\n"},"url":"{{cw3_api_url}}/api/lightbox/{{lightbox_id}}","description":"Purpose: Update lightbox metdata
\nUsage: This is currently limited to changing the lightbox name and the is_default setting
\nResponse Status: 200 OK
\n","urlObject":{"path":["api","lightbox","{{lightbox_id}}"],"host":["{{cw3_api_url}}"],"query":[],"variable":[]}},"response":[{"id":"609e4612-fc62-4b37-9e6f-3459968d82f4","name":"Update lightbox - change name","originalRequest":{"method":"PATCH","header":[{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"{{access_token_user}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"name\":\"changed name\"\n}\n"},"url":"{{cw3_api_url}}/api/lightbox/{{lightbox_id}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Origin","value":"","description":"Specifies a URI that may access the resource. For requests without credentials, the server may specify '*' as a wildcard, thereby allowing any origin to access the resource."},{"key":"Connection","value":"Upgrade, Keep-Alive","description":"Options that are desired for the connection"},{"key":"Content-Encoding","value":"gzip","description":"The type of encoding used on the data."},{"key":"Content-Language","value":"en","description":"The language the content is in"},{"key":"Content-Length","value":"71","description":"The length of the response body in octets (8-bit bytes)"},{"key":"Content-Type","value":"application/json; charset=UTF-8","description":"The mime type of this content"},{"key":"Date","value":"Thu, 10 May 2018 11:41:00 GMT","description":"The date and time that the message was sent"},{"key":"Keep-Alive","value":"timeout=5, max=100","description":"Custom header"},{"key":"Server","value":"Apache","description":"A name for the server"},{"key":"Upgrade","value":"h2,h2c","description":"Custom header"},{"key":"Vary","value":"Accept-Encoding","description":"Tells downstream proxies how to match future request headers to decide whether the cached response can be used rather than requesting a fresh one from the origin server."},{"key":"X-Powered-By","value":"capture API","description":"Specifies the technology (ASP.NET, PHP, JBoss, e.g.) supporting the web application (version details are often in X-Runtime, X-Version, or X-AspNet-Version)"}],"cookie":[],"responseTime":null,"body":"{\"status\":200,\"data\":{\"message\":\"lightbox updated\"}}"},{"id":"ddb20291-bcb5-4058-ac26-299e9ebc2ed1","name":"Update lightbox - set as default","originalRequest":{"method":"PATCH","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"{{access_token_user}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"is_default\":true\n}\n"},"url":"{{cw3_api_url}}/api/lightbox/{{lightbox_id}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Origin","value":"","description":"Specifies a URI that may access the resource. For requests without credentials, the server may specify '*' as a wildcard, thereby allowing any origin to access the resource."},{"key":"Connection","value":"Upgrade, Keep-Alive","description":"Options that are desired for the connection"},{"key":"Content-Encoding","value":"gzip","description":"The type of encoding used on the data."},{"key":"Content-Language","value":"en","description":"The language the content is in"},{"key":"Content-Length","value":"71","description":"The length of the response body in octets (8-bit bytes)"},{"key":"Content-Type","value":"application/json; charset=UTF-8","description":"The mime type of this content"},{"key":"Date","value":"Thu, 10 May 2018 11:50:13 GMT","description":"The date and time that the message was sent"},{"key":"Keep-Alive","value":"timeout=5, max=100","description":"Custom header"},{"key":"Server","value":"Apache","description":"A name for the server"},{"key":"Upgrade","value":"h2,h2c","description":"Custom header"},{"key":"Vary","value":"Accept-Encoding","description":"Tells downstream proxies how to match future request headers to decide whether the cached response can be used rather than requesting a fresh one from the origin server."},{"key":"X-Powered-By","value":"capture API","description":"Specifies the technology (ASP.NET, PHP, JBoss, e.g.) supporting the web application (version details are often in X-Runtime, X-Version, or X-AspNet-Version)"}],"cookie":[],"responseTime":null,"body":"{\"status\":200,\"data\":{\"message\":\"lightbox updated\"}}"}],"_postman_id":"cdfca3e3-4da9-4522-8724-9c9c7d281de5"},{"name":"Get specific Lightbox","event":[{"listen":"prerequest","script":{"id":"97e71138-072f-473c-aae8-04e883d6f645","exec":[""],"type":"text/javascript","packages":{},"requests":{}}},{"listen":"test","script":{"id":"0c4dc1ec-2e7f-4e0a-84a1-b0c7a487ff1d","exec":[""],"type":"text/javascript","packages":{},"requests":{}}}],"id":"e46601c1-87e2-437e-96cd-cba1e8613344","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{access_key_user}}"},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"{{cw3_api_url}}/api/lightbox/{{lightbox_id}}?children=true&selected=1&itemsPerPage=10","description":"Test: Get a Specific Lightbox API call endpoint
\nUse Case: When the API is called via the URL by passing the ID for a specific lightbox, followed the access token, the user will get a specific lightbox and it's contained items.
\nResponse Status: 200 OK
\n","urlObject":{"path":["api","lightbox","{{lightbox_id}}"],"host":["{{cw3_api_url}}"],"query":[{"description":{"content":"get all assets from this lightbox and its descendants
\n","type":"text/plain"},"key":"children","value":"true"},{"description":{"content":"only get assets that have been selected
\n","type":"text/plain"},"key":"selected","value":"1"},{"description":{"content":"for paging of contained assets
\n","type":"text/plain"},"key":"itemsPerPage","value":"10"},{"disabled":true,"description":{"content":"for paging
\n","type":"text/plain"},"key":"page","value":"1"},{"disabled":true,"description":{"content":"deprecated, specific client use only - only get assets that have not been marked as extracted
\n","type":"text/plain"},"key":"extracted","value":"false"}],"variable":[]}},"response":[{"id":"e6ba0287-a4c1-42d4-8646-947fba5e7889","name":"get specific lightbox","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"{{access_token_user}}","type":"text"}],"url":"{{cw3_api_url}}/api/lightbox/{{lightbox_id}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Origin","value":"","description":"Specifies a URI that may access the resource. For requests without credentials, the server may specify '*' as a wildcard, thereby allowing any origin to access the resource."},{"key":"Connection","value":"Keep-Alive","description":"Options that are desired for the connection"},{"key":"Content-Encoding","value":"gzip","description":"The type of encoding used on the data."},{"key":"Content-Language","value":"en","description":"The language the content is in"},{"key":"Content-Length","value":"165","description":"The length of the response body in octets (8-bit bytes)"},{"key":"Content-Type","value":"application/json; charset=UTF-8","description":"The mime type of this content"},{"key":"Date","value":"Wed, 09 May 2018 13:52:42 GMT","description":"The date and time that the message was sent"},{"key":"Keep-Alive","value":"timeout=5, max=99","description":"Custom header"},{"key":"Server","value":"Apache","description":"A name for the server"},{"key":"Vary","value":"Accept-Encoding","description":"Tells downstream proxies how to match future request headers to decide whether the cached response can be used rather than requesting a fresh one from the origin server."},{"key":"X-Powered-By","value":"capture API","description":"Specifies the technology (ASP.NET, PHP, JBoss, e.g.) supporting the web application (version details are often in X-Runtime, X-Version, or X-AspNet-Version)"}],"cookie":[],"responseTime":null,"body":"{\"status\":200,\"data\":{\"lightbox\":{\"id_lightbox\":\"191\",\"name\":\"lighty2 mclightbox (7)\",\"create_date\":\"2018-05-09 14:23:13\",\"update_date\":null,\"item_count\":0,\"is_default\":false,\"is_shared\":false},\"items\":[]}}"}],"_postman_id":"e46601c1-87e2-437e-96cd-cba1e8613344"},{"name":"Get a List of Lightboxes","event":[{"listen":"prerequest","script":{"id":"aa134e10-0286-402a-bc89-f68d369404b5","exec":[""],"type":"text/javascript","packages":{},"requests":{}}},{"listen":"test","script":{"id":"a70f4e86-17cf-4616-a740-846c1dd05ffb","exec":[""],"type":"text/javascript","packages":{},"requests":{}}}],"id":"d27fb20d-1ce8-49d7-aa31-8dff77ada373","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"{{cw3_api_url}}/api/lightboxes","description":"Test: List Lightboxes API call endpoint
\nUse Case: When the user hits an API endpoint call followed by an access token, it will return a list of all the users Lightboxes.
\nResponse Status: 200 OK
\n","urlObject":{"path":["api","lightboxes"],"host":["{{cw3_api_url}}"],"query":[{"disabled":true,"description":{"content":"deprecated specific client use - only get lightboxes that have not been marked as extracted (completed)
\n","type":"text/plain"},"key":"extracted","value":"false"}],"variable":[]}},"response":[{"id":"2b6bcc29-b10a-45ba-a9c8-2b88f53ecf9a","name":"list lightboxes","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"{{cw3_api_url}}/api/lightboxes?itemsPerPage=5&page=1","host":["{{cw3_api_url}}"],"path":["api","lightboxes"],"query":[{"key":"itemsPerPage","value":"5","type":"text"},{"key":"page","value":"1","type":"text"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Origin","value":"","description":"Specifies a URI that may access the resource. For requests without credentials, the server may specify '*' as a wildcard, thereby allowing any origin to access the resource."},{"key":"Connection","value":"Keep-Alive","description":"Options that are desired for the connection"},{"key":"Content-Encoding","value":"gzip","description":"The type of encoding used on the data."},{"key":"Content-Language","value":"en","description":"The language the content is in"},{"key":"Content-Length","value":"248","description":"The length of the response body in octets (8-bit bytes)"},{"key":"Content-Type","value":"application/json; charset=UTF-8","description":"The mime type of this content"},{"key":"Date","value":"Wed, 09 May 2018 13:34:58 GMT","description":"The date and time that the message was sent"},{"key":"Keep-Alive","value":"timeout=5, max=99","description":"Custom header"},{"key":"Server","value":"Apache","description":"A name for the server"},{"key":"Vary","value":"Accept-Encoding","description":"Tells downstream proxies how to match future request headers to decide whether the cached response can be used rather than requesting a fresh one from the origin server."},{"key":"X-Powered-By","value":"capture API","description":"Specifies the technology (ASP.NET, PHP, JBoss, e.g.) supporting the web application (version details are often in X-Runtime, X-Version, or X-AspNet-Version)"}],"cookie":[],"responseTime":null,"body":"{\"status\":200,\"data\":{\"lightboxes\":[{\"id_lightbox\":\"191\",\"name\":\"lighty2 mclightbox (7)\",\"create_date\":\"2018-05-09 14:23:13\",\"update_date\":null,\"item_count\":0,\"is_default\":false,\"is_shared\":false,\"lead_item\":[]},{\"id_lightbox\":\"190\",\"name\":\"lighty2 mclightbox (6)\",\"create_date\":\"2018-05-09 14:22:51\",\"update_date\":null,\"item_count\":0,\"is_default\":false,\"is_shared\":false,\"lead_item\":[]},{\"id_lightbox\":\"189\",\"name\":\"lighty2 mclightbox (5)\",\"create_date\":\"2018-05-09 14:20:37\",\"update_date\":null,\"item_count\":0,\"is_default\":false,\"is_shared\":false,\"lead_item\":[]},{\"id_lightbox\":\"188\",\"name\":\"lighty2 mclightbox (4)\",\"create_date\":\"2018-05-09 14:19:01\",\"update_date\":null,\"item_count\":0,\"is_default\":false,\"is_shared\":false,\"lead_item\":[]},{\"id_lightbox\":\"187\",\"name\":\"lighty2 mclightbox (3)\",\"create_date\":\"2018-05-09 14:18:25\",\"update_date\":null,\"item_count\":0,\"is_default\":false,\"is_shared\":false,\"lead_item\":[]},{\"id_lightbox\":\"186\",\"name\":\"lighty2 mclightbox (2)\",\"create_date\":\"2018-05-09 14:18:17\",\"update_date\":null,\"item_count\":0,\"is_default\":false,\"is_shared\":false,\"lead_item\":[]},{\"id_lightbox\":\"185\",\"name\":\"lighty2 mclightbox\",\"create_date\":\"2018-05-09 14:17:06\",\"update_date\":null,\"item_count\":0,\"is_default\":true,\"is_shared\":false,\"lead_item\":[]}]}}"}],"_postman_id":"d27fb20d-1ce8-49d7-aa31-8dff77ada373"},{"name":"Get Default Lightbox","event":[{"listen":"prerequest","script":{"id":"daf75545-eb02-455d-9c37-305efaccb436","exec":[""],"type":"text/javascript","packages":{},"requests":{}}},{"listen":"test","script":{"id":"7287570a-36ab-42c2-9940-e36162eda2ef","exec":["// Data Access token Status -> OK","pm.test(\"Ouath Extend Request \", function () {"," var jsonData = pm.response.json();"," pm.expect(jsonData.status).to.eql(200);","});","","//Getting data lightbox id_lightbox-> OK","pm.test(\"General response for Data lightbox id_lightbox \", function () {"," pm.response.to.have.jsonBody(\"data.lightbox.id_lightbox\");","});","","//Getting data lightboxes name-> OK","pm.test(\"General response for Data lightboxes name \", function () {"," pm.response.to.have.jsonBody(\"data.lightbox.name\");","});","","","//Getting data lightboxes create_date-> OK","pm.test(\"General response for Data lightboxes create_date\", function () {"," pm.response.to.have.jsonBody(\"data.lightbox.create_date\");","});","","","//Getting data lightbox update_date-> OK","pm.test(\"General response for Data lightbox update_date\", function () {"," pm.response.to.have.jsonBody(\"data.lightbox.update_date\");","});","","","//Getting data lightbox item_count\"-> OK","pm.test(\"General response for Data lightbox item_count\", function () {"," pm.response.to.have.jsonBody(\"data.lightbox.item_count\");","});","","","//Getting data lightboxes is_default\"-> OK","pm.test(\"General response for Data lightboxes is_default\", function () {"," pm.response.to.have.jsonBody(\"data.lightbox.is_default\");","});","","//Getting data lightboxes is_shared\"-> OK","pm.test(\"General response for Data lightboxes is_shared\", function () {"," pm.response.to.have.jsonBody(\"data.lightbox.is_shared\");","});","","//Getting data lightboxes is_shared\"-> OK","pm.test(\"General response for Data lightboxes is_shared\", function () {"," pm.response.to.have.jsonBody(\"data.items\");","});","","","","//Catching the error message and display the status ","","pm.test(\"General response Status(500)\", function () {"," pm.response.to.be.ok; //HTTP 500","})","","pm.test(\"General error response\", function () {"," pm.response.to.not.have.jsonBody(\"error\"); ","});","","//General error response with the message","pm.test(\"General error response with the message\", function () {"," pm.response.to.not.have.jsonBody(\"error.message\"); ","});","","pm.test(\"showing the summary response \", function () {"," pm.response.to.not.have.jsonBody(\"error.summary\"); ","});","","","//The Below test should be in ALL API calls as it is a general test. Response time may need tweaking for some queries.","pm.test(\"General response (Response Time)\", function () {"," pm.expect(pm.response.responseTime).to.be.below( 9828); //Quicker than 150ms","});"],"type":"text/javascript","packages":{},"requests":{}}}],"id":"9a62c9ba-be51-4661-b10d-3837f61a712d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"{{cw3_api_url}}/api/lightbox/default?itemsPerPage=10&page=1","description":"Test: Get default Lightbox API endpoint.
\nUse Case: When the user hits an API call endpoint by providing the access token, it will return the users default lightbox.
\nResponse Status: 200 OK
\n","urlObject":{"path":["api","lightbox","default"],"host":["{{cw3_api_url}}"],"query":[{"key":"itemsPerPage","value":"10"},{"key":"page","value":"1"}],"variable":[]}},"response":[{"id":"541881fa-48c3-4f09-a42a-1f2b26f6dd7a","name":"get default lightbox","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"{{access-token_user}}","type":"text"}],"url":{"raw":"{{cw3_api_url}}/api/lightbox/default?page=1","host":["{{cw3_api_url}}"],"path":["api","lightbox","default"],"query":[{"key":"itemsPerPage","value":"10","disabled":true},{"key":"page","value":"1","type":"text"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Origin","value":"","description":"Specifies a URI that may access the resource. For requests without credentials, the server may specify '*' as a wildcard, thereby allowing any origin to access the resource."},{"key":"Connection","value":"Upgrade, Keep-Alive","description":"Options that are desired for the connection"},{"key":"Content-Encoding","value":"gzip","description":"The type of encoding used on the data."},{"key":"Content-Language","value":"en","description":"The language the content is in"},{"key":"Content-Length","value":"162","description":"The length of the response body in octets (8-bit bytes)"},{"key":"Content-Type","value":"application/json; charset=UTF-8","description":"The mime type of this content"},{"key":"Date","value":"Wed, 09 May 2018 14:26:30 GMT","description":"The date and time that the message was sent"},{"key":"Keep-Alive","value":"timeout=5, max=100","description":"Custom header"},{"key":"Server","value":"Apache","description":"A name for the server"},{"key":"Upgrade","value":"h2,h2c","description":"Custom header"},{"key":"Vary","value":"Accept-Encoding","description":"Tells downstream proxies how to match future request headers to decide whether the cached response can be used rather than requesting a fresh one from the origin server."},{"key":"X-Powered-By","value":"capture API","description":"Specifies the technology (ASP.NET, PHP, JBoss, e.g.) supporting the web application (version details are often in X-Runtime, X-Version, or X-AspNet-Version)"}],"cookie":[],"responseTime":null,"body":"{\"status\":200,\"data\":{\"lightbox\":{\"id_lightbox\":\"185\",\"name\":\"lighty2 mclightbox\",\"create_date\":\"2018-05-09 14:17:06\",\"update_date\":null,\"item_count\":0,\"is_default\":true,\"is_shared\":false},\"items\":[]}}"}],"_postman_id":"9a62c9ba-be51-4661-b10d-3837f61a712d"},{"name":"Get a Lightbox","event":[{"listen":"test","script":{"id":"a022c927-4434-45e8-aa65-096253b44605","exec":[""],"type":"text/javascript","packages":{},"requests":{}}},{"listen":"prerequest","script":{"packages":{},"type":"text/javascript"}}],"id":"143df6c8-ce8a-44c3-8f15-be1061519bd0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{access_key_user}}"},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"{{cw3_api_url}}/api/lightbox/{{lightbox_id}}","description":"Test: Lightbox API call endpoint
\nUse Case: When the user hits an API call endpoint followed by access token, it will return specific lightbox and it's contained items for an anonymous user.
\nResponse Status: 200 OK
\n","urlObject":{"path":["api","lightbox","{{lightbox_id}}"],"host":["{{cw3_api_url}}"],"query":[],"variable":[]}},"response":[{"id":"11818ac7-badf-4aed-9cb8-0530d2394fc4","name":"get lightbox","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"{{access_token_user}}","type":"text"}],"url":"{{cw3_api_url}}/api/lightbox/{{lightbox_id}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Origin","value":"","description":"Specifies a URI that may access the resource. For requests without credentials, the server may specify '*' as a wildcard, thereby allowing any origin to access the resource."},{"key":"Connection","value":"Upgrade, Keep-Alive","description":"Options that are desired for the connection"},{"key":"Content-Encoding","value":"gzip","description":"The type of encoding used on the data."},{"key":"Content-Language","value":"en","description":"The language the content is in"},{"key":"Content-Length","value":"165","description":"The length of the response body in octets (8-bit bytes)"},{"key":"Content-Type","value":"application/json; charset=UTF-8","description":"The mime type of this content"},{"key":"Date","value":"Wed, 09 May 2018 14:42:49 GMT","description":"The date and time that the message was sent"},{"key":"Keep-Alive","value":"timeout=5, max=100","description":"Custom header"},{"key":"Server","value":"Apache","description":"A name for the server"},{"key":"Upgrade","value":"h2,h2c","description":"Custom header"},{"key":"Vary","value":"Accept-Encoding","description":"Tells downstream proxies how to match future request headers to decide whether the cached response can be used rather than requesting a fresh one from the origin server."},{"key":"X-Powered-By","value":"capture API","description":"Specifies the technology (ASP.NET, PHP, JBoss, e.g.) supporting the web application (version details are often in X-Runtime, X-Version, or X-AspNet-Version)"}],"cookie":[],"responseTime":null,"body":"{\"status\":200,\"data\":{\"lightbox\":{\"id_lightbox\":\"191\",\"name\":\"lighty2 mclightbox (7)\",\"create_date\":\"2018-05-09 14:23:13\",\"update_date\":null,\"item_count\":0,\"is_default\":false,\"is_shared\":false},\"items\":[]}}"}],"_postman_id":"143df6c8-ce8a-44c3-8f15-be1061519bd0"},{"name":"Clone Lightbox","event":[{"listen":"test","script":{"id":"0b094b0b-9302-428a-9e86-a58b48f1e0ea","exec":[""],"type":"text/javascript","packages":{},"requests":{}}},{"listen":"prerequest","script":{"packages":{},"type":"text/javascript"}}],"id":"15627ec7-e949-422a-bf56-a0591c3e45dc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{access_key_user}}"},"isInherited":false},"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"clone_name\":\"I've Been Cloned!!\"\n}\n"},"url":"{{cw3_api_url}}/api/lightbox/{{lightbox_id}}/clone","description":"Test: Clone Lightbox API call endpoint.
\nUse Case: Optional pass parameter clone name with the name to give the new cloned lightbox. If omitted, a new name will be generated from the clone source's name, e.g. 'My Lightbox' will be cloned to 'My Lightbox (2)' and so on.
\nResponse Status: 200 OK
\n","urlObject":{"path":["api","lightbox","{{lightbox_id}}","clone"],"host":["{{cw3_api_url}}"],"query":[],"variable":[]}},"response":[{"id":"85a4a0e1-45f8-4bfd-ba28-e867466f4425","name":"Clone lightbox","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"{{access_token_user}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"clone_name\":\"I've Been Cloned!!\"\n}\n"},"url":"{{cw3_api_url}}/api/lightbox/{{lightbox_d}}/clone"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Origin","value":"","description":"Specifies a URI that may access the resource. For requests without credentials, the server may specify '*' as a wildcard, thereby allowing any origin to access the resource."},{"key":"Connection","value":"Upgrade, Keep-Alive","description":"Options that are desired for the connection"},{"key":"Content-Encoding","value":"gzip","description":"The type of encoding used on the data."},{"key":"Content-Language","value":"en","description":"The language the content is in"},{"key":"Content-Length","value":"215","description":"The length of the response body in octets (8-bit bytes)"},{"key":"Content-Type","value":"application/json; charset=UTF-8","description":"The mime type of this content"},{"key":"Date","value":"Wed, 09 May 2018 15:31:13 GMT","description":"The date and time that the message was sent"},{"key":"Keep-Alive","value":"timeout=5, max=100","description":"Custom header"},{"key":"Server","value":"Apache","description":"A name for the server"},{"key":"Upgrade","value":"h2,h2c","description":"Custom header"},{"key":"Vary","value":"Accept-Encoding","description":"Tells downstream proxies how to match future request headers to decide whether the cached response can be used rather than requesting a fresh one from the origin server."},{"key":"X-Powered-By","value":"capture API","description":"Specifies the technology (ASP.NET, PHP, JBoss, e.g.) supporting the web application (version details are often in X-Runtime, X-Version, or X-AspNet-Version)"}],"cookie":[],"responseTime":null,"body":"Test: Move Items API endpoint.
\nUse Case: When the user hits the API call endpoint, the ser will be able to move one items to another items box by passing the lightbox ID which shoudl be updated to the specified lightbox ID although the user will have to pass the access token and assets ID. Remember if you're a new user you need to add the item in order to view the assists ID.The return will be printing the message that has been moved.
\nResponse Status: 200 OK
\n","urlObject":{"path":["api","lightbox","{{lightbox_id_from}}","moveto","{{lightbox_id_to}}"],"host":["{{cw3_api_url}}"],"query":[],"variable":[]}},"response":[{"id":"cace8138-a850-446f-8d2f-2116ee9610a2","name":"Move items","originalRequest":{"method":"PATCH","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"{{access_token_user}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"assets\":[{{asset_id_comma_separated_list}}]\n}\n"},"url":"{{cw3_api_url}}/api/lightbox/{{lightbox_id_from}}/moveto/{{lightbox_id_to}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Origin","value":"","description":"Specifies a URI that may access the resource. For requests without credentials, the server may specify '*' as a wildcard, thereby allowing any origin to access the resource."},{"key":"Connection","value":"Upgrade, Keep-Alive","description":"Options that are desired for the connection"},{"key":"Content-Encoding","value":"gzip","description":"The type of encoding used on the data."},{"key":"Content-Language","value":"en","description":"The language the content is in"},{"key":"Content-Length","value":"76","description":"The length of the response body in octets (8-bit bytes)"},{"key":"Content-Type","value":"application/json; charset=UTF-8","description":"The mime type of this content"},{"key":"Date","value":"Thu, 10 May 2018 09:04:53 GMT","description":"The date and time that the message was sent"},{"key":"Keep-Alive","value":"timeout=5, max=100","description":"Custom header"},{"key":"Server","value":"Apache","description":"A name for the server"},{"key":"Upgrade","value":"h2,h2c","description":"Custom header"},{"key":"Vary","value":"Accept-Encoding","description":"Tells downstream proxies how to match future request headers to decide whether the cached response can be used rather than requesting a fresh one from the origin server."},{"key":"X-Powered-By","value":"capture API","description":"Specifies the technology (ASP.NET, PHP, JBoss, e.g.) supporting the web application (version details are often in X-Runtime, X-Version, or X-AspNet-Version)"}],"cookie":[],"responseTime":null,"body":"{\"status\":200,\"data\":{\"message\":\"lightbox items moved\"}}"}],"_postman_id":"f2930258-484e-43a8-947c-c5011e2747f8"},{"name":"Share lightbox","event":[{"listen":"test","script":{"id":"5dd33790-c79b-4a31-8a80-30510ab3d7ce","exec":[""],"type":"text/javascript","packages":{},"requests":{}}},{"listen":"prerequest","script":{"packages":{},"type":"text/javascript"}}],"id":"8d159675-de40-4442-87c7-f9ac7a92c3f0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{access_key_user}}"},"isInherited":false},"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"email_subject\":\"have my lightbox\",\n \"email_recipient\":\"john.doe@capture.co.uk\",\n \"share_type\":\"dynamic\"\n}"},"url":"{{cw3_api_url}}/api/lightbox/{{lightbox_id}}/share","description":"Test: Share Lightbox API call
\nUse Case: When a user access the share lightbox API call endpoint, a shared record is created against this lightbox and returns a shared token that can be emailed to a recipient. An anonymous user cannot be share.
\nResponse Status: 200 OK
\n","urlObject":{"path":["api","lightbox","{{lightbox_id}}","share"],"host":["{{cw3_api_url}}"],"query":[],"variable":[]}},"response":[{"id":"6fd761ae-3068-4485-8ccb-0eb6cc64f7a2","name":"share lightbox","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"{{access_token_user}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"email_subject\":\"have my lightbox\",\n \"email_recipient\":\"john.doe@capture.co.uk\",\n \"share_type\":\"dynamic\"\n}"},"url":"{{cw3_api_url}}/api/lightbox/{{lightbox_id}}/share"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Origin","value":"","description":"Specifies a URI that may access the resource. For requests without credentials, the server may specify '*' as a wildcard, thereby allowing any origin to access the resource."},{"key":"Connection","value":"Upgrade, Keep-Alive","description":"Options that are desired for the connection"},{"key":"Content-Encoding","value":"gzip","description":"The type of encoding used on the data."},{"key":"Content-Language","value":"en","description":"The language the content is in"},{"key":"Content-Length","value":"201","description":"The length of the response body in octets (8-bit bytes)"},{"key":"Content-Type","value":"application/json; charset=UTF-8","description":"The mime type of this content"},{"key":"Date","value":"Wed, 09 May 2018 15:46:43 GMT","description":"The date and time that the message was sent"},{"key":"Keep-Alive","value":"timeout=5, max=100","description":"Custom header"},{"key":"Server","value":"Apache","description":"A name for the server"},{"key":"Upgrade","value":"h2,h2c","description":"Custom header"},{"key":"Vary","value":"Accept-Encoding","description":"Tells downstream proxies how to match future request headers to decide whether the cached response can be used rather than requesting a fresh one from the origin server."},{"key":"X-Powered-By","value":"capture API","description":"Specifies the technology (ASP.NET, PHP, JBoss, e.g.) supporting the web application (version details are often in X-Runtime, X-Version, or X-AspNet-Version)"}],"cookie":[],"responseTime":null,"body":"{\"status\":200,\"data\":{\"message\":\"lightbox `lighty2 mclightbox (6)` shared with `john.doe@capture.co.uk`\",\"lightbox_id\":190,\"share_token\":\"f5fe4b8fed92f008fe33527c30008c531d70dedc\",\"share_recipient\":\"john.doe@capture.co.uk\",\"share_subject\":\"have my carrots2\"}}"}],"_postman_id":"8d159675-de40-4442-87c7-f9ac7a92c3f0"},{"name":"Get shared lightbox","event":[{"listen":"test","script":{"id":"28b94b4b-3f72-40d5-8b98-bf4432033fad","exec":[""],"type":"text/javascript","packages":{},"requests":{}}},{"listen":"prerequest","script":{"id":"b9cac591-33c5-4c7b-b54b-2653ac7d4b4f","exec":[""],"type":"text/javascript","packages":{},"requests":{}}}],"id":"be6f8c01-ab2a-45f3-83f0-5fbea899757d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{access_key_user}}"},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"{{cw3_api_url}}/api/lightbox/{{share_token}}","description":"Test: Get Share Lightbox API call endpoint
\nUse CaseWhen a user hits the API call endpoint URL, it will get a shared lightbox. If the type is dynamic, lightbox is returned with access permissions and if the type is static, and a user is logged in, lightbox is cloned to a new user.
\nResponse Status: 200 OK
\n","urlObject":{"path":["api","lightbox","{{share_token}}"],"host":["{{cw3_api_url}}"],"query":[],"variable":[]}},"response":[{"id":"46ab0d52-0fe3-438e-9410-96c7819c6a27","name":"Get shared lightbox","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"{{cw3_api_url}}/api/lightbox/{{share_token}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Origin","value":"","description":"Specifies a URI that may access the resource. For requests without credentials, the server may specify '*' as a wildcard, thereby allowing any origin to access the resource."},{"key":"Connection","value":"Upgrade, Keep-Alive","description":"Options that are desired for the connection"},{"key":"Content-Encoding","value":"gzip","description":"The type of encoding used on the data."},{"key":"Content-Language","value":"en","description":"The language the content is in"},{"key":"Content-Length","value":"171","description":"The length of the response body in octets (8-bit bytes)"},{"key":"Content-Type","value":"application/json; charset=UTF-8","description":"The mime type of this content"},{"key":"Date","value":"Thu, 10 May 2018 11:59:04 GMT","description":"The date and time that the message was sent"},{"key":"Keep-Alive","value":"timeout=5, max=100","description":"Custom header"},{"key":"Server","value":"Apache","description":"A name for the server"},{"key":"Upgrade","value":"h2,h2c","description":"Custom header"},{"key":"Vary","value":"Accept-Encoding","description":"Tells downstream proxies how to match future request headers to decide whether the cached response can be used rather than requesting a fresh one from the origin server."},{"key":"X-Powered-By","value":"capture API","description":"Specifies the technology (ASP.NET, PHP, JBoss, e.g.) supporting the web application (version details are often in X-Runtime, X-Version, or X-AspNet-Version)"}],"cookie":[],"responseTime":null,"body":"{\"status\":200,\"data\":{\"lightbox\":{\"id_lightbox\":\"190\",\"name\":\"lighty2 mclightbox (6)\",\"create_date\":\"2018-05-09 14:22:51\",\"update_date\":\"2018-05-10 12:52:34\",\"item_count\":0,\"is_default\":false,\"is_shared\":false},\"items\":[]}}"}],"_postman_id":"be6f8c01-ab2a-45f3-83f0-5fbea899757d"},{"name":"Get Lightbox Annotations","event":[{"listen":"test","script":{"id":"3c10029b-c914-4051-8460-ca0d9e4efa49","exec":[""],"type":"text/javascript","packages":{},"requests":{}}},{"listen":"prerequest","script":{"packages":{},"type":"text/javascript"}}],"id":"652b048d-d4a3-41c2-9bd8-fbde4df07e25","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{access_key_user}}"},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"{{cw3_api_url}}/api/lightbox/{{lightbox_id}}/annotations","description":"Test: Get Lightbox annotations API call endpoint
\nUse Case: When a user hits an API call endpoint by passing the Lightbox ID, it returns the information of specific lightbox you have requested, and the child it belongs to. You will need to supply the access token to view the information.
\nResponse Status 200 OK
\n","urlObject":{"path":["api","lightbox","{{lightbox_id}}","annotations"],"host":["{{cw3_api_url}}"],"query":[],"variable":[]}},"response":[{"id":"ac428dc8-5bc2-498a-934b-4d7ce6116e90","name":"Get lightbox annotations","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"{{cw3_api_url}}/api/lightbox/{{lightbox_id}}/annotations"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Origin","value":"","description":"Specifies a URI that may access the resource. For requests without credentials, the server may specify '*' as a wildcard, thereby allowing any origin to access the resource."},{"key":"Connection","value":"Upgrade, Keep-Alive","description":"Options that are desired for the connection"},{"key":"Content-Encoding","value":"gzip","description":"The type of encoding used on the data."},{"key":"Content-Language","value":"en","description":"The language the content is in"},{"key":"Content-Length","value":"243","description":"The length of the response body in octets (8-bit bytes)"},{"key":"Content-Type","value":"application/json; charset=UTF-8","description":"The mime type of this content"},{"key":"Date","value":"Thu, 10 May 2018 12:23:38 GMT","description":"The date and time that the message was sent"},{"key":"Keep-Alive","value":"timeout=5, max=100","description":"Custom header"},{"key":"Server","value":"Apache","description":"A name for the server"},{"key":"Upgrade","value":"h2,h2c","description":"Custom header"},{"key":"Vary","value":"Accept-Encoding","description":"Tells downstream proxies how to match future request headers to decide whether the cached response can be used rather than requesting a fresh one from the origin server."},{"key":"X-Powered-By","value":"capture API","description":"Specifies the technology (ASP.NET, PHP, JBoss, e.g.) supporting the web application (version details are often in X-Runtime, X-Version, or X-AspNet-Version)"}],"cookie":[],"responseTime":null,"body":"{\"status\":200,\"data\":[{\"id_lightbox_note\":\"2\",\"id_lightbox\":\"191\",\"title\":\"testing\",\"notes\":\"test notes\",\"update_date\":\"2018-05-10 13:20:42\",\"lightbox_name\":\"lighty2 mclightbox (7)\",\"posted_by\":{\"fname\":\"Jane\",\"lname\":\"Doe\",\"email\":\"jane.doe@capture.co.uk\",\"idcontacts\":\"55\"},\"children\":[{\"id_lightbox_note\":\"3\",\"notes\":\"test notes\",\"update_date\":\"2018-05-10 13:23:31\",\"posted_by\":{\"fname\":\"Jane\",\"lname\":\"Doe\",\"email\":\"jane.doe@capture.co.uk\",\"idcontacts\":\"55\"}}]}]}"}],"_postman_id":"652b048d-d4a3-41c2-9bd8-fbde4df07e25"},{"name":"Delete Lightbox Annotation","id":"86921b50-90c1-44a5-a4c0-46a6b2dacb2d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{access_key_user}}"},"isInherited":false},"method":"DELETE","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"url":"{{cw3_api_url}}/api/lightbox/annotation/{{annotation_id}}","description":"Test: Delete Lightbox API call endpoint
\nUse Case: When a user hits an API call endpoint, the user will be able to delete the Lightbox annotation in lightbox although this will only happen to authenticate the user otherwise the user will not have permission to delete any information.
\nResponse Status: 200 OK, IF you try to resend the same request you will receive 400 bad request, means the items doesn't exist in the database
\n","urlObject":{"path":["api","lightbox","annotation","{{annotation_id}}"],"host":["{{cw3_api_url}}"],"query":[],"variable":[]}},"response":[{"id":"44992888-5092-4864-bfe1-095e351cda3b","name":"Delete Lightbox Annotation","originalRequest":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"{{access-token_user}}","type":"text"}],"url":"{{cw3_api_url}}/api/lightbox/annotation/{{annotation_id}}"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Origin","value":"","description":"Specifies a URI that may access the resource. For requests without credentials, the server may specify '*' as a wildcard, thereby allowing any origin to access the resource."},{"key":"Connection","value":"Upgrade, close","description":"Options that are desired for the connection"},{"key":"Content-Language","value":"en","description":"The language the content is in"},{"key":"Content-Type","value":"application/json; charset=UTF-8","description":"The mime type of this content"},{"key":"Date","value":"Thu, 10 May 2018 13:12:02 GMT","description":"The date and time that the message was sent"},{"key":"Server","value":"Apache","description":"A name for the server"},{"key":"Transfer-Encoding","value":"chunked","description":"The form of encoding used to safely transfer the entity to the user. Currently defined methods are: chunked, compress, deflate, gzip, identity."},{"key":"Upgrade","value":"h2,h2c","description":"Custom header"},{"key":"X-Powered-By","value":"capture API","description":"Specifies the technology (ASP.NET, PHP, JBoss, e.g.) supporting the web application (version details are often in X-Runtime, X-Version, or X-AspNet-Version)"}],"cookie":[],"responseTime":null,"body":"{\"status\":400,\"api_status\":{\"code\":\"fail_1000\",\"message\":\"bad request\",\"description\":\"lightbox annotation does not exist\"},\"error\":{\"message\":\"bad request\",\"summary\":\"lightbox annotation does not exist\"}}"}],"_postman_id":"86921b50-90c1-44a5-a4c0-46a6b2dacb2d"},{"name":"Get Lightbox Item Annotations","event":[{"listen":"test","script":{"id":"0c056d9d-9f21-4d59-8a38-8b949b2baf00","exec":[""],"type":"text/javascript","packages":{},"requests":{}}},{"listen":"prerequest","script":{"packages":{},"type":"text/javascript"}}],"id":"7e64426e-85ed-4aea-aecf-dab132a9b4d6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{access_key_user}}"},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"{{cw3_api_url}}/api/lightbox/{{lightbox_id}}/item/{{item_id}}/annotations","description":"Test: Get Lightbox Item Annotation API call endpoint
\nUse Case: When the user hits an API call endpoint, by passing the lightbox ID and assets ID followed by access token, the specified items annotation will be returned.
\nResponse Status: 200 OK
\n","urlObject":{"path":["api","lightbox","{{lightbox_id}}","item","{{item_id}}","annotations"],"host":["{{cw3_api_url}}"],"query":[],"variable":[]}},"response":[{"id":"2df7b2bf-9268-47b3-8dfe-9f20bef97b79","name":"Get lightbox item annotations","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"{{access_token_user}}","type":"text"}],"url":"{{cw3_api_url}}/api/lightbox/{{lightbox_id}}/item/{{item_id}}/annotations"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Origin","value":"","description":"Specifies a URI that may access the resource. For requests without credentials, the server may specify '*' as a wildcard, thereby allowing any origin to access the resource."},{"key":"Connection","value":"Upgrade, Keep-Alive","description":"Options that are desired for the connection"},{"key":"Content-Encoding","value":"gzip","description":"The type of encoding used on the data."},{"key":"Content-Language","value":"en","description":"The language the content is in"},{"key":"Content-Length","value":"257","description":"The length of the response body in octets (8-bit bytes)"},{"key":"Content-Type","value":"application/json; charset=UTF-8","description":"The mime type of this content"},{"key":"Date","value":"Thu, 10 May 2018 13:49:11 GMT","description":"The date and time that the message was sent"},{"key":"Keep-Alive","value":"timeout=5, max=100","description":"Custom header"},{"key":"Server","value":"Apache","description":"A name for the server"},{"key":"Upgrade","value":"h2,h2c","description":"Custom header"},{"key":"Vary","value":"Accept-Encoding","description":"Tells downstream proxies how to match future request headers to decide whether the cached response can be used rather than requesting a fresh one from the origin server."},{"key":"X-Powered-By","value":"capture API","description":"Specifies the technology (ASP.NET, PHP, JBoss, e.g.) supporting the web application (version details are often in X-Runtime, X-Version, or X-AspNet-Version)"}],"cookie":[],"responseTime":null,"body":"{\"status\":200,\"data\":[{\"id_lightbox_item_note\":\"39\",\"id_lightbox_item\":\"655\",\"title\":\"lightbox item\",\"notes\":\"more stuff!\",\"update_date\":\"2018-05-10 14:27:03\",\"lightbox_name\":\"lighty2 mclightbox (7)\",\"posted_by\":{\"fname\":\"John\",\"lname\":\"Doe\",\"email\":\"john.doe@capture.co.uk\",\"idcontacts\":\"55\"},\"children\":[{\"id_lightbox_item_note\":\"40\",\"notes\":\"more stuff!!\",\"update_date\":\"2018-05-10 14:31:35\",\"posted_by\":{\"fname\":\"John\",\"lname\":\"Doe\",\"email\":\"john.doe@capture.co.uk\",\"idcontacts\":\"55\"}}]}]}"}],"_postman_id":"7e64426e-85ed-4aea-aecf-dab132a9b4d6"},{"name":"Delete Lightbox Item Annotations","id":"8dd2f2c6-6900-4b59-833a-2ba3872f3dad","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{access_key_user}}"},"isInherited":false},"method":"DELETE","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"url":"{{cw3_api_url}}/api/lightbox/item/annotation/{{annotation_id}}","description":"Test: Delete Items API annotation call endpoint.
\nUse Case: When the user hits an API call endpoint, the user will be able to delete the items annotation in Lightbox although this will only happen to authenticate the user. Otherwise you will not have permission to delete any information.
\nResponse Status: 200 OK, IF you try to resend the same request you will receive 500 internal server error
\n","urlObject":{"path":["api","lightbox","item","annotation","{{annotation_id}}"],"host":["{{cw3_api_url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"8dd2f2c6-6900-4b59-833a-2ba3872f3dad"},{"name":"Reorder Items","event":[{"listen":"test","script":{"id":"9c220711-6240-4fc9-835e-d543453eae18","exec":[""],"type":"text/javascript","packages":{},"requests":{}}},{"listen":"prerequest","script":{"packages":{},"type":"text/javascript"}}],"id":"c9ab5223-f8e8-42f4-9583-fbb443ee51a2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{access_key_user}}"},"isInherited":false},"method":"PATCH","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"assets\":[{{asset_id_comma_separated_list}}]\n}\n"},"url":"{{cw3_api_url}}/api/lightbox/{{lightbox_id}}/items/reorder","description":"Test: Reorder Items API call endpoint.
\nUse Case: When the user hits an API call endpoint by passing the lightbox ID, it will change the display order of items in the specified lightbox. The user will need to insert the assets ID and access token in to the body to update the record and to ensure that the lightbox items is reordered.
\nResponse Status: 200 OK
\n","urlObject":{"path":["api","lightbox","{{lightbox_id}}","items","reorder"],"host":["{{cw3_api_url}}"],"query":[],"variable":[]}},"response":[{"id":"53df1606-315e-496b-bf22-0559a7516d60","name":"Reorder items","originalRequest":{"method":"PATCH","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"assets\":[{{asset_id_comma_separated_list}}]\n}\n"},"url":"{{cw3_api_url}}/api/lightbox/{{lightbox_id}}/items/reorder"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Origin","value":"","description":"Specifies a URI that may access the resource. For requests without credentials, the server may specify '*' as a wildcard, thereby allowing any origin to access the resource."},{"key":"Connection","value":"Upgrade, Keep-Alive","description":"Options that are desired for the connection"},{"key":"Content-Encoding","value":"gzip","description":"The type of encoding used on the data."},{"key":"Content-Language","value":"en","description":"The language the content is in"},{"key":"Content-Length","value":"80","description":"The length of the response body in octets (8-bit bytes)"},{"key":"Content-Type","value":"application/json; charset=UTF-8","description":"The mime type of this content"},{"key":"Date","value":"Thu, 10 May 2018 11:07:19 GMT","description":"The date and time that the message was sent"},{"key":"Keep-Alive","value":"timeout=5, max=100","description":"Custom header"},{"key":"Server","value":"Apache","description":"A name for the server"},{"key":"Upgrade","value":"h2,h2c","description":"Custom header"},{"key":"Vary","value":"Accept-Encoding","description":"Tells downstream proxies how to match future request headers to decide whether the cached response can be used rather than requesting a fresh one from the origin server."},{"key":"X-Powered-By","value":"capture API","description":"Specifies the technology (ASP.NET, PHP, JBoss, e.g.) supporting the web application (version details are often in X-Runtime, X-Version, or X-AspNet-Version)"}],"cookie":[],"responseTime":null,"body":"{\"status\":200,\"data\":{\"message\":\"lightbox items reordered\"}}"}],"_postman_id":"c9ab5223-f8e8-42f4-9583-fbb443ee51a2"},{"name":"Download Lightbox","event":[{"listen":"prerequest","script":{"id":"720e7b75-1884-436d-9f39-77ed3819cf34","exec":[""],"type":"text/javascript","packages":{},"requests":{}}},{"listen":"test","script":{"id":"8f7bce7a-0691-403c-b416-51c18bd8b688","exec":[""],"type":"text/javascript","packages":{},"requests":{}}}],"id":"e093a647-0f5e-48d7-87f6-eba57e03d5e0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"saveas\":\"zip\",\r\n \"download_filename\":\"follow the light\",\r\n \"title\":\"optional title in pdf header\",\r\n \"assets\":[\r\n {\r\n \"asset_id\":974,\r\n \"size_id\":1,\r\n \"usage\":{\r\n \"project_title\":\"Project 1000\",\r\n \"type_of_use\":\"Usage 1000\"\r\n }\r\n },\r\n {\r\n \"asset_id\":972,\r\n \"size_id\":6,\r\n \"usage\":{\r\n \"project_title\":\"Project 2000\",\r\n \"type_of_use\":\"Usage 2000\"\r\n }\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"{{cw3_api_url}}/api/lightbox/{{lightbox_id}}/download","description":"Purpose: request preparation of lightbox download
\nUsage: download a specific lightbox's assets as zip/pdf/pptx/odp
\nResponse Status: 200 OK
\n","urlObject":{"path":["api","lightbox","{{lightbox_id}}","download"],"host":["{{cw3_api_url}}"],"query":[],"variable":[]}},"response":[{"id":"2684202c-7128-4c89-9be5-f9ead268981b","name":"Get download lightbox","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"saveas\":\"pdf\",\r\n \"download_filename\":\"follow the light\",\r\n \"title\":\"optional title in pdf header\",\r\n \"assets\":[\r\n {\r\n \"asset_id\":974,\r\n \"size_id\":1,\r\n \"usage\":{\r\n \"project_title\":\"Project 1000\",\r\n \"type_of_use\":\"Usage 1000\"\r\n }\r\n },\r\n {\r\n \"asset_id\":972,\r\n \"size_id\":6,\r\n \"usage\":{\r\n \"project_title\":\"Project 2000\",\r\n \"type_of_use\":\"Usage 2000\"\r\n }\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"{{cw3_api_url}}/api/lightbox/{{lightbox_id}}/download"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Origin","value":"","description":"Specifies a URI that may access the resource. For requests without credentials, the server may specify '*' as a wildcard, thereby allowing any origin to access the resource."},{"key":"Connection","value":"Keep-Alive","description":"Options that are desired for the connection"},{"key":"Content-Encoding","value":"gzip","description":"The type of encoding used on the data."},{"key":"Content-Language","value":"en","description":"The language the content is in"},{"key":"Content-Length","value":"493","description":"The length of the response body in octets (8-bit bytes)"},{"key":"Content-Type","value":"application/json; charset=UTF-8","description":"The mime type of this content"},{"key":"Date","value":"Thu, 10 May 2018 09:01:47 GMT","description":"The date and time that the message was sent"},{"key":"Keep-Alive","value":"timeout=5, max=99","description":"Custom header"},{"key":"Server","value":"Apache","description":"A name for the server"},{"key":"Vary","value":"Accept-Encoding","description":"Tells downstream proxies how to match future request headers to decide whether the cached response can be used rather than requesting a fresh one from the origin server."},{"key":"X-Powered-By","value":"capture API","description":"Specifies the technology (ASP.NET, PHP, JBoss, e.g.) supporting the web application (version details are often in X-Runtime, X-Version, or X-AspNet-Version)"}],"cookie":[],"responseTime":null,"body":"{\r\n \"status\": 200,\r\n \"data\": {\r\n \"filename\": \"follow_the_light.pdf\",\r\n \"mime_type\": \"application/pdf\",\r\n \"filesize\": 425839,\r\n \"url\": \"https://{{url_to_download_file}}/follow_the_light.pdf\",\r\n \"order_id\": \"75\"\r\n }\r\n}"}],"_postman_id":"e093a647-0f5e-48d7-87f6-eba57e03d5e0"},{"name":"Download Lightbox Options","event":[{"listen":"test","script":{"id":"2176a886-fb4b-4217-b66b-8c5b38bb3e0d","exec":[""],"type":"text/javascript","packages":{},"requests":{}}},{"listen":"prerequest","script":{"id":"5e5f96da-64db-4694-addd-ab815d3336f8","exec":[""],"type":"text/javascript","packages":{},"requests":{}}}],"id":"c00d31c3-0dde-423c-84c4-ba1022f7acb6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{access_key_user}}"},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"{{cw3_api_url}}/api/lightbox/{{lightbox_id}}/download/peek","description":"Test: Download Lightbox options API endpoint.
\nUse Case: When the user hits an API call endpoint followed by access token, it will return all the formats are available for download (zip/pptx/odp) and any required usage.
\nResponse Status :200 OK
\n","urlObject":{"path":["api","lightbox","{{lightbox_id}}","download","peek"],"host":["{{cw3_api_url}}"],"query":[],"variable":[]}},"response":[{"id":"be87f851-323b-481e-96b4-2aa3b4b58ad1","name":"Download Lightbox Options","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"{{cw3_api_url}}/api/lightbox/{{lightbox_id}}/download/peek"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Origin","value":"","description":"Specifies a URI that may access the resource. For requests without credentials, the server may specify '*' as a wildcard, thereby allowing any origin to access the resource."},{"key":"Connection","value":"Upgrade, Keep-Alive","description":"Options that are desired for the connection"},{"key":"Content-Encoding","value":"gzip","description":"The type of encoding used on the data."},{"key":"Content-Language","value":"en","description":"The language the content is in"},{"key":"Content-Length","value":"210","description":"The length of the response body in octets (8-bit bytes)"},{"key":"Content-Type","value":"application/json; charset=UTF-8","description":"The mime type of this content"},{"key":"Date","value":"Thu, 10 May 2018 09:00:25 GMT","description":"The date and time that the message was sent"},{"key":"Keep-Alive","value":"timeout=5, max=100","description":"Custom header"},{"key":"Server","value":"Apache","description":"A name for the server"},{"key":"Upgrade","value":"h2,h2c","description":"Custom header"},{"key":"Vary","value":"Accept-Encoding","description":"Tells downstream proxies how to match future request headers to decide whether the cached response can be used rather than requesting a fresh one from the origin server."},{"key":"X-Powered-By","value":"capture API","description":"Specifies the technology (ASP.NET, PHP, JBoss, e.g.) supporting the web application (version details are often in X-Runtime, X-Version, or X-AspNet-Version)"}],"cookie":[],"responseTime":null,"body":"{\"status\":200,\"data\":{\"saveas\":{\"zip\":\"Zip Archive\",\"pdf\":\"PDF Contact Sheet\",\"pptx\":\"Powerpoint Presentation\",\"odp\":\"OpenDocument Presentation \"},\"usage\":[{\"form_name\":\"project_title\",\"form_type\":\"text\",\"form_label\":\"Project title\",\"form_description\":\"Project title\",\"db_name\":\"custom_field_1\"}]}}"}],"_postman_id":"c00d31c3-0dde-423c-84c4-ba1022f7acb6"},{"name":"Create Lightbox Annotation","event":[{"listen":"test","script":{"id":"511fcefa-2296-41be-9433-447fcaafaf09","exec":[""],"type":"text/javascript","packages":{},"requests":{}}},{"listen":"prerequest","script":{"packages":{},"type":"text/javascript"}}],"id":"4c3928b3-9fa3-4395-ac9d-c8bd073cceef","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{access_key_user}}"},"isInherited":false},"method":"PUT","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"parent_id\": 2,\n \"notes\":\"Ben porter2\"\n}"},"url":"{{cw3_api_url}}/api/lightbox/{{lightbox_id}}/annotate","description":"Test: Create Lightbox annotation API call endpoint
\nUse Case: When the user hits an API call endpoint, the user will be able to create a new response. The user will require to insert the parent_id in the body if it's available as well as the access token
\nResponse Status: 200 OK
\n","urlObject":{"path":["api","lightbox","{{lightbox_id}}","annotate"],"host":["{{cw3_api_url}}"],"query":[],"variable":[]}},"response":[{"id":"76ffffb0-0c7f-433a-832f-f558d8e71fb0","name":"Create lightbox annotation (level 0)","originalRequest":{"method":"PUT","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"title\":\"By the Power of Greyskull!\"\n}","options":{"raw":{"language":"json"}}},"url":"{{cw3_api_url}}/api/lightbox/{{lightbox_id}}/annotate"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Origin","value":"","description":"Specifies a URI that may access the resource. For requests without credentials, the server may specify '*' as a wildcard, thereby allowing any origin to access the resource."},{"key":"Connection","value":"Upgrade, Keep-Alive","description":"Options that are desired for the connection"},{"key":"Content-Encoding","value":"gzip","description":"The type of encoding used on the data."},{"key":"Content-Language","value":"en","description":"The language the content is in"},{"key":"Content-Length","value":"73","description":"The length of the response body in octets (8-bit bytes)"},{"key":"Content-Type","value":"application/json; charset=UTF-8","description":"The mime type of this content"},{"key":"Date","value":"Thu, 10 May 2018 12:23:31 GMT","description":"The date and time that the message was sent"},{"key":"Keep-Alive","value":"timeout=5, max=100","description":"Custom header"},{"key":"Server","value":"Apache","description":"A name for the server"},{"key":"Upgrade","value":"h2,h2c","description":"Custom header"},{"key":"Vary","value":"Accept-Encoding","description":"Tells downstream proxies how to match future request headers to decide whether the cached response can be used rather than requesting a fresh one from the origin server."},{"key":"X-Powered-By","value":"capture API","description":"Specifies the technology (ASP.NET, PHP, JBoss, e.g.) supporting the web application (version details are often in X-Runtime, X-Version, or X-AspNet-Version)"}],"cookie":[],"responseTime":null,"body":"{\"status\":200,\"data\":{\"message\":\"lightbox annotated\"}}"},{"id":"a0c209b1-12b2-4950-a6f3-06e834f17323","name":"Create lightbox annotation (level 1)","originalRequest":{"method":"PUT","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"parent_id\": 2,\n \"notes\":\"notes at level 1\"\n}","options":{"raw":{"language":"json"}}},"url":"{{cw3_api_url}}/api/lightbox/{{lightbox_id}}/annotate"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Origin","value":"","description":"Specifies a URI that may access the resource. For requests without credentials, the server may specify '*' as a wildcard, thereby allowing any origin to access the resource."},{"key":"Connection","value":"Upgrade, Keep-Alive","description":"Options that are desired for the connection"},{"key":"Content-Encoding","value":"gzip","description":"The type of encoding used on the data."},{"key":"Content-Language","value":"en","description":"The language the content is in"},{"key":"Content-Length","value":"73","description":"The length of the response body in octets (8-bit bytes)"},{"key":"Content-Type","value":"application/json; charset=UTF-8","description":"The mime type of this content"},{"key":"Date","value":"Thu, 10 May 2018 12:23:31 GMT","description":"The date and time that the message was sent"},{"key":"Keep-Alive","value":"timeout=5, max=100","description":"Custom header"},{"key":"Server","value":"Apache","description":"A name for the server"},{"key":"Upgrade","value":"h2,h2c","description":"Custom header"},{"key":"Vary","value":"Accept-Encoding","description":"Tells downstream proxies how to match future request headers to decide whether the cached response can be used rather than requesting a fresh one from the origin server."},{"key":"X-Powered-By","value":"capture API","description":"Specifies the technology (ASP.NET, PHP, JBoss, e.g.) supporting the web application (version details are often in X-Runtime, X-Version, or X-AspNet-Version)"}],"cookie":[],"responseTime":null,"body":"{\"status\":200,\"data\":{\"message\":\"lightbox annotated\"}}"}],"_postman_id":"4c3928b3-9fa3-4395-ac9d-c8bd073cceef"},{"name":"Create Lightbox Item Annotation","id":"fda23db3-f1db-4266-ae55-ae790e636a06","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{access_key_user}}"},"isInherited":false},"method":"PUT","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"title\":\"annotation title\"\n}"},"url":"{{cw3_api_url}}/api/lightbox/{{lightbox_id}}/item/{{item_id}}/annotate","description":"Test: Create Lightbox item annotation API call endpoint
\nUse Case: When the user hits an API call endpoint, the user will need to create an items annotation. The user will also need to pass the access token and parent_ID.\n .\n *-*variation requiring lightboxid and assetid as identifiers
\nResponse Status : 200 OK
\n","urlObject":{"path":["api","lightbox","{{lightbox_id}}","item","{{item_id}}","annotate"],"host":["{{cw3_api_url}}"],"query":[],"variable":[]}},"response":[{"id":"a12ba5fc-ab05-4f43-bac2-177b38875c57","name":"Create lightbox item annotation (level 0)","originalRequest":{"method":"PUT","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"title\":\"item title\"\n}","options":{"raw":{"language":"json"}}},"url":"{{cw3_api_url}}/api/lightbox/{{lightbox_id}}/item/{{item_id}}/annotate"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Origin","value":"","description":"Specifies a URI that may access the resource. For requests without credentials, the server may specify '*' as a wildcard, thereby allowing any origin to access the resource."},{"key":"Connection","value":"Upgrade, Keep-Alive","description":"Options that are desired for the connection"},{"key":"Content-Encoding","value":"gzip","description":"The type of encoding used on the data."},{"key":"Content-Language","value":"en","description":"The language the content is in"},{"key":"Content-Length","value":"78","description":"The length of the response body in octets (8-bit bytes)"},{"key":"Content-Type","value":"application/json; charset=UTF-8","description":"The mime type of this content"},{"key":"Date","value":"Thu, 10 May 2018 13:31:35 GMT","description":"The date and time that the message was sent"},{"key":"Keep-Alive","value":"timeout=5, max=100","description":"Custom header"},{"key":"Server","value":"Apache","description":"A name for the server"},{"key":"Upgrade","value":"h2,h2c","description":"Custom header"},{"key":"Vary","value":"Accept-Encoding","description":"Tells downstream proxies how to match future request headers to decide whether the cached response can be used rather than requesting a fresh one from the origin server."},{"key":"X-Powered-By","value":"capture API","description":"Specifies the technology (ASP.NET, PHP, JBoss, e.g.) supporting the web application (version details are often in X-Runtime, X-Version, or X-AspNet-Version)"}],"cookie":[],"responseTime":null,"body":"{\"status\":200,\"data\":{\"message\":\"lightbox item annotated\"}}"},{"id":"c7a56961-3d67-42ab-b67d-e42316d0d7f3","name":"Create lightbox item annotation (level 1)","originalRequest":{"method":"PUT","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"parent_id\":{{annotation_item_id}},\n \"notes\":\"sub note on item title\"\n}"},"url":"{{cw3_api_url}}/api/lightbox/{{lightbox_id}}/item/{{item_id}}/annotate"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Origin","value":"","description":"Specifies a URI that may access the resource. For requests without credentials, the server may specify '*' as a wildcard, thereby allowing any origin to access the resource."},{"key":"Connection","value":"Upgrade, Keep-Alive","description":"Options that are desired for the connection"},{"key":"Content-Encoding","value":"gzip","description":"The type of encoding used on the data."},{"key":"Content-Language","value":"en","description":"The language the content is in"},{"key":"Content-Length","value":"78","description":"The length of the response body in octets (8-bit bytes)"},{"key":"Content-Type","value":"application/json; charset=UTF-8","description":"The mime type of this content"},{"key":"Date","value":"Thu, 10 May 2018 13:27:03 GMT","description":"The date and time that the message was sent"},{"key":"Keep-Alive","value":"timeout=5, max=100","description":"Custom header"},{"key":"Server","value":"Apache","description":"A name for the server"},{"key":"Upgrade","value":"h2,h2c","description":"Custom header"},{"key":"Vary","value":"Accept-Encoding","description":"Tells downstream proxies how to match future request headers to decide whether the cached response can be used rather than requesting a fresh one from the origin server."},{"key":"X-Powered-By","value":"capture API","description":"Specifies the technology (ASP.NET, PHP, JBoss, e.g.) supporting the web application (version details are often in X-Runtime, X-Version, or X-AspNet-Version)"}],"cookie":[],"responseTime":null,"body":"{\"status\":200,\"data\":{\"message\":\"lightbox item annotated\"}}"}],"_postman_id":"fda23db3-f1db-4266-ae55-ae790e636a06"}],"id":"1527c589-1304-4695-b610-0afe5d489166","description":"Allows users to create their own collections of assets. notes can be attached to both the lightbox and each item within, the lightbox can be shared with other users or even anonymous users for collaborative work
\n","event":[{"listen":"prerequest","script":{"id":"8052fa60-f9ce-469a-807b-3c28d77066ff","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"209bb23f-943d-42b0-8180-f20ab5886d92","type":"text/javascript","exec":[""]}}],"_postman_id":"1527c589-1304-4695-b610-0afe5d489166"},{"name":"Search","item":[{"name":"Unified Search (new)","event":[{"listen":"test","script":{"id":"1214a7f0-fab8-487f-bb25-4ba2fc1c4ccc","exec":[""],"type":"text/javascript","packages":{},"requests":{}}},{"listen":"prerequest","script":{"id":"139b23ca-422a-4bba-a94d-50b1598dd7a3","exec":[""],"type":"text/javascript","packages":{},"requests":{}}}],"id":"211b3d72-1176-49a0-b470-d06087656d3d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{access_key_user}}"},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"{{cw3_api_url}}/api/search/keyword?searchterm=ships&doctype=unified&itemsPerPage=20&page=1&total=800","description":"Title: Unified Search
\nUsage: New unified search - assets and collections are now included in the search index and can be searched separately or combined. This endpoint supercedes the previous keyword search. With no params other than the search term, the response will return page 1 of results, with default of 100 items per page. Only assets are returned by default unless specified by the doctype parameter, which can be either
\ndoctype=collection - search and return collections only
\ndoctype=unified - search and return assets and collections
\nOnly published assets are returned, and access rights with be honored based on the user (logged in or anonymous).
\nAdvanced search terms are available which allow searching in specific metadata fields. e.g @Description:Gecko foot// will search for 'Gecko foot' only in the metadata field defined as the Description field
\nTo return facets for additional search filtering, reissue the search request and include the parameter 'facets_only=true'
\npagination is achieved by itemsPerPage to define number of results to return; page to specific which page of results. note that it is important during paging to pass back the total number of results in the total parameter as search cannot predetermine available results to calculate pages
\nResponse Status: 200 OK
\n","urlObject":{"path":["api","search","keyword"],"host":["{{cw3_api_url}}"],"query":[{"key":"searchterm","value":"ships"},{"key":"doctype","value":"unified"},{"key":"itemsPerPage","value":"20"},{"key":"page","value":"1"},{"key":"total","value":"800"},{"disabled":true,"key":"searchrefine[]","value":"facet2:Video"},{"disabled":true,"key":"sort","value":"desc:exif_datetimeoriginal"}],"variable":[]}},"response":[{"id":"da9331fa-2b22-4181-a90b-b36266cda9df","name":"Unified search (success)","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"{{cw3_api_url}}/api/search/keyword?searchterm=ships&doctype=unified&itemsPerPage=20","host":["{{cw3_api_url}}"],"path":["api","search","keyword"],"query":[{"key":"searchterm","value":"ships"},{"key":"doctype","value":"unified","type":"text"},{"key":"itemsPerPage","value":"20"},{"key":"page","value":"1","disabled":true},{"key":"total","value":"800","disabled":true},{"key":"sort","value":"desc:exif_datetimeoriginal","disabled":true},{"key":"searchrefine[]","value":"facet2:Video","disabled":true},{"key":"searchrefine[]","value":"facet1:Horizontal","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Origin","value":"","description":"Specifies a URI that may access the resource. For requests without credentials, the server may specify '*' as a wildcard, thereby allowing any origin to access the resource."},{"key":"Connection","value":"Upgrade, Keep-Alive","description":"Options that are desired for the connection"},{"key":"Content-Encoding","value":"gzip","description":"The type of encoding used on the data."},{"key":"Content-Language","value":"en","description":"The language the content is in"},{"key":"Content-Type","value":"application/json; charset=UTF-8","description":"The mime type of this content"},{"key":"Date","value":"Fri, 11 May 2018 08:34:37 GMT","description":"The date and time that the message was sent"},{"key":"Keep-Alive","value":"timeout=5, max=100","description":"Custom header"},{"key":"Server","value":"Apache","description":"A name for the server"},{"key":"Transfer-Encoding","value":"chunked","description":"The form of encoding used to safely transfer the entity to the user. Currently defined methods are: chunked, compress, deflate, gzip, identity."},{"key":"Upgrade","value":"h2,h2c","description":"Custom header"},{"key":"Vary","value":"Accept-Encoding","description":"Tells downstream proxies how to match future request headers to decide whether the cached response can be used rather than requesting a fresh one from the origin server."},{"key":"X-Powered-By","value":"capture API","description":"Specifies the technology (ASP.NET, PHP, JBoss, e.g.) supporting the web application (version details are often in X-Runtime, X-Version, or X-AspNet-Version)"}],"cookie":[],"responseTime":null,"body":"{\r\n \"status\": 200,\r\n \"data\": {\r\n \"meta\": {\r\n \"total\": \"3\",\r\n \"found\": \"3\",\r\n \"returned\": 3,\r\n \"pages\": 1,\r\n \"page\": 1,\r\n \"from\": 1,\r\n \"to\": 3,\r\n \"searchterms\": \"ships\",\r\n \"searchterms_usr\": \"ships\",\r\n \"searchterms_adv\": [],\r\n \"searchrefine\": []\r\n },\r\n \"facets\": [],\r\n \"results\": [\r\n {\r\n \"doc_id\": 15,\r\n \"doc_type\": \"collection\",\r\n \"response_data\": \"JIT\",\r\n \"summary\": {\r\n \"collection_id\": 15,\r\n \"id_category\": 15,\r\n \"id_parent\": 0,\r\n \"name\": \"Ships Ahoy!\",\r\n \"description\": \"text\",\r\n \"is_public\": true,\r\n \"is_published\": true,\r\n \"call_me_price\": 0,\r\n \"is_searchable\": true,\r\n \"colour_code\": 0,\r\n \"gallery\": true,\r\n \"render_type\": \"grid\",\r\n \"numbering_scheme\": {\r\n \"type\": \"asset_count\",\r\n \"total\": 6\r\n }\r\n },\r\n \"metadata\": {\r\n \"md1\": {\r\n \"column_name\": \"md1\",\r\n \"label\": \"Subject\",\r\n \"value\": null\r\n },\r\n \"md2\": {\r\n \"column_name\": \"md2\",\r\n \"label\": \"Description\",\r\n \"value\": null\r\n },\r\n \"md3\": {\r\n \"column_name\": \"md3\",\r\n \"label\": \"Keywords\",\r\n \"value\": \"boat,ship,marine,ocean\"\r\n }\r\n },\r\n \"asset_count\": 6,\r\n \"child_count\": 0,\r\n \"weight\": 1749,\r\n \"relevance\": 1749,\r\n \"pageNumber\": 1,\r\n \"lead_asset\": {\r\n \"summary\": {\r\n \"idasset\": 1,\r\n \"idusers\": 60,\r\n \"file_extension\": \"png\",\r\n \"org_filename\": \"ship.png\",\r\n \"filesize\": 347528,\r\n \"height\": 534,\r\n \"width\": 707,\r\n \"batchname\": \"5#60#16:28 7-02-18\",\r\n \"upload_date\": \"2018-02-07 16:28:25\",\r\n \"externalid1\": \"ship\",\r\n \"externalid2\": \"0\",\r\n \"call_me_price\": 0,\r\n \"publishing_date\": \"2020-02-14 15:04:20\",\r\n \"mime_type\": \"\",\r\n \"exif_datetimeoriginal\": null,\r\n \"file_duration\": null,\r\n \"idasset_status\": 1,\r\n \"exclusive_code\": 0,\r\n \"colour_code\": 0,\r\n \"compliance_code\": 0,\r\n \"base_type\": \"image\",\r\n \"license_types\": [],\r\n \"publication_status_id\": 2,\r\n \"is_published\": true,\r\n \"contact_id\": 25,\r\n \"response_data\": \"JIT\"\r\n },\r\n \"thumb\": {\r\n \"exists\": true,\r\n \"thumb_mimetype\": \"image/png\",\r\n \"griditem_width\": 360,\r\n \"griditem_height\": 272,\r\n \"url\": {\r\n \"1\": \"https://thumb-small.png\",\r\n \"3\": \"https://thumb-large.png\"\r\n }\r\n },\r\n \"preview\": {\r\n \"exists\": true,\r\n \"mimetype\": \"image/png\",\r\n \"url\": \"https://preview.png\"\r\n }\r\n }\r\n },\r\n {\r\n \"doc_id\": 18,\r\n \"doc_type\": \"asset\",\r\n \"response_data\": \"JIT\",\r\n \"summary\": {\r\n \"idasset\": 18,\r\n \"org_filename\": \"helicopter.jpg\",\r\n \"batchname\": \"1737547070\",\r\n \"externalid1\": \"helicopter\",\r\n \"externalid2\": \"0\",\r\n \"call_me_price\": 0,\r\n \"mime_type\": \"image/jpeg\",\r\n \"colour_code\": 0,\r\n \"compliance_code\": 0,\r\n \"publishing_date\": \"2025-04-25 16:23:32\",\r\n \"publishing_date_ut\": 1745594612,\r\n \"base_type\": \"image\",\r\n \"license_types\": []\r\n },\r\n \"metadata\": {\r\n \"externalid1\": {\r\n \"idmetadata_config\": 400,\r\n \"column_name\": \"externalid1\",\r\n \"label\": \"External identifier\",\r\n \"notes\": \"\",\r\n \"value\": \"helicopter\"\r\n },\r\n \"md1\": {\r\n \"idmetadata_config\": 18,\r\n \"column_name\": \"md1\",\r\n \"label\": \"Subject\",\r\n \"notes\": \"IPTC 105 - Headline\",\r\n \"value\": \"1950?\"\r\n }\r\n },\r\n \"inLightbox\": false,\r\n \"weight\": 1659,\r\n \"relevance\": 1659,\r\n \"groups\": \"0\",\r\n \"country_restrictions\": \"0\",\r\n \"pageNumber\": 1,\r\n \"thumb\": {\r\n \"exists\": true,\r\n \"thumb_mimetype\": \"image/jpeg\",\r\n \"griditem_width\": 360,\r\n \"griditem_height\": 240,\r\n \"url\": {\r\n \"1\": \"https://thumb-small.jpg\",\r\n \"3\": \"https://thumb-large.jpg\"\r\n }\r\n },\r\n \"preview\": {\r\n \"exists\": true,\r\n \"mimetype\": \"image/jpeg\",\r\n \"url\": \"https://preview.jpg\"\r\n }\r\n },\r\n {\r\n \"doc_id\": 19,\r\n \"doc_type\": \"asset\",\r\n \"response_data\": \"JIT\",\r\n \"summary\": {\r\n \"idasset\": 19,\r\n \"org_filename\": \"47985.jpg\",\r\n \"batchname\": \"1686660158\",\r\n \"externalid1\": \"47985\",\r\n \"externalid2\": \"Demo image 22 update\",\r\n \"call_me_price\": 0,\r\n \"mime_type\": \"image/jpeg\",\r\n \"colour_code\": 0,\r\n \"compliance_code\": 0,\r\n \"publishing_date\": \"2024-01-11 17:23:41\",\r\n \"publishing_date_ut\": 1704993821,\r\n \"base_type\": \"image\",\r\n \"license_types\": []\r\n },\r\n \"metadata\": {\r\n \"externalid1\": {\r\n \"idmetadata_config\": 400,\r\n \"column_name\": \"externalid1\",\r\n \"label\": \"External identifier\",\r\n \"notes\": \"\",\r\n \"value\": \"47985\"\r\n },\r\n \"md1\": {\r\n \"idmetadata_config\": 18,\r\n \"column_name\": \"md1\",\r\n \"label\": \"Subject\",\r\n \"notes\": \"IPTC 105 - Headline\",\r\n \"value\": \"subject text\"\r\n },\r\n \"md2\": {\r\n \"idmetadata_config\": 19,\r\n \"column_name\": \"md2\",\r\n \"label\": \"Description\",\r\n \"notes\": \"IPTC 120 - Capture, Abstract, Description\",\r\n \"value\": \"description text\"\r\n },\r\n \"md3\": {\r\n \"idmetadata_config\": 20,\r\n \"column_name\": \"md3\",\r\n \"label\": \"Keywords\",\r\n \"notes\": \"IPTC 25 - Keywords. \",\r\n \"value\": \"comma or semicolon separated keywords\"\r\n }\r\n },\r\n \"inLightbox\": false,\r\n \"weight\": 1659,\r\n \"relevance\": 1659,\r\n \"groups\": \"15\",\r\n \"country_restrictions\": \"0\",\r\n \"pageNumber\": 1,\r\n \"thumb\": {\r\n \"exists\": true,\r\n \"thumb_mimetype\": \"image/jpeg\",\r\n \"griditem_width\": 360,\r\n \"griditem_height\": 254,\r\n \"url\": {\r\n \"1\": \"https://thumb-small.jpg\",\r\n \"3\": \"https://thumb-large.jpg\"\r\n }\r\n },\r\n \"preview\": {\r\n \"exists\": true,\r\n \"mimetype\": \"image/jpeg\",\r\n \"url\": \"https://preview.jpg\"\r\n }\r\n }\r\n ]\r\n }\r\n}"}],"_postman_id":"211b3d72-1176-49a0-b470-d06087656d3d"},{"name":"Search by keyword (deprecated)","event":[{"listen":"test","script":{"id":"1214a7f0-fab8-487f-bb25-4ba2fc1c4ccc","exec":[""],"type":"text/javascript","packages":{},"requests":{}}},{"listen":"prerequest","script":{"packages":{},"type":"text/javascript"}}],"id":"17e257bb-ceb5-44d3-bdc3-188601e58ba7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{access_key_user}}"},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"{{cw3_api_url}}/api/search/keyword?itemsPerPage=20&group_type=gallery&page=1&total=810&access_token={{access_token_capture}}&searchterm=@Subject:Gecko @Keywords:Central","description":"Title: Search by Keyword.
\nUsage: This endpoint is deprecated in favour of the new unified search. This endpoint will perform a search for assets. With no params other than the search term, the response will return page 1 of results, with default of 100 items per page. Only published assets are returned, and access rights with be honored based on the user (logged in or anonymous).
\nAdvanced search terms are available which allow searching in specific metadata fields. e.g @Description:Gecko foot// will search for 'Gecko foot' only in the metadata field defined as the Description field
\nTo return facets for additional search filtering, reissue the search request and include the parameter 'facets_only=true'
\npagination is achieved by itemsPerPage to define number of results to return; page to specific which page of results. note that it is important during paging to pass back the total number of results in the total parameter as search cannot predetermine available results to calculate pages
\nResponse Status: 200 OK
\n","urlObject":{"path":["api","search","keyword"],"host":["{{cw3_api_url}}"],"query":[{"disabled":true,"key":"sort","value":"desc:exif_datetimeoriginal"},{"disabled":true,"key":"language_id","value":"1"},{"disabled":true,"key":"anonymous_token","value":"KWT5pxpTUe5p6emZyMZIRIROTYeHLJxzQPCvZNtr"},{"disabled":true,"key":"ip_address","value":"192.168.1.128"},{"disabled":true,"key":"groups[]","value":"14188"},{"key":"itemsPerPage","value":"20"},{"disabled":true,"key":"searchrefine[]","value":"facet2:Video"},{"key":"group_type","value":"gallery"},{"key":"page","value":"1"},{"key":"total","value":"810"},{"disabled":true,"key":"metadata","value":"Latin America"},{"disabled":true,"key":"label","value":""},{"key":"access_token","value":"{{access_token_capture}}"},{"key":"searchterm","value":"@Subject:Gecko @Keywords:Central"}],"variable":[]}},"response":[{"id":"6e421577-597c-4472-90f0-0134a3bbe416","name":"Search by keyword (success)","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"{{cw3_api_url}}/api/search/keyword?searchterm=ships&itemsPerPage=20","host":["{{cw3_api_url}}"],"path":["api","search","keyword"],"query":[{"key":"searchterm","value":"ships"},{"key":"itemsPerPage","value":"20"},{"key":"page","value":"1","disabled":true},{"key":"total","value":"800","disabled":true},{"key":"sort","value":"desc:exif_datetimeoriginal","disabled":true},{"key":"searchrefine[]","value":"facet2:Video","disabled":true},{"key":"searchrefine[]","value":"facet1:Horizontal","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Origin","value":"","description":"Specifies a URI that may access the resource. For requests without credentials, the server may specify '*' as a wildcard, thereby allowing any origin to access the resource."},{"key":"Connection","value":"Upgrade, Keep-Alive","description":"Options that are desired for the connection"},{"key":"Content-Encoding","value":"gzip","description":"The type of encoding used on the data."},{"key":"Content-Language","value":"en","description":"The language the content is in"},{"key":"Content-Type","value":"application/json; charset=UTF-8","description":"The mime type of this content"},{"key":"Date","value":"Fri, 11 May 2018 08:34:37 GMT","description":"The date and time that the message was sent"},{"key":"Keep-Alive","value":"timeout=5, max=100","description":"Custom header"},{"key":"Server","value":"Apache","description":"A name for the server"},{"key":"Transfer-Encoding","value":"chunked","description":"The form of encoding used to safely transfer the entity to the user. Currently defined methods are: chunked, compress, deflate, gzip, identity."},{"key":"Upgrade","value":"h2,h2c","description":"Custom header"},{"key":"Vary","value":"Accept-Encoding","description":"Tells downstream proxies how to match future request headers to decide whether the cached response can be used rather than requesting a fresh one from the origin server."},{"key":"X-Powered-By","value":"capture API","description":"Specifies the technology (ASP.NET, PHP, JBoss, e.g.) supporting the web application (version details are often in X-Runtime, X-Version, or X-AspNet-Version)"}],"cookie":[],"responseTime":null,"body":"{\r\n \"status\": 200,\r\n \"data\": {\r\n \"meta\": {\r\n \"total\": \"2\",\r\n \"found\": \"2\",\r\n \"returned\": 2,\r\n \"pages\": 1,\r\n \"page\": 1,\r\n \"from\": 1,\r\n \"to\": 2,\r\n \"searchterms\": \"ships\",\r\n \"searchterms_usr\": \"ships\",\r\n \"searchterms_adv\": [],\r\n \"searchterms_ex\": [\r\n \"ships\"\r\n ],\r\n \"actualterms\": {\r\n \"ship\": \"4\"\r\n },\r\n \"searchrefine\": []\r\n },\r\n \"facets\": [],\r\n \"results\": [\r\n {\r\n \"summary\": {\r\n \"idasset\": 10,\r\n \"idusers\": 60,\r\n \"org_filename\": \"helicopter.jpg\",\r\n \"batchname\": \"1737547070\",\r\n \"externalid1\": \"helicopter\",\r\n \"externalid2\": \"0\",\r\n \"call_me_price\": 0,\r\n \"mime_type\": \"image/jpeg\",\r\n \"exclusive_code\": 0,\r\n \"publishing_date\": \"2025-04-25 16:23:32\",\r\n \"publishing_date_ut\": 1745594612,\r\n \"base_type\": \"image\",\r\n \"license_types\": []\r\n },\r\n \"inLightbox\": false,\r\n \"weight\": 1659,\r\n \"groups\": \"0\",\r\n \"country_restrictions\": \"0\",\r\n \"metadata\": {\r\n \"externalid1\": {\r\n \"idmetadata_config\": 400,\r\n \"column_name\": \"externalid1\",\r\n \"label\": \"External identifier\",\r\n \"notes\": \"\",\r\n \"value\": \"helicopter\"\r\n },\r\n \"md1\": {\r\n \"idmetadata_config\": 18,\r\n \"column_name\": \"md1\",\r\n \"label\": \"Subject\",\r\n \"notes\": \"IPTC 105 - Headline\",\r\n \"value\": \"1950?\"\r\n },\r\n \"md2\": {\r\n \"idmetadata_config\": 19,\r\n \"column_name\": \"md2\",\r\n \"label\": \"Description\",\r\n \"notes\": \"IPTC 120 - Capture, Abstract, Description\",\r\n \"value\": \"Young pilots Ship 1, the first incarnation of his brainchild. (Niagara Aviation Museum)\"\r\n },\r\n \"md3\": {\r\n \"idmetadata_config\": 20,\r\n \"column_name\": \"md3\",\r\n \"label\": \"Keywords\",\r\n \"notes\": \"IPTC 25 - Keywords. \",\r\n \"value\": \"\"\r\n }\r\n },\r\n \"pageNumber\": 1,\r\n \"response_data\": \"JIT\",\r\n \"thumb\": {\r\n \"exists\": true,\r\n \"thumb_mimetype\": \"image/jpeg\",\r\n \"griditem_width\": 360,\r\n \"griditem_height\": 240,\r\n \"url\": {\r\n \"1\": \"https://thumb-small.jpg\",\r\n \"3\": \"https://thumb-large.jpg\"\r\n }\r\n },\r\n \"preview\": {\r\n \"exists\": true,\r\n \"mimetype\": \"image/jpeg\",\r\n \"url\": \"https://preview.jpg\"\r\n }\r\n },\r\n {\r\n \"summary\": {\r\n \"idasset\": 11,\r\n \"idusers\": 60,\r\n \"org_filename\": \"47985.jpg\",\r\n \"batchname\": \"1686660158\",\r\n \"externalid1\": \"47985\",\r\n \"externalid2\": \"Demo image\",\r\n \"call_me_price\": 0,\r\n \"mime_type\": \"image/jpeg\",\r\n \"exclusive_code\": 0,\r\n \"publishing_date\": \"2024-01-11 17:23:41\",\r\n \"publishing_date_ut\": 1704993821,\r\n \"base_type\": \"image\",\r\n \"license_types\": []\r\n },\r\n \"inLightbox\": false,\r\n \"weight\": 1659,\r\n \"groups\": \"15\",\r\n \"country_restrictions\": \"0\",\r\n \"metadata\": {\r\n \"externalid1\": {\r\n \"idmetadata_config\": 400,\r\n \"column_name\": \"externalid1\",\r\n \"label\": \"External identifier\",\r\n \"notes\": \"\",\r\n \"value\": \"47985\"\r\n },\r\n \"md1\": {\r\n \"idmetadata_config\": 18,\r\n \"column_name\": \"md1\",\r\n \"label\": \"Subject\",\r\n \"notes\": \"IPTC 105 - Headline\",\r\n \"value\": \"text\"\r\n },\r\n \"md2\": {\r\n \"idmetadata_config\": 19,\r\n \"column_name\": \"md2\",\r\n \"label\": \"Description\",\r\n \"notes\": \"IPTC 120 - Capture, Abstract, Description\",\r\n \"value\": \"a lot more text\"\r\n },\r\n \"md3\": {\r\n \"idmetadata_config\": 20,\r\n \"column_name\": \"md3\",\r\n \"label\": \"Keywords\",\r\n \"notes\": \"IPTC 25 - Keywords. \",\r\n \"value\": \"no people; horizontal; outdoors; day; sky; sea; ship\"\r\n }\r\n },\r\n \"pageNumber\": 1,\r\n \"response_data\": \"JIT\",\r\n \"thumb\": {\r\n \"exists\": true,\r\n \"thumb_mimetype\": \"image/jpeg\",\r\n \"griditem_width\": 360,\r\n \"griditem_height\": 254,\r\n \"url\": {\r\n \"1\": \"https://thumb-small.jpg\",\r\n \"3\": \"https://thumb-large.jpg\"\r\n }\r\n },\r\n \"preview\": {\r\n \"exists\": true,\r\n \"mimetype\": \"image/jpeg\",\r\n \"url\": \"https://preview.jpg\"\r\n }\r\n }\r\n ]\r\n }\r\n}"},{"id":"8255a5bc-a71a-4341-90ec-b6579f0bf457","name":"Search by keyword (fail forbidden due to rights)","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"{{cw3_api_url}}/api/search/keyword?searchterm=@Subject:Gecko @Keywords:Central&itemsPerPage=20&page=1&total=800","host":["{{cw3_api_url}}"],"path":["api","search","keyword"],"query":[{"key":"searchterm","value":"@Subject:Gecko @Keywords:Central"},{"key":"itemsPerPage","value":"20"},{"key":"page","value":"1"},{"key":"total","value":"800"},{"key":"sort","value":"desc:exif_datetimeoriginal","disabled":true},{"key":"searchrefine[]","value":"facet2:Video","disabled":true}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Origin","value":"","description":"Specifies a URI that may access the resource. For requests without credentials, the server may specify '*' as a wildcard, thereby allowing any origin to access the resource."},{"key":"Connection","value":"Upgrade, Keep-Alive","description":"Options that are desired for the connection"},{"key":"Content-Language","value":"en","description":"The language the content is in"},{"key":"Content-Type","value":"application/json; charset=UTF-8","description":"The mime type of this content"},{"key":"Date","value":"Thu, 31 May 2018 10:59:20 GMT","description":"The date and time that the message was sent"},{"key":"Keep-Alive","value":"timeout=5, max=100","description":"Custom header"},{"key":"Server","value":"Apache/2.4.33 (Win64) mod_fcgid/2.3.9","description":"A name for the server"},{"key":"Transfer-Encoding","value":"chunked","description":"The form of encoding used to safely transfer the entity to the user. Currently defined methods are: chunked, compress, deflate, gzip, identity."},{"key":"Upgrade","value":"h2,h2c","description":"Custom header"},{"key":"X-Powered-By","value":"capture API","description":"Specifies the technology (ASP.NET, PHP, JBoss, e.g.) supporting the web application (version details are often in X-Runtime, X-Version, or X-AspNet-Version)"}],"cookie":[],"responseTime":null,"body":"{\r\n \"status\":403,\r\n \"api_status\":{\r\n \"code\":\"fail_1000\",\r\n \"message\":\"forbidden\",\r\n \"description\":\"insufficient rights\"\r\n },\r\n \"error\":{\r\n \"message\":\"forbidden\",\r\n \"summary\":\"insufficient rights\"\r\n }\r\n}"}],"_postman_id":"17e257bb-ceb5-44d3-bdc3-188601e58ba7"}],"id":"8a8b68ee-0210-40ca-83a1-6b7480f2fbb8","description":"Allows full text search across the assets. can also optionally generate facets to allow refined search. Only supports basic boolean operators (AND, OR, NOT).
\n","event":[{"listen":"prerequest","script":{"id":"6887b479-1ae1-4a6f-b26a-5fca9853a1a6","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"aac8f6b3-4026-49d9-a712-a99fdd2e7a5b","type":"text/javascript","exec":[""]}}],"_postman_id":"8a8b68ee-0210-40ca-83a1-6b7480f2fbb8"},{"name":"System","item":[{"name":"Get Registration Form Fields","event":[{"listen":"test","script":{"id":"4e908033-fb4e-41d0-a95c-f05c1b8603f3","exec":[""],"type":"text/javascript","packages":{},"requests":{}}},{"listen":"prerequest","script":{"packages":{},"type":"text/javascript"}}],"id":"4043ecaa-ee86-4577-9723-488b032f074d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"{{cw3_api_url}}/api/system/formfields/registration","description":"Title: Get Registration Form Fields API call endpoint.
\nUse Case: When the user hit an API Call Endpoint, it returns all the registration information from the database which has filled by the user. The information varies depends on each user registration.
\nResponse Status: 200 OK
\n","urlObject":{"path":["api","system","formfields","registration"],"host":["{{cw3_api_url}}"],"query":[],"variable":[]}},"response":[{"id":"0b696977-6573-4e00-80eb-6e91a5a87025","name":"Get Registration Form Fields","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"{{cw3_api_url}}/api/system/formfields/registration"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Origin","value":"","name":"Access-Control-Allow-Origin","description":"Specifies a URI that may access the resource. For requests without credentials, the server may specify '*' as a wildcard, thereby allowing any origin to access the resource."},{"key":"Connection","value":"Upgrade, Keep-Alive","name":"Connection","description":"Options that are desired for the connection"},{"key":"Content-Encoding","value":"gzip","name":"Content-Encoding","description":"The type of encoding used on the data."},{"key":"Content-Language","value":"en","name":"Content-Language","description":"The language the content is in"},{"key":"Content-Length","value":"1397","name":"Content-Length","description":"The length of the response body in octets (8-bit bytes)"},{"key":"Content-Type","value":"application/json; charset=UTF-8","name":"Content-Type","description":"The mime type of this content"},{"key":"Date","value":"Fri, 11 May 2018 09:26:54 GMT","name":"Date","description":"The date and time that the message was sent"},{"key":"Keep-Alive","value":"timeout=5, max=100","name":"Keep-Alive","description":"Custom header"},{"key":"Server","value":"Apache","name":"Server","description":"A name for the server"},{"key":"Upgrade","value":"h2,h2c","name":"Upgrade","description":"Custom header"},{"key":"Vary","value":"Accept-Encoding","name":"Vary","description":"Tells downstream proxies how to match future request headers to decide whether the cached response can be used rather than requesting a fresh one from the origin server."},{"key":"X-Powered-By","value":"capture API","name":"X-Powered-By","description":"Specifies the technology (ASP.NET, PHP, JBoss, e.g.) supporting the web application (version details are often in X-Runtime, X-Version, or X-AspNet-Version)"}],"cookie":[],"responseTime":null,"body":"{\"status\":200,\"data\":{\"email\":{\"is_editable\":false,\"code\":\"EMAIL\",\"name\":\"email\",\"db_name\":\"custom_field_1\",\"field_type\":\"text\",\"validation_pattern\":\"\\/^[a-zA-Z0-9_\\\\'\\\\.\\\\-]+@[a-zA-Z0-9\\\\-]+\\\\.[a-zA-Z0-9\\\\'\\\\-\\\\.]+$\\/\",\"default_value\":\"\",\"max_length\":\"50\",\"contact_field_name\":\"email\",\"field_name\":\"email\",\"label\":\"Email *\",\"description\":\"Email address\",\"required\":true},\"password\":{\"is_editable\":true,\"code\":\"PASSWORD\",\"name\":\"password\",\"db_name\":\"custom_field_2\",\"field_type\":\"password\",\"validation_pattern\":\"\\/^.+$\\/\",\"default_value\":\"\",\"max_length\":\"32\",\"contact_field_name\":\"pword\",\"field_name\":\"password\",\"label\":\"Create password *\",\"description\":\"Password \",\"required\":true},\"password_confirm\":{\"is_editable\":true,\"code\":\"PASSWORD_CONFIRM\",\"name\":\"password_confirm\",\"db_name\":\"\",\"field_type\":\"password\",\"validation_pattern\":\"\",\"default_value\":null,\"max_length\":null,\"contact_field_name\":\"\",\"field_name\":\"password_confirm\",\"label\":\"Confirm password *\",\"description\":\"Confirm Password\",\"required\":true},\"first_name\":{\"is_editable\":true,\"code\":\"FIRST_NAME\",\"name\":\"first_name\",\"db_name\":\"custom_field_5\",\"field_type\":\"text\",\"validation_pattern\":\"\\/^.+$\\/\",\"default_value\":null,\"max_length\":null,\"contact_field_name\":\"fname\",\"field_name\":\"first_name\",\"label\":\"First name *\",\"description\":\"First name\",\"required\":true},\"last_name\":{\"is_editable\":true,\"code\":\"LAST_NAME\",\"name\":\"last_name\",\"db_name\":\"custom_field_6\",\"field_type\":\"text\",\"validation_pattern\":\"\\/^.+$\\/\",\"default_value\":null,\"max_length\":null,\"contact_field_name\":\"lname\",\"field_name\":\"last_name\",\"label\":\"Last name *\",\"description\":\"Last name\",\"required\":true},\"self_employed\":{\"is_editable\":true,\"code\":\"SELF_EMPLOYED\",\"name\":\"self_employed\",\"db_name\":\"custom_field_31\",\"field_type\":\"checkbox\",\"validation_pattern\":\"\",\"default_value\":null,\"max_length\":null,\"contact_field_name\":\"\",\"field_name\":\"self_employed\",\"label\":\"Single User \\/ Self Employed\",\"description\":\"The user is not associated with an organisation or company.\",\"required\":false},\"company\":{\"is_editable\":true,\"code\":\"COMPANY\",\"name\":\"company\",\"db_name\":\"custom_field_7\",\"field_type\":\"text\",\"validation_pattern\":\"\\/^.+$\\/\",\"default_value\":\"\",\"max_length\":\"255\",\"contact_field_name\":\"company_name\",\"field_name\":\"company\",\"label\":\"Organization name *\",\"description\":\"Organization name\",\"required\":true},\"organisation_type\":{\"is_editable\":true,\"code\":\"ORG_TYPE\",\"name\":\"organisation_type\",\"db_name\":\"custom_field_25\",\"field_type\":\"select\",\"validation_pattern\":\"\\/^.+$\\/\",\"default_value\":\"\",\"max_length\":\"255\",\"contact_field_name\":\"\",\"field_name\":\"organisation_type\",\"label\":\"Company Type\",\"description\":\"Company Type\",\"required\":false},\"address_1\":{\"is_editable\":true,\"code\":\"ADDRESS\",\"name\":\"address_1\",\"db_name\":\"custom_field_18\",\"field_type\":\"text\",\"validation_pattern\":\"\\/^.+$\\/\",\"default_value\":null,\"max_length\":null,\"contact_field_name\":\"address1\",\"field_name\":\"address_1\",\"label\":\"Address 1 *\",\"description\":\"Address 1\",\"required\":true},\"product_category\":{\"is_editable\":false,\"code\":\"PRODUCT_CATEGORY\",\"name\":\"product_category\",\"db_name\":\"custom_field_50\",\"field_type\":\"text\",\"validation_pattern\":\"\\/^.+$\\/\",\"default_value\":\"0\",\"max_length\":\"255\",\"contact_field_name\":\"idcontact_product_category\",\"field_name\":\"product_category\",\"label\":\"Extended Access Code\",\"description\":\"Extended Access Code\",\"required\":true},\"address_2\":{\"is_editable\":true,\"code\":\"ADDRESS2\",\"name\":\"address_2\",\"db_name\":\"custom_field_19\",\"field_type\":\"text\",\"validation_pattern\":\"\\/^.+$\\/\",\"default_value\":null,\"max_length\":null,\"contact_field_name\":\"address2\",\"field_name\":\"address_2\",\"label\":\"Address 2\",\"description\":\"Address 2\",\"required\":false},\"idcontact_category\":{\"is_editable\":false,\"code\":\"CONTACT_CATEGORY\",\"name\":\"idcontact_category\",\"db_name\":\"not_used\",\"field_type\":\"select\",\"validation_pattern\":\"\\/^d+$\\/\",\"default_value\":\"0\",\"max_length\":\"255\",\"contact_field_name\":\"idcontact_category\",\"field_name\":\"idcontact_category\",\"label\":\"Contact Category\",\"description\":\"Contact Category\",\"required\":true},\"address_3\":{\"is_editable\":true,\"code\":\"ADDRESS3\",\"name\":\"address_3\",\"db_name\":\"custom_field_20\",\"field_type\":\"text\",\"validation_pattern\":\"\\/^.+$\\/\",\"default_value\":null,\"max_length\":null,\"contact_field_name\":\"address3\",\"field_name\":\"address_3\",\"label\":\"Address 3\",\"description\":\"Address 3\",\"required\":false},\"idcontact_type\":{\"is_editable\":false,\"code\":\"CONTACT_TYPE\",\"name\":\"idcontact_type\",\"db_name\":\"not_used\",\"field_type\":\"select\",\"validation_pattern\":\"\\/^d+$\\/\",\"default_value\":\"0\",\"max_length\":\"255\",\"contact_field_name\":\"idcontact_type\",\"field_name\":\"idcontact_type\",\"label\":\"Contact Type\",\"description\":\"Contact Type\",\"required\":true},\"city\":{\"is_editable\":true,\"code\":\"CITY\",\"name\":\"city\",\"db_name\":\"custom_field_16\",\"field_type\":\"text\",\"validation_pattern\":\"\\/^.+$\\/\",\"default_value\":\"\",\"max_length\":null,\"contact_field_name\":\"town\",\"field_name\":\"city\",\"label\":\"City\\/Town *\",\"description\":\"City\\/Town\",\"required\":true},\"county\":{\"is_editable\":true,\"code\":\"COUNTY\",\"name\":\"county\",\"db_name\":\"custom_field_15\",\"field_type\":\"text\",\"validation_pattern\":\"\\/^.+$\\/\",\"default_value\":\"\",\"max_length\":\"100\",\"contact_field_name\":\"county\",\"field_name\":\"county\",\"label\":\"State\\/County\",\"description\":\"State\\/County\",\"required\":false},\"postcode\":{\"is_editable\":true,\"code\":\"POSTCODE\",\"name\":\"postcode\",\"db_name\":\"custom_field_17\",\"field_type\":\"text\",\"validation_pattern\":\"\\/^.+$\\/\",\"default_value\":\"\",\"max_length\":\"10\",\"contact_field_name\":\"post_code\",\"field_name\":\"postcode\",\"label\":\"Zip\\/Postal Code *\",\"description\":\"Zip\\/Postal Code\",\"required\":true},\"us_state\":{\"is_editable\":true,\"code\":\"US_STATE\",\"name\":\"us_state\",\"db_name\":\"custom_field_29\",\"field_type\":\"select\",\"validation_pattern\":\"\\/^.+$\\/\",\"default_value\":\"\",\"max_length\":\"255\",\"contact_field_name\":\"\",\"field_name\":\"us_state\",\"label\":\"State*\",\"description\":\"State*\",\"required\":false},\"country\":{\"is_editable\":true,\"code\":\"COUNTRY\",\"name\":\"country\",\"db_name\":\"custom_field_14\",\"field_type\":\"select\",\"validation_pattern\":\"\\/^[0-9]+$\\/\",\"default_value\":null,\"max_length\":null,\"contact_field_name\":\"idcountry\",\"field_name\":\"country\",\"label\":\"Country *\",\"description\":\"country\",\"required\":true},\"phone\":{\"is_editable\":true,\"code\":\"PHONE\",\"name\":\"phone\",\"db_name\":\"custom_field_10\",\"field_type\":\"text\",\"validation_pattern\":\"\\/^.+$\\/\",\"default_value\":\"\",\"max_length\":\"20\",\"contact_field_name\":\"tel\",\"field_name\":\"phone\",\"label\":\"Phone *\",\"description\":\"Primary telephone number\",\"required\":true},\"sponsor_name\":{\"is_editable\":false,\"code\":\"SPONSOR_NAME\",\"name\":\"sponsor_name\",\"db_name\":\"custom_field_30\",\"field_type\":\"text\",\"validation_pattern\":\"\\/^.+$\\/\",\"default_value\":\"\",\"max_length\":\"50\",\"contact_field_name\":\"\",\"field_name\":\"sponsor_name\",\"label\":\"Sponsor name *\",\"description\":\"Sponsor name *\",\"required\":true},\"sponsor_email\":{\"is_editable\":false,\"code\":\"SPONSOR_EMAIL\",\"name\":\"sponsor_email\",\"db_name\":\"custom_field_45\",\"field_type\":\"text\",\"validation_pattern\":\"\\/^[a-zA-Z0-9_\\\\.\\\\-]+@[a-zA-Z0-9\\\\-]+\\\\.[a-zA-Z0-9\\\\-\\\\.]+$\\/\",\"default_value\":\"\",\"max_length\":\"50\",\"contact_field_name\":\"\",\"field_name\":\"sponsor_email\",\"label\":\"Sponsor email *\",\"description\":\"Sponsor email\",\"required\":true},\"sponsor_office\":{\"is_editable\":false,\"code\":\"SPONSOR_OFFICE\",\"name\":\"sponsor_office\",\"db_name\":\"custom_field_32\",\"field_type\":\"text\",\"validation_pattern\":\"\\/^.+$\\/\",\"default_value\":\"\",\"max_length\":\"50\",\"contact_field_name\":\"\",\"field_name\":\"sponsor_office\",\"label\":\"Sponsor office\",\"description\":\"Sponsor office\",\"required\":false},\"sponsor_phone\":{\"is_editable\":false,\"code\":\"SPONSOR_PHONE\",\"name\":\"sponsor_phone\",\"db_name\":\"custom_field_34\",\"field_type\":\"text\",\"validation_pattern\":\"\\/^.+$\\/\",\"default_value\":\"\",\"max_length\":\"50\",\"contact_field_name\":\"\",\"field_name\":\"sponsor_phone\",\"label\":\"Sponsor phone\",\"description\":\"Sponsor phone\",\"required\":false},\"Project\":{\"is_editable\":false,\"code\":\"PROJECT\",\"name\":\"Project\",\"db_name\":\"custom_field_33\",\"field_type\":\"text\",\"validation_pattern\":\"\\/^.+$\\/\",\"default_value\":\"\",\"max_length\":\"50\",\"contact_field_name\":\"\",\"field_name\":\"Project\",\"label\":\"Project title\",\"description\":\"Project title\",\"required\":false}}}"}],"_postman_id":"4043ecaa-ee86-4577-9723-488b032f074d"},{"name":"Get System Permissions","event":[{"listen":"test","script":{"id":"32556b8c-d9b7-4a8f-9dbf-f5d0869e97ed","exec":[""],"type":"text/javascript","packages":{},"requests":{}}},{"listen":"prerequest","script":{"packages":{},"type":"text/javascript"}}],"id":"8cb1239c-983b-47f4-aa7d-4cd34faf6b1f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"{{cw3_api_url}}/api/system/permissions","description":"Title: Get System Permissions API call endpoint.
\nUse Case:When the user access the URL, the user can have hires/lowres access depends on the system permissions. The user ers can use lightboxes, download presentation files and access hires. If the user has the right to download an asset as hires and the system permissions are set to disallow hires downloads, the user will not have the the options in the UI.
\nResponse Status: 200 OK
\n","urlObject":{"path":["api","system","permissions"],"host":["{{cw3_api_url}}"],"query":[],"variable":[]}},"response":[{"id":"c9fd3933-cb51-408f-a270-79c82f446d8b","name":"Get System Permissions","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"{{cw3_api_url}}/api/system/permissions"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Origin","value":"","name":"Access-Control-Allow-Origin","description":"Specifies a URI that may access the resource. For requests without credentials, the server may specify '*' as a wildcard, thereby allowing any origin to access the resource."},{"key":"Connection","value":"Upgrade, Keep-Alive","name":"Connection","description":"Options that are desired for the connection"},{"key":"Content-Encoding","value":"gzip","name":"Content-Encoding","description":"The type of encoding used on the data."},{"key":"Content-Language","value":"en","name":"Content-Language","description":"The language the content is in"},{"key":"Content-Length","value":"256","name":"Content-Length","description":"The length of the response body in octets (8-bit bytes)"},{"key":"Content-Type","value":"application/json; charset=UTF-8","name":"Content-Type","description":"The mime type of this content"},{"key":"Date","value":"Fri, 11 May 2018 09:50:17 GMT","name":"Date","description":"The date and time that the message was sent"},{"key":"Keep-Alive","value":"timeout=5, max=100","name":"Keep-Alive","description":"Custom header"},{"key":"Server","value":"Apache","name":"Server","description":"A name for the server"},{"key":"Upgrade","value":"h2,h2c","name":"Upgrade","description":"Custom header"},{"key":"Vary","value":"Accept-Encoding","name":"Vary","description":"Tells downstream proxies how to match future request headers to decide whether the cached response can be used rather than requesting a fresh one from the origin server."},{"key":"X-Powered-By","value":"capture API","name":"X-Powered-By","description":"Specifies the technology (ASP.NET, PHP, JBoss, e.g.) supporting the web application (version details are often in X-Runtime, X-Version, or X-AspNet-Version)"}],"cookie":[],"responseTime":null,"body":"{\"status\":200,\"data\":{\"ANONYMOUS_USER_ACCESS_LIGHTBOX\":true,\"ANONYMOUS_USER_ACCESS_BASKET\":false,\"ANONYMOUS_USER_COMP_IMAGE_DOWNLOAD\":true,\"AUTHORIZED_USER_COMP_IMAGE_DOWNLOAD\":true,\"ANONYMOUS_USER_QUICK_SEARCH\":true,\"AUTHORIZED_USER_QUICK_SEARCH\":true,\"AUTHORIZED_USER_ACCESS_LIGHTBOX\":true,\"AUTHORIZED_USER_ACCESS_BASKET\":true,\"ANONYMOUS_USER_ACCESS_ZOOM_SCREEN\":true,\"AUTHORIZED_USER_ACCESS_ZOOM_SCREEN\":true,\"ANONYMOUS_USER_UNWATERMARKED_ZOOM_IMAGE\":false,\"ANONYMOUS_USER_UNWATERMARKED_COMP_IMAGE\":false,\"AUTHORIZED_USER_UNWATERMARKED_ZOOM_IMAGE\":false,\"AUTHORIZED_USER_UNWATERMARKED_COMP_IMAGE\":false,\"AUTHORIZED_USER_ACCESS_ECOMMERCE\":true,\"AUTHORIZED_USER_QUOTE_ORDER\":false,\"ANONYMOUS_USER_PRESENTATION_DOWNLOAD\":true,\"AUTHORIZED_USER_PRESENTATION_DOWNLOAD\":true,\"AUTHORIZED_USER_CALL_ME_DOWNLOAD\":false,\"AUTHORIZED_USER_HI_RES_ASSET_DIRECT_DOWNLOAD\":true,\"ANONYMOUS_USER_HI_RES_ASSET_DIRECT_DOWNLOAD\":true}}"}],"_postman_id":"8cb1239c-983b-47f4-aa7d-4cd34faf6b1f"},{"name":"API Version","event":[{"listen":"test","script":{"id":"9869687a-05fd-4122-91d6-7dc30f035fb7","exec":[""],"type":"text/javascript","packages":{},"requests":{}}},{"listen":"prerequest","script":{"packages":{},"type":"text/javascript"}}],"id":"a2b0d3e3-debd-449d-9ae5-46fc22e24b99","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"{{cw3_api_url}}/api/version","description":"GET /version
\nUse Case : Returns the version and general details about the API.
\nResponse Status : 200 OK
\n","urlObject":{"path":["api","version"],"host":["{{cw3_api_url}}"],"query":[],"variable":[]}},"response":[{"id":"00e563e7-f441-484e-b32c-129cbdbbd92e","name":"API Version","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"{{cw3_api_url}}/api/version"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Origin","value":"","description":"Specifies a URI that may access the resource. For requests without credentials, the server may specify '*' as a wildcard, thereby allowing any origin to access the resource."},{"key":"Connection","value":"Upgrade, Keep-Alive","description":"Options that are desired for the connection"},{"key":"Content-Encoding","value":"gzip","description":"The type of encoding used on the data."},{"key":"Content-Language","value":"en","description":"The language the content is in"},{"key":"Content-Length","value":"106","description":"The length of the response body in octets (8-bit bytes)"},{"key":"Content-Type","value":"application/json; charset=UTF-8","description":"The mime type of this content"},{"key":"Date","value":"Wed, 02 May 2018 09:56:53 GMT","description":"The date and time that the message was sent"},{"key":"Keep-Alive","value":"timeout=5, max=100","description":"Custom header"},{"key":"Server","value":"Apache","description":"A name for the server"},{"key":"Upgrade","value":"h2,h2c","description":"Custom header"},{"key":"Vary","value":"Accept-Encoding","description":"Tells downstream proxies how to match future request headers to decide whether the cached response can be used rather than requesting a fresh one from the origin server."},{"key":"X-Powered-By","value":"capture API","description":"Specifies the technology (ASP.NET, PHP, JBoss, e.g.) supporting the web application (version details are often in X-Runtime, X-Version, or X-AspNet-Version)"}],"cookie":[],"responseTime":null,"body":"{\r\n \"status\": 200,\r\n \"data\": {\r\n \"site\": \"Example\",\r\n \"version\": \"3.2.114.0\",\r\n \"copyright\": \"© 2018-2026 Capture Ltd\"\r\n }\r\n}"}],"_postman_id":"a2b0d3e3-debd-449d-9ae5-46fc22e24b99"}],"id":"0f4a9e38-4336-4a04-811d-ab0eef6f0329","description":"General methods that need to be publicly exposed that dont fit into any of the other sections.
\n","event":[{"listen":"prerequest","script":{"id":"6733ca8b-2c20-4917-b2c6-e9b155d1bb87","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"2a1a933e-4b6d-4148-87f4-44282ec3c29c","type":"text/javascript","exec":[""]}}],"_postman_id":"0f4a9e38-4336-4a04-811d-ab0eef6f0329"}],"event":[{"listen":"prerequest","script":{"id":"efc2ba75-16bf-432b-9880-e7b47e75d26b","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"dd262450-a9d7-4e8f-9955-a2abbc7498ce","type":"text/javascript","exec":[""]}}],"variable":[{"id":"d1f5950a-7ec2-4b08-b221-7e4fe0acd8a4","key":"username","value":"example@example.com","type":"string"}]}