{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"95c4ffbb-8b71-4837-bfaa-9644d0832fa2","name":"ProtectionPro Report API v2 (Doc v1.4.1)","description":"# Updates\n## Version 1.4.1 ~ 2012-01-25 to 2012-02-26\n\n**CutToken**\n- Added: serial_number (Serial number of machine used to cut)\n- Added: pack (ID of Pack, contains material and size of blank)\n- Added: app_version (Version of app used to cut)\n- Removed: cutter (Replace with `Printer > name`)\n- **Depercated**: size (For size of pattern cut replace with `Pattern > BlankSize` for size of blank replace with `Pack > size`)\n\n**Store**\n- country (Type changed to UUID link to `Country`\n- renamed: `zip_code` changed to `postal_code`\n\n**CutPattern**\n- Added: pattern_type (Use `PatternType > name` to Type name)\n\n**DeviceModel**\n- Added: date_of_release (when model was released to market)\n\n**Pack**\n- Added model\n\n----  \n# Dynamic API\n----  \nThe filtering and paging support allows for the API to be easily used for both easy acquisition of **bulk data** or quick access to **specific data** for interactive access.\n\n# API Server Address\n----  \n* API Access URL: `{{server}}{{port}}/{{report_endpoint}}`\n\n# API Auth Token\n----\nA Token or Code is used to access the API\n\nAuth Tokens are passed by the `Authorization: Token {API_KEY}` header\n\n## Examples\n~~~\n`--header 'Authorization: {{AuthToken}}'`  \n~~~\nUse the Authorization header with your API auth token\n~~~\n--header 'Authorization: Token 5c62f3c71c94f59611c6238f2250a3c18cb52ff'\n~~~\nTo learn more about your Tokens or how to get one, see the Authentication section below.\n\n\n# Filtering and page control\n----  \nDynamic API endpoints support the use of filtering and page control\n\n* `page=n` allow access to more pages of returned data\n  * The returned headers `Link`, `Page`, `Per-Page`, `Total-Items`, `Total-Pages` are returned if there is more data than will fit within a single page\n  <br /><br />\n\n* `page_size=n` allows changing the **number of items per page**. (max 10,000)\n  * **Example:** \n    ~~~\n    {{server}}{{port}}/{{report_endpoint}}/CutToken/?page_size=2000\n    ~~~\n    <br /><br />\n\n* `filter{field}=value` allow **filtering on any field** of the returned data use.\n  * **Example:** Get 2000 CutTokens per page for all tokens consumed(CutToken Used) from July 1 to July 16 of 2018  \n    ~~~\n    {{server}}{{port}}/{{report_endpoint}}/CutToken/?page_size=2000&filter{consumed.gt}=2018-07-01&filter{consumed.lt}=2018-07-16\n    ~~~\n  * **Example:** Get all Cut Tokens modified since 2019-August-01, return 2000 per page list them by newest first\n    ~~~\n    {{server}}{{port}}/{{report_endpoint}}/CutToken/?page_size=2000&filter{modified_on.gt}=2019-08-01&sort[]=-modified_on\n    ~~~\n    <br /><br />\n\n* `filter{-field}=value` to exclude items that match the filter\n  * **Example:** Show all pattern types that are **not** the \"screen\"\n    ~~~\n    {{server}}{{port}}/{{report_endpoint}}/Printer/?filter{-name}=Screen\n    ~~~\n    <br /><br />\n~~~\n~~~\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"10282439","team":682431,"collectionId":"95c4ffbb-8b71-4837-bfaa-9644d0832fa2","publishedId":"TVzYhEjF","public":true,"publicUrl":"https://docs.clearplex.com","privateUrl":"https://go.postman.co/documentation/10282439-95c4ffbb-8b71-4837-bfaa-9644d0832fa2","customColor":{"top-bar":"333333","right-sidebar":"303030","highlight":"da291c"},"documentationLayout":"classic-double-column","customisation":null,"version":"8.10.1","publishDate":"2021-04-16T20:16:56.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{},"logos":{}},"statusCode":200},"environments":[{"name":"Production (Documentation)","id":"b02a1d6c-15cb-4d32-bb51-c94c5bd63073","owner":"10282439","values":[{"key":"server","value":"https://auto.clearplex.com","enabled":true},{"key":"port","value":"","enabled":true},{"key":"AuthToken","value":"Token x3rnt3t5znzyid456g285kpzy1oq0hgbvsbvfn0y","enabled":true},{"key":"report_endpoint","value":"report_api/v2","enabled":true}],"published":true}],"user":{"authenticated":false,"permissions":{"publish":false}},"run":{"button":{"js":"https://run.pstmn.io/button.js","css":"https://run.pstmn.io/button.css"}},"web":"https://www.getpostman.com/","team":{"logo":"https://res.cloudinary.com/postman/image/upload/t_team_logo_pubdoc/v1/team/be619de025847ab59b4436d4115a3ef9e0cef946f8e7e112946eed963fecc469","favicon":"https://clearplex.com/favicon.ico"},"isEnvFetchError":false,"languages":"[{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"HttpClient\"},{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"RestSharp\"},{\"key\":\"curl\",\"label\":\"cURL\",\"variant\":\"cURL\"},{\"key\":\"dart\",\"label\":\"Dart\",\"variant\":\"http\"},{\"key\":\"go\",\"label\":\"Go\",\"variant\":\"Native\"},{\"key\":\"http\",\"label\":\"HTTP\",\"variant\":\"HTTP\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"OkHttp\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"Unirest\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"Fetch\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"jQuery\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"XHR\"},{\"key\":\"c\",\"label\":\"C\",\"variant\":\"libcurl\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Axios\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Native\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Request\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Unirest\"},{\"key\":\"objective-c\",\"label\":\"Objective-C\",\"variant\":\"NSURLSession\"},{\"key\":\"ocaml\",\"label\":\"OCaml\",\"variant\":\"Cohttp\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"cURL\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"Guzzle\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"HTTP_Request2\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"pecl_http\"},{\"key\":\"powershell\",\"label\":\"PowerShell\",\"variant\":\"RestMethod\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"http.client\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"Requests\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"httr\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"RCurl\"},{\"key\":\"ruby\",\"label\":\"Ruby\",\"variant\":\"Net::HTTP\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"Httpie\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"wget\"},{\"key\":\"swift\",\"label\":\"Swift\",\"variant\":\"URLSession\"}]","languageSettings":[{"key":"csharp","label":"C#","variant":"HttpClient"},{"key":"csharp","label":"C#","variant":"RestSharp"},{"key":"curl","label":"cURL","variant":"cURL"},{"key":"dart","label":"Dart","variant":"http"},{"key":"go","label":"Go","variant":"Native"},{"key":"http","label":"HTTP","variant":"HTTP"},{"key":"java","label":"Java","variant":"OkHttp"},{"key":"java","label":"Java","variant":"Unirest"},{"key":"javascript","label":"JavaScript","variant":"Fetch"},{"key":"javascript","label":"JavaScript","variant":"jQuery"},{"key":"javascript","label":"JavaScript","variant":"XHR"},{"key":"c","label":"C","variant":"libcurl"},{"key":"nodejs","label":"NodeJs","variant":"Axios"},{"key":"nodejs","label":"NodeJs","variant":"Native"},{"key":"nodejs","label":"NodeJs","variant":"Request"},{"key":"nodejs","label":"NodeJs","variant":"Unirest"},{"key":"objective-c","label":"Objective-C","variant":"NSURLSession"},{"key":"ocaml","label":"OCaml","variant":"Cohttp"},{"key":"php","label":"PHP","variant":"cURL"},{"key":"php","label":"PHP","variant":"Guzzle"},{"key":"php","label":"PHP","variant":"HTTP_Request2"},{"key":"php","label":"PHP","variant":"pecl_http"},{"key":"powershell","label":"PowerShell","variant":"RestMethod"},{"key":"python","label":"Python","variant":"http.client"},{"key":"python","label":"Python","variant":"Requests"},{"key":"r","label":"R","variant":"httr"},{"key":"r","label":"R","variant":"RCurl"},{"key":"ruby","label":"Ruby","variant":"Net::HTTP"},{"key":"shell","label":"Shell","variant":"Httpie"},{"key":"shell","label":"Shell","variant":"wget"},{"key":"swift","label":"Swift","variant":"URLSession"}],"languageOptions":[{"label":"C# - HttpClient","value":"csharp - HttpClient - C#"},{"label":"C# - RestSharp","value":"csharp - RestSharp - C#"},{"label":"cURL - cURL","value":"curl - cURL - cURL"},{"label":"Dart - http","value":"dart - http - Dart"},{"label":"Go - Native","value":"go - Native - Go"},{"label":"HTTP - HTTP","value":"http - HTTP - HTTP"},{"label":"Java - OkHttp","value":"java - OkHttp - Java"},{"label":"Java - Unirest","value":"java - Unirest - Java"},{"label":"JavaScript - Fetch","value":"javascript - Fetch - JavaScript"},{"label":"JavaScript - jQuery","value":"javascript - jQuery - JavaScript"},{"label":"JavaScript - XHR","value":"javascript - XHR - JavaScript"},{"label":"C - libcurl","value":"c - libcurl - C"},{"label":"NodeJs - Axios","value":"nodejs - Axios - NodeJs"},{"label":"NodeJs - Native","value":"nodejs - Native - NodeJs"},{"label":"NodeJs - Request","value":"nodejs - Request - NodeJs"},{"label":"NodeJs - Unirest","value":"nodejs - Unirest - NodeJs"},{"label":"Objective-C - NSURLSession","value":"objective-c - NSURLSession - Objective-C"},{"label":"OCaml - Cohttp","value":"ocaml - Cohttp - OCaml"},{"label":"PHP - cURL","value":"php - cURL - PHP"},{"label":"PHP - Guzzle","value":"php - Guzzle - PHP"},{"label":"PHP - HTTP_Request2","value":"php - HTTP_Request2 - PHP"},{"label":"PHP - pecl_http","value":"php - pecl_http - PHP"},{"label":"PowerShell - RestMethod","value":"powershell - RestMethod - PowerShell"},{"label":"Python - http.client","value":"python - http.client - Python"},{"label":"Python - Requests","value":"python - Requests - Python"},{"label":"R - httr","value":"r - httr - R"},{"label":"R - RCurl","value":"r - RCurl - R"},{"label":"Ruby - Net::HTTP","value":"ruby - Net::HTTP - Ruby"},{"label":"Shell - Httpie","value":"shell - Httpie - Shell"},{"label":"Shell - wget","value":"shell - wget - Shell"},{"label":"Swift - URLSession","value":"swift - URLSession - Swift"}],"layoutOptions":[{"value":"classic-single-column","label":"Single Column"},{"value":"classic-double-column","label":"Double Column"}],"versionOptions":[],"environmentOptions":[{"value":"0","label":"No Environment"},{"label":"Production (Documentation)","value":"10282439-b02a1d6c-15cb-4d32-bb51-c94c5bd63073"}],"canonicalUrl":"https://docs.clearplex.com/view/metadata/TVzYhEjF"}