{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"4dcc66fa-8f35-4bf5-bb04-e0eae4b3d0d7","name":"Ed Controls APIs","description":"This is API collection for the Ed Controls application. Please contact Ed Controls development team, if you have any questions or need more information.\n\n**Description Of Usual** **Server Responses**_**:**_\n\n- 200 OK - the request was successful (some API calls may return 201 instead).\n    \n- 201 Created - the request was successful and a resource was created.\n    \n- 204 No Content - the request was successful but there is no representation to return (i.e. the response is empty)\n    \n- 400 Bad Request - The request could not be understood or was missing the required parameters.\n    \n- 401 Unauthorized - authentication failed or the user doesn't have permissions for the requested operation.\n    \n- 403 Forbidden - access denied.\n    \n- 404 Not Found - resource was not found.\n    \n- 405 Method Not Allowed - requested method is not supported for the resource.\n    \n\n# Auth\n\nIn order to make a request to any service of EDControls you need an authorization token. The token can be obtained using a standard oAuth2 workflow.\n\nThere are several support grant types, for most integrators the password grant type is the most useful integration.\n\nFor the password grant type you need:\n\n- a clientId and clientSecret which can be obtained by sending an email to [support@edcontrols.com](https://mailto:support@edcontrols.com).\n    \n- A valid username & password for ED Controls and a contract with ED Controls that has API level access.\n    \n\nTo convert the provided `cURL` request into a format suitable for Postman, you can follow these steps. This guide includes setting up the request and handling variables for `url`, `client_id`, `client_secret`, `emailAddress`, and `password`.\n\n### Step 1: Create a New Request in Postman\n\n1. Open Postman and create a new request by selecting **New** > **HTTP Request**.\n    \n2. Set the request type to **POST**.\n    \n3. In the URL field, enter: `https://{{url}}/api/v1/oauth/token`.\n    \n\n### Step 2: Set Up the Headers\n\n1. Go to the **Headers** tab.\n    \n2. Add the header:\n    \n    - **Key**: `Content-Type`\n        \n    - **Value**: `application/x-www-form-urlencoded`\n        \n\n### Step 3: Configure Body Parameters\n\n1. Select the **Body** tab.\n    \n2. Choose the **x-www-form-urlencoded** option.\n    \n3. Add the following parameters as **key-value pairs**:\n    \n    - **grant_type**: `password`\n        \n    - **client_id**: `{{client_id}}`\n        \n    - **client_secret**: `{{client_secret}}`\n        \n    - **scope**: `read write`\n        \n    - **username**: `{{emailAddress}}`\n        \n    - **password**: `{{password}}`\n        \n\n### Step 4: Set Up Variables (Optional but Recommended)\n\nTo manage values for `{{url}}`, `{{client_id}}`, `{{client_secret}}`, `{{emailAddress}}`, and `{{password}}`:\n\n1. In Postman, go to **Environment** (gear icon in the upper right).\n    \n2. Select **Manage Environments** and create a new environment.\n    \n3. Define the following variables with their corresponding values:\n    \n    - `url`\n        \n    - `client_id`\n        \n    - `client_secret`\n        \n    - `emailAddress`\n        \n    - `password`\n        \n4. Save the **environment** and select it before sending the request.\n    \n\n### Step 5: Send the Request\n\n1. Double-check all fields are correctly filled.\n    \n2. Click **Send** to make the request.\n    \n\n### Example Environment Setup\n\nIn your environment, the variables should look something like this:\n\n| Variable | Initial Value |\n| --- | --- |\n| url | `api.example.com` |\n| client_id | `your_client_id` |\n| client_secret | `your_client_secret` |\n| emailAddress | `user@example.com` |\n| password | `your_password` |\n\nAfter configuring, Postman will handle variable substitution.","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"12153664","team":1183736,"collectionId":"4dcc66fa-8f35-4bf5-bb04-e0eae4b3d0d7","publishedId":"TVes8SsA","public":true,"publicUrl":"https://apidocs.edcontrols.com","privateUrl":"https://go.postman.co/documentation/12153664-4dcc66fa-8f35-4bf5-bb04-e0eae4b3d0d7","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"documentationLayout":"classic-double-column","customisation":{"metaTags":[{"name":"description","value":""},{"name":"title","value":""}],"appearance":{"default":"light","themes":[{"name":"dark","logo":null,"colors":{"top-bar":"212121","right-sidebar":"303030","highlight":"FF6C37"}},{"name":"light","logo":null,"colors":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"}}]}},"version":"8.10.1","publishDate":"2024-10-17T06:43:50.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"","description":""},"logos":{"logoLight":null,"logoDark":null}},"statusCode":200},"environments":[{"name":"Ed Controls - Do not modify","id":"765a8eeb-6665-47f2-ad6a-f2ebcf425825","owner":"12153664","values":[{"key":"url","value":"web.edcontrols.com","enabled":true,"type":"default"},{"key":"fileUrl","value":"<fileUrl>","enabled":true,"type":"default"},{"key":"fileName","value":"<fileName>","enabled":true,"type":"default"},{"key":"projectDatabaseName","value":"projectDbName","enabled":true,"type":"default"},{"key":"projectDocId","value":"<projectDocId>","enabled":true,"type":"default"},{"key":"fileDocumentId","value":"<fileDocumentId>","enabled":true,"type":"default"},{"key":"mapDocumentId","value":"<mapDocId>","enabled":true,"type":"default"},{"key":"groupId_library_module","value":"<groupId>","enabled":true,"type":"default"},{"key":"fileDocumentId_Library_module","value":"<fileDocId>","enabled":true,"type":"default"},{"key":"groupId_Library_module","value":"<groupId>","enabled":true,"type":"default"},{"key":"fromDate_Library_module","value":"<fromDate>","enabled":true,"type":"default"},{"key":"untilDate_Library_module","value":"<untilDate>","enabled":true,"type":"default"},{"key":"sortBy_Library_module","value":"<sortBy>","enabled":true,"type":"default"},{"key":"sortOrder_LIbrary_module","value":"<sortOrder>","enabled":true,"type":"default"},{"key":"tags_Library_module","value":"<tags>","enabled":true,"type":"default"},{"key":"uploadedBy_Library_module","value":"<uploadedBy>","enabled":true,"type":"default"},{"key":"searchByName_File_name_Library_module","value":"<searchByName>","enabled":true,"type":"default"},{"key":"archivedBooleanValue","value":"<true or false>","enabled":true,"type":"default"},{"key":"randomString_Library_module","value":"<server-generated-random-string>","enabled":true,"type":"default"},{"key":"auditDoucumentId","value":"","enabled":true,"type":"default"},{"key":"auditDocumentId","value":"","enabled":true,"type":"default"},{"key":"client_id","value":"","enabled":true,"type":"default"},{"key":"client_secret","value":"","enabled":true,"type":"default"},{"key":"username","value":"","enabled":true,"type":"default"},{"key":"password","value":"","enabled":true,"type":"default"},{"key":"loginEmailAddress","value":"","enabled":true,"type":"default"},{"key":"emailAddress","value":"","enabled":true,"type":"default"},{"key":"contractId","value":"","enabled":true,"type":"default"},{"key":"projectName","value":"","enabled":true,"type":"default"},{"key":"filterRole","value":"","enabled":true,"type":"default"},{"key":"roleMailAddress","value":"","enabled":true,"type":"default"},{"key":"sortby","value":"","enabled":true,"type":"default"},{"key":"sortBy","value":"","enabled":true,"type":"default"},{"key":"groupId","value":"","enabled":true,"type":"default"},{"key":"mapId","value":"","enabled":true,"type":"default"},{"key":"sortOrder","value":"","enabled":true,"type":"default"},{"key":"auditId","value":"","enabled":true,"type":"default"},{"key":"ticketId","value":"","enabled":true,"type":"default"},{"key":"fromDate","value":"","enabled":true,"type":"default"},{"key":"untilDate","value":"","enabled":true,"type":"default"},{"key":"statusOfTicket","value":"","enabled":true,"type":"default"},{"key":"searchByResponsible","value":"<searchByResponsible>","enabled":true,"type":"default"},{"key":"searchByTitleOfTicket","value":"","enabled":true,"type":"default"},{"key":"searchByDescription","value":"","enabled":true,"type":"default"},{"key":"tag","value":"","enabled":true,"type":"default"},{"key":"searchByTagName","value":"","enabled":true,"type":"default"},{"key":"groupIdTemplate","value":"","enabled":true,"type":"default"},{"key":"responsibleTemplate","value":"","enabled":true,"type":"default"},{"key":"searchByNameTemplate","value":"","enabled":true,"type":"default"},{"key":"filterByRoleTemplate","value":"","enabled":true,"type":"default"},{"key":"roleMailAddressTemplate","value":"","enabled":true,"type":"default"},{"key":"rangeFilterTemplate","value":"","enabled":true,"type":"default"},{"key":"templateDocumentId","value":"","enabled":true,"type":"default"},{"key":"templateGroupId","value":"","enabled":true,"type":"default"},{"key":"auditStatus","value":"","enabled":true,"type":"default"},{"key":"searchByAuditResponsible","value":"","enabled":true,"type":"default"},{"key":"searchByAuditTitle","value":"","enabled":true,"type":"default"},{"key":"ticketDocumentId","value":"","enabled":true,"type":"default"},{"key":"groupIdLibrary","value":"","enabled":true,"type":"default"},{"key":"tagsLibrary","value":"","enabled":true,"type":"default"},{"key":"tagLibrary","value":"","enabled":true,"type":"default"},{"key":"fileDocumentIdLibrary","value":"","enabled":true,"type":"default"},{"key":"uploadedByLibrary","value":"","enabled":true,"type":"default"},{"key":"searchByFilename","value":"","enabled":true,"type":"default"},{"key":"numberOfItems","value":"","enabled":true,"type":"default"},{"key":"searchByNameLibrary","value":"","enabled":true,"type":"default"},{"key":"reporterId","value":"","enabled":true,"type":"default"},{"key":"mapName","value":"","enabled":true,"type":"default"},{"key":"contractDocumentId","value":"","enabled":true,"type":"default"},{"key":"timeOfPrint","value":"","enabled":true,"type":"default"},{"key":"reportFileName","value":"","enabled":true,"type":"default"},{"key":"channelId","value":"","enabled":true,"type":"default"},{"key":"counter","value":"","enabled":true,"type":"default"}],"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/3d5bddc44fa043d32d41b812a312467e0baae333d9eb91f18b84f4ac50218c57","favicon":"https://edcontrols.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":"Ed Controls - Do not modify","value":"12153664-765a8eeb-6665-47f2-ad6a-f2ebcf425825"}],"canonicalUrl":"https://apidocs.edcontrols.com/view/metadata/TVes8SsA"}