{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"b3eaceee-cb82-4cc0-8855-0b7778025eb0","name":"CareWait Enrollment Service","description":"# MCT CareCloud API\nThe API provides a standardized way to quickly and easily access your data needs for a CareCloud license holder.\n\nBefore you can obtain access to CareCloud API, you must register the developer's account. You will then obtain a **API Key**. API key is alphanumeric strings that MCT distribute to app developer customers to grant access to CareCloud API. And then you will obtain a corresponding **AppID and AppSecret** , which are used to obtain Access Token.\n\n# Authentication\n\nAll API requests must contain your API Key and Access Token. This string should be sent as a part of the `Authorization` header demonstrated below.\n\n```\nx-api-key: [api_key]\nAuthorization: Bearer [access_token]\n```\nFor example, \n\n```\nx-api-key: herTyem38gM\nAuthorization: Bearer JmFhAAMPkUOJuJ2F2CQq\n```\n\n## Description of the Authorization Process\nThe CareCloud OAuth2.0 Authorized Login allows CareCloud users to authorize the third-party applications or websites to access the user's data.\n\nThe third party sends a CareCloud Authorized Login request. After a user allows the authorization of a third-party application, CareCloud can pull up the application or redirect to the third-party website while bringing with it the authorized temporary ticket code parameter.\n\nThe code parameter along with the AppID and AppSecret, etc. are exchanged for the access_token using the API;\n\nThe access_token is used to call the CareCloud interface and retrieve the user's basic data and resources or to help the user perform basic operations.\n\n## Step one: Request CODE\nThe following link can be opened on a PC:\n\n```\n{{Connect_Host}}/oauth2/login?AppId=APPID&RedirectUri=REDIRECT_URI&ResponseType=code&State=STATE\n```\n\n| Parameters | Required | Description |\n| ------ | ------ | ----- |\n| AppId | Yes | Unique identifier for application |\n| RedirectUri | Yes |  Please urlEncode use to adjust the link |\n| ResponseType | Yes | Fixed 'code' |\n| State | No | After the authorized request is made, the originals should be given back to the third party if they are being used to preserve the request and callback status. This parameter can be used to stop CSRF (Cross-Site Request Forgery) attacks. It is recommended that the third party bring this parameter; it can be set to a simple random number, which is added to the session and used for verification. |\n\n### Return descriptions\nAfter providing authorization, the user will be redirected to the redirect_uri web address, and the code and state perimeters will be brought with them.\n```\nREDIRECT_URI?code=CODE&state=STATE\n```\n\nIf the user denies authorization, then after being redirected, the code parameters will not be brought with them; only the state parameters will be taken.\n```\nREDIRECT_URI?state=STATE\n```\n\n## Step Two: The code is used to obtain the long term access_token\nThe code is used to obtain the access_token. The 'access token' is the call certificate of the interface related to the call authorization. \n\n```\n{{Carewait_API_Host}}/oauth2/access_token?AppId=APPID&Secret=SECRET&Code=CODE&GrantType=authorization_code\n```\nIf the access_token has expired, you will retrieve a new Access token and a new extended time period;\n\n# General\n\n## HTTP Verbs\n\nWhen interacting with the API, you will need to make use of the appropriate HTTP verb for the action you are trying to complete.\n\n| Verb   | Usage                         |\n|--------|-------------------------------|\n| GET    | Used for retrieving resources |\n| POST   | Used for creating resources   |\n| PUT    | Used for updating resources   |\n| DELETE | Used for deleting resources   |\n\n## HTTP Status Codes\n\nEvery API response will include an HTTP status, which can be used to quickly determine the result of your request.\n\n| Code  | Description   |\n|-------|---------------|\n| 1xx   | Informational |\n| 2xx   | Success       |\n| 3xx   | Redirection   |\n| 4xx   | Client error  |\n| 5xx   | Server error  |\n\n## Paging\n\nWhen performing a search request, the API always return as paginated list with a default size of 100. This is to ensure speed, performance, and consistency in large responses. All paginated lists will have a default size of 100 resources, but can be further customized to meet your needs.\n\n### Request parameters\n\n| Path  | Type    | Description |\n|-------|---------|-----------------------------------------------------------------|\n| CurrentPage  | Integer | Page you want to retrieve, 1 indexed and defaults to 1          |\n| PageSize  | Integer | Size of the page you want to retrieve, defaults to 100           |\n\n\n### Paginated response fields\n\nSearch endpoints will return a standard paginated structure to quickly deliver key information about your search results.\n\n| Path | Type | Optional | Description          |\n|------|------|----------|----------------------|\n| Data       | Object Array | false | Resources found    |\n| IsSuccess | boolean| false | True if no error |\n| ErrCode | string | false | API error code, default is 200 |\n| ErrMsg | string |  true | The message if existing any error |\n| Page.TotalRecords | Integer | false | Total count of resource |\n| Page.TotalPageNumber    | Integer | false | Total pages with current page size |\n| Page.PageSize | Integer | false | Requested size of the page |\n| Page.CurrentPage | Integer | false | Page number |\n\n```json\n{\n    \"Pager\": {\n        \"currentPage\": 1,\n        \"pageSize\": 100,\n        \"totalRecords\": 1,\n        \"totalPageNumber\": 1\n    },\n    \"Data\": [],\n    \"IsSuccess\": true,\n    \"ErrCode\": 200,\n    \"ErrMsg\": \"\"\n}\n```\n\n## Errors\n\nAny request that results in an error will return with a general error object containing debugging information in the following format.\n\n```json\n{\n  \"IsSuccess\": false,\n  \"ErrCode\": \"500\",\n  \"ErrMsg\": \" parameter is Required\",\n}\n```","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"6575661","team":265046,"collectionId":"b3eaceee-cb82-4cc0-8855-0b7778025eb0","publishedId":"RztoM8Tx","public":true,"publicUrl":"https://staging-carewait-apidocs.mcttechnology.com","privateUrl":"https://go.postman.co/documentation/6575661-b3eaceee-cb82-4cc0-8855-0b7778025eb0","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"documentationLayout":"classic-double-column","customisation":null,"version":"8.10.0","publishDate":"2022-04-19T17:14:07.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{},"logos":{}},"statusCode":200},"environments":[],"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/437e8c18994b3c88ab5bee8e5d4c083a090e0ed7fba6e2f95dd9996d95e180e9","favicon":"https://mcttechnology.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"}],"canonicalUrl":"https://staging-carewait-apidocs.mcttechnology.com/view/metadata/RztoM8Tx"}