{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"95aac19a-dce8-4de6-86e7-d1e9f74af8e7","name":"ClinOne API Reference (v5)","description":"## Contact Support\n\nName: ClinOne Support \nEmail: [support@clinone.com](https://mailto:support@clinone.com)\n\n# Getting Started\n\nTo get started with this Postman Collection, click the Run in Postman button. Download the ClinOne Collection to your local machine. Fork the collection and edit the environment variables with your Client Key and Secret. More information on how to generate your authentication variables below.\n\n\n\n## Authentication\n\nClinOne APIs require a bearer authentiation to access all APIs. In order to generate your JWT, you must do the following:\n\n1. Create and scope an External Client in ClinOne's API Management portal\n \n2. Take note of your client ID and secret\n \n3. Generate and refresh your token by calling a ClinOne endpoint\n \n\n### Create an External Client\n\nAs an administrator in ClinOne, naviagte to the organization for which you wish to access via API and execute the following steps:\n\n1. Select the API Management Tile\n \n2. Select the Authentication & Authorization Tile\n \n3. Add New External Client & complete the required fields\n \n 1. Associate your External Client with studies. If you select \"All Studies\" your External Client will have access all future studies.\n \n4. After you submit the External Client, create a secret\n \n 1. **Note**: Before performing this step, be sure you're ready to note your secret in a secure location. Once you close the popup, you will not be able to see the secret again. If you find yourself in this situation, delete the secret you created and generate a new secret when you're ready.\n \n5. Take note of your Client ID and Secret. You'll need this information when generating your JWT.\n \n\n## Generating a JWT\n\nTo generate or regenerate your JWT, you will send a `POST` request with the following information. For an example of how to do this, check out the pre-request script associated with the attached collection.\n\n### Endpoint\n\nTest Environments\n\n```\nPOST https://clinoneb2cqa.b2clogin.com/clinoneb2cqa.onmicrosoft.com/b2c_1_signin_signup/oauth2/v2.0/token\n\n ```\n\n### Body\n\nTest Envrionments\n\n```\n{\n 'grant_type': 'client_credentials',\n 'client_id': 'your_client_id',\n 'client_secret': 'your_client_secret',\n 'scope': 'https://clinoneb2cqa.onmicrosoft.com/clinoneapi/.default'\n}\n\n ```\n\n## Scopes\n\nOur API scopes will always have 3 parts:\n\n- api - to designate API scope\n \n- \\- this indicates a group of functionality (e.g. patient)\n \n- \\- what actions are you able to perform for the above service. We will support the following actions.\n \n - **read**: access to all **GET** routes\n \n - **write**: access to all **GET**, **PUT**, **POST** routes\n \n - **delete**: access to **GET** and **DELETE** routes\n \n - **manage**: access to all routes (**GET**, **PUT**, **POST** and **DELETE**)\n \n\nContact your ClinOne representative to assign the correct scopes to your External Clients and mention CO-1619 and CO-1150.\n\n# Mapping of External Values\n\nIn ClinOne, you can add an external alias to your study and site with attributes. These external values can then be used in your API transactions.\n\n## How to Enable Attributes\n\nAttributes are a way to add external aliases to objects within the ClinOne system. Specifically in our use case, they allow us to add the **studyIdentifier** and **siteIdentifier** above.\n\nIf any of your studies have integrations, you can enable attributes at the Org level through our ClinOne portal by completing the following steps:\n\n1. Select your **Org**\n \n2. Select the **Attributes** tile\n \n3. Click the **Add an Attribute** button\n \n4. Add the **Study Identifier** and the **Study Site Identifier** attributes. You can give them any name you find most descriptive. The **Attribute** **Name** field will appear in the ClinOne application when configuring sites and studies.\n \n\n## How to Add an Attibute to a Study\n\nNow you'll provide an alias for your study. This is the value sent in the **studyIdentifier** field on the API.\n\n1. In ClinOne, select your **Study**\n \n2. Click the **Attributes** tile\n \n3. Add your **Study Attribute Name** value; this is the identifier you will send in the **studyIdentifier** field in the API\n \n\n\n\n## How to Add an Attibute to a Site\n\nNow you'll provide an alias for your study. This is the value sent in the **siteIdentifier** field on the API.\n\n1. In ClinOne, select your **Study**\n \n2. Select the **Manage Sites** tile\n \n3. Choose a site\n \n4. Click the **Attributes** tile\n \n5. Add your **Site Attribute Name** value; this is the identifier you will send in the **siteIdentifier** field in the API\n \n\n> Tip: if you are importing sites, you can also import your Site Identifier attribute. \n \n\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"22121128","collectionId":"95aac19a-dce8-4de6-86e7-d1e9f74af8e7","publishedId":"2s8YzRyNKH","public":true,"publicUrl":"https://developer.clinone.com","privateUrl":"https://go.postman.co/documentation/22121128-95aac19a-dce8-4de6-86e7-d1e9f74af8e7","customColor":{"top-bar":"163656","right-sidebar":"163656","highlight":"79C2C4"},"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":"163656","right-sidebar":"163656","highlight":"79C2C4"}}]}},"version":"8.10.1","publishDate":"2023-08-09T19:26:47.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"","description":""},"logos":{"logoLight":null,"logoDark":null}},"statusCode":200},"environments":[{"name":"zzzTest1 (DEMO)","id":"a5880425-0a17-4a01-af34-ccebc68c6099","owner":"22121128","values":[{"key":"hmacAuthHeader","value":"","enabled":true,"type":"secret"},{"key":"hmac_CLIENT_KEY","value":"","enabled":true,"type":"secret"},{"key":"hmac_SECRET_KEY","value":"","enabled":true,"type":"secret"},{"key":"baseUrl","value":"https://test1api.clinone.com","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/768118b36f06c94b0306958b980558e6915839447e859fe16906e29d683976f0","favicon":"https://clinone.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":"zzzTest1 (DEMO)","value":"22121128-a5880425-0a17-4a01-af34-ccebc68c6099"}],"canonicalUrl":"https://developer.clinone.com/view/metadata/2s8YzRyNKH"}