{"type":"doc","content":[{"type":"heading","attrs":{"level":1},"content":[{"text":"Overview","type":"text"}]},{"type":"paragraph","content":[{"text":"Use these use-cases (with curl language examples) as a guide for your app development.","type":"text"}]},{"type":"paragraph","content":[{"text":"Notes:","type":"text","marks":[{"type":"textColor","attrs":{"color":"#ff5630"}},{"type":"em"}]}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Currently Sonde doesn’t support any measure with questionnaire, please contact Sonde at ","type":"text","marks":[{"type":"textColor","attrs":{"color":"#ff5630"}},{"type":"em"}]},{"text":"support@sondehealth.com","type":"text","marks":[{"type":"em"},{"type":"link","attrs":{"href":"mailto:support@sondehealth.com"}}]},{"text":". Please provide your company name and address in support ticket.","type":"text","marks":[{"type":"textColor","attrs":{"color":"#ff5630"}},{"type":"em"}]}]}]}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"API Credentials","type":"text"}]},{"type":"paragraph","content":[{"text":"For all use-cases, you should have the following information (the following values are examples only):","type":"text"}]},{"type":"paragraph","content":[{"text":"Refer ","type":"text"},{"type":"inlineCard","attrs":{"__confluenceMetadata":{"isRenamedTitle":true,"linkType":"page","contentTitle":"Account","versionAtSave":"27"},"url":"https://sondehealth.atlassian.net/wiki/spaces/SA/pages/2702999553"}},{"text":" for detail on how to create an account with Sonde and obtained below client-id & client-secret.","type":"text"}]},{"type":"paragraph","content":[{"text":"client-id: ","type":"text","marks":[{"type":"strong"},{"type":"em"}]},{"text":"6lpo5bolnp4uda4n2is3u8tt2","type":"text","marks":[{"type":"em"}]}]},{"type":"paragraph","content":[{"text":"client-secret:","type":"text","marks":[{"type":"strong"},{"type":"em"}]},{"text":" 1114assc3pnln1b2lngjjml6mkce3uw0q70mrv9pqphusfbgtq9a","type":"text","marks":[{"type":"em"}]}]},{"type":"paragraph","content":[{"text":"domain: ","type":"text","marks":[{"type":"strong"}]},{"text":"api.sondeservices.com","type":"text","marks":[{"type":"strong"},{"type":"link","attrs":{"href":"http://api.sondeservices.com"}}]}]},{"type":"paragraph","content":[{"text":"The Sonde Service API uses an access-token to authenticate requests. Generate a access-token using ","type":"text"},{"text":"‘client-credential’ ","type":"text","marks":[{"type":"strong"}]},{"text":"(consists of “client-id” and “client-secret”).","type":"text"}]},{"type":"paragraph","content":[{"text":"Your '","type":"text","marks":[{"type":"strong"}]},{"text":"client-credential","type":"text","marks":[{"type":"strong"},{"type":"em"}]},{"text":"' must be kept secure on your server (or preferably in secret storage at server side","type":"text","marks":[{"type":"strong"}]},{"text":"). Do not share your ","type":"text"},{"text":"client-credential","type":"text","marks":[{"type":"strong"}]},{"text":" in publicly accessible areas (such as GitHub, client-side code, and so forth).","type":"text"}]},{"type":"paragraph","content":[{"text":"Obtain the access-token by following the steps below.","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"API call","type":"text"}]},{"type":"codeBlock","marks":[{"type":"breakout","attrs":{"mode":"wide"}}],"content":[{"text":"$ curl --request POST 'https://api.sondeservices.com/platform/v1/oauth2/token' \\\n--header 'Authorization: Basic ' \\\n--header 'Content-Type: application/x-www-form-urlencoded' \\\n--data-urlencode 'grant_type=client_credentials' \\\n--data-urlencode 'scope=sonde-platform/users.write sonde-platform/scores.write sonde-platform/storage.write'\n\n","type":"text"}]},{"type":"paragraph","content":[{"text":"Get ","type":"text"},{"text":"","type":"text","marks":[{"type":"code"}]},{"text":" using the below command","type":"text"}]},{"type":"codeBlock","content":[{"text":"$ echo -n \":\" | openssl base64 -A","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"API response","type":"text"}]},{"type":"codeBlock","content":[{"text":"{\n \"access_token\": \"ya29.QQIBibTwvKkE39hY8mdkT_mXZoRh7Ub9cK9hNsqrxem4QJ6sQa36VHfyuBe\",\n \"expire_in\": 3600,\n \"token_type\": \"Bearer\"\n}\n\n\n","type":"text"}]},{"type":"paragraph","content":[{"text":"Pass the “","type":"text"},{"text":"access_token","type":"text","marks":[{"type":"strong"}]},{"text":"” key value in the Authorization header of Sonde Service APIs.","type":"text"}]},{"type":"paragraph","content":[{"text":"The ","type":"text"},{"text":"access_token","type":"text","marks":[{"type":"code"}]},{"text":" will ","type":"text"},{"text":"expire_in","type":"text","marks":[{"type":"code"}]},{"text":" 3600 seconds.","type":"text"}]},{"type":"paragraph","content":[{"text":"The ","type":"text"},{"text":"token_type","type":"text","marks":[{"type":"code"}]},{"text":" is “Bearer” (this value is fixed).","type":"text"}]},{"type":"paragraph","content":[{"text":"For a list of supported scopes, please check the schema in the ","type":"text"},{"text":"Authentication ","type":"text","marks":[{"type":"strong"}]},{"text":"section of the API Documentation ","type":"text"},{"text":"REST API Reference","type":"text","marks":[{"type":"link","attrs":{"__confluenceMetadata":{"isRenamedTitle":true,"linkType":"page","contentTitle":"REST API Reference","versionAtSave":"19"},"href":"/wiki/spaces/SA/pages/2689105939"}}]},{"text":".","type":"text"}]},{"type":"paragraph","content":[{"text":"For a list of scopes required for Scoring refer to ","type":"text"},{"type":"inlineCard","attrs":{"__confluenceMetadata":{"isRenamedTitle":true,"linkType":"page","contentTitle":"Authentication Scopes","versionAtSave":"6"},"url":"https://sondehealth.atlassian.net/wiki/spaces/SA/pages/2706931713"}}]},{"type":"paragraph","content":[{"text":"Using the generated ","type":"text"},{"text":"access-token","type":"text","marks":[{"type":"strong"}]},{"text":", you can access Sonde Platform’s Services.","type":"text"}]},{"type":"paragraph","content":[{"text":"Example; if you want your device to upload a voice sample to the Sonde Platform using Storage Service, then you can share an ","type":"text"},{"text":"access-token","type":"text","marks":[{"type":"strong"}]},{"text":" with the device having scope ","type":"text"},{"text":"sonde-platform/storage.write","type":"text","marks":[{"type":"code"}]},{"text":" to restrict the access and prevent the misuse of privileges your client-credential is carrying.","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"As a developer, I want to generate a score for Health Check “XYZ”.","type":"text"}]},{"type":"paragraph","content":[{"text":"Score an “XYZ” health condition with the Sonde Platform “","type":"text"},{"text":"XYZ","type":"text","marks":[{"type":"strong"}]},{"text":"” measure.","type":"text"}]},{"type":"paragraph","content":[{"text":"On your backend perform the below steps to get the score:","type":"text"}]},{"type":"paragraph","content":[{"text":"STEP 1:","type":"text","marks":[{"type":"strong"}]},{"text":" GET THE APPROPRIATE ACCESS-TOKEN","type":"text"},{"type":"hardBreak"},{"text":"STEP 2:","type":"text","marks":[{"type":"strong"}]},{"text":" REGISTER A USER WITH SONDE HEALTH","type":"text"},{"type":"hardBreak"},{"text":"STEP 3:","type":"text","marks":[{"type":"strong"}]},{"text":" GET THE S3 SIGNED URL TO UPLOAD YOUR AUDIO FILE","type":"text"},{"type":"hardBreak"},{"text":"STEP 4:","type":"text","marks":[{"type":"strong"}]},{"text":" UPLOAD YOUR AUDIO FILE","type":"text"},{"type":"hardBreak"},{"text":"STEP 5:","type":"text","marks":[{"type":"strong"}]},{"text":" LOOK FOR QUESTIONNAIRE REQUIRED FOR MEASURE","type":"text"},{"type":"hardBreak"},{"text":"STEP 6: ","type":"text","marks":[{"type":"strong"}]},{"text":"GET QUESTIONNAIRE FOR THE MEASURE ","type":"text"},{"type":"hardBreak"},{"text":"STEP 7: ","type":"text","marks":[{"type":"strong"}]},{"text":"SUBMIT QUESTIONNAIRE RESPONSE TO SERVER","type":"text"},{"type":"hardBreak"},{"text":"STEP 8:","type":"text","marks":[{"type":"strong"}]},{"text":" ASK FOR THE EXPECTED MEASURE SCORE","type":"text"}]},{"type":"paragraph","content":[{"text":"Detailed explanation with curl examples of each step is given below.","type":"text"}]},{"type":"paragraph","content":[{"text":"STEP 1: GET THE APPROPRIATE ACCESS-TOKEN","type":"text","marks":[{"type":"strong"}]}]},{"type":"paragraph","content":[{"text":"Get the access-token with ","type":"text"},{"text":"scopes","type":"text","marks":[{"type":"link","attrs":{"href":"https://sondehealth.atlassian.net/wiki/spaces/SA/pages/1031864364/Authentication+Scopes"}}]},{"text":" ","type":"text"},{"text":"sonde-platform/scores.write","type":"text","marks":[{"type":"code"}]},{"text":" , ","type":"text"},{"text":"sonde-platform/users.write","type":"text","marks":[{"type":"code"}]},{"text":", ","type":"text"},{"text":"sonde-platform/questionnaires.read","type":"text","marks":[{"type":"code"}]},{"text":", ","type":"text"},{"text":"sonde-platform/questionnaire-responses.write","type":"text","marks":[{"type":"code"}]},{"text":" and ","type":"text"},{"text":"sonde-platform/storage.write","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]},{"type":"paragraph","content":[{"text":"Ensure your client-credentials are granted to these scopes during the registration/onboarding process with Sonde Health.","type":"text"}]},{"type":"codeBlock","content":[{"text":"$ curl --request POST 'https://api.sondeservices.com/platform/v1/oauth2/token' \\\n--header 'Authorization: Basic ' \\\n--header 'Content-Type: application/x-www-form-urlencoded' \\\n--data-urlencode 'grant_type=client_credentials' \\\n--data-urlencode 'scope=sonde-platform/users.write sonde-platform/scores.write sonde-platform/storage.write sonde-platform/questionnaires.read sonde-platform/questionnaire-responses.write'\n","type":"text"}]},{"type":"paragraph","content":[{"text":" ","type":"text"}]},{"type":"paragraph","content":[{"text":"Response 1","type":"text","marks":[{"type":"em"}]},{"text":":","type":"text"}]},{"type":"codeBlock","content":[{"text":"{\n \"access_token\": \"ya29.QQIBibTwvKkE39hY8mdkT_mXZoRh7Ub9cK9hNsqrxem4QJ6sQa36VHfyuBe\",\n \"expire_in\": 3600,\n \"token_type\": \"Bearer\"\n}\n","type":"text"}]},{"type":"paragraph","content":[{"text":" ","type":"text"}]},{"type":"paragraph","content":[{"text":"STEP 2: REGISTER A USER WITH SONDE HEALTH","type":"text","marks":[{"type":"strong"}]}]},{"type":"paragraph","content":[{"text":"Use ","type":"text"},{"text":"\"access_token\"","type":"text","marks":[{"type":"code"}]},{"text":" to register a ","type":"text"},{"text":"user","type":"text","marks":[{"type":"link","attrs":{"__confluenceMetadata":{"isRenamedTitle":true,"linkType":"page","contentTitle":"Glossary","versionAtSave":"9"},"href":"/wiki/spaces/SA/pages/2706341889"}}]},{"text":". Put the value of ","type":"text"},{"text":"access_token","type":"text","marks":[{"type":"code"}]},{"text":" into the ","type":"text"},{"text":"Authorization","type":"text","marks":[{"type":"code"}]},{"text":" header (refer to the below curl command).","type":"text"}]},{"type":"paragraph","content":[{"text":"It is expected that your server will register the user with SondePlatform during user sign-up process.","type":"text"}]},{"type":"codeBlock","content":[{"text":"$ curl --request POST 'https://api.sondeservices.com/platform/v2/users' \\\n--header 'Authorization: ' \\\n--header 'Content-Type: application/json' \\\n--data-raw '{\n \"yearOfBirth\": \"1985\",\n \"gender\": \"Female\",\n \"language\": \"HINDI\",\n \"device\": {\n \"type\": \"MOBILE\",\n \"manufacturer\": \"VIVO\"\n }\n}'\n","type":"text"}]},{"type":"paragraph","content":[{"text":" ","type":"text"}]},{"type":"paragraph","content":[{"text":"Response 2","type":"text","marks":[{"type":"em"}]},{"text":":","type":"text"}]},{"type":"paragraph","content":[{"text":"Capture the ","type":"text"},{"text":"userIdentifier","type":"text","marks":[{"type":"code"}]},{"text":", in the below response ","type":"text"},{"text":"wiNODNXcm","type":"text","marks":[{"type":"code"}]},{"text":". This ","type":"text"},{"text":"userIdentifier","type":"text","marks":[{"type":"code"}]},{"text":" will be required while calling the ","type":"text"},{"text":"/inference/score","type":"text","marks":[{"type":"code"}]},{"text":" API in following steps.","type":"text"}]},{"type":"codeBlock","content":[{"text":"{\n \"requestId\": \"23454556\"\n \"userIdentifier\": \"wiNODNXcm\"\n}\n\n","type":"text"}]},{"type":"paragraph","content":[{"text":"Keep ","type":"text"},{"text":"userIdentifier","type":"text","marks":[{"type":"code"}]},{"text":" in your UserManagement module (or database) to later use it for same patient.","type":"text"},{"type":"hardBreak"},{"text":"userIdentifier","type":"text","marks":[{"type":"code"}]},{"text":" will be used in STEP 3 .","type":"text"}]},{"type":"paragraph","content":[{"text":"STEP 3: GET THE S3 SIGNED URL TO UPLOAD YOUR AUDIO FILE","type":"text","marks":[{"type":"strong"}]}]},{"type":"paragraph","content":[{"text":"Call Storage Service to get the signed URL. In the Authorization header put the value of the access_token attribute from ","type":"text"},{"text":"Response 1 ","type":"text","marks":[{"type":"strong"}]},{"text":"and the country-code in which you want to upload the wave file. (For supported country codes please check the ","type":"text"},{"text":"REST API Reference","type":"text","marks":[{"type":"link","attrs":{"__confluenceMetadata":{"isRenamedTitle":true,"linkType":"page","contentTitle":"REST API Reference","versionAtSave":"19"},"href":"/wiki/spaces/SA/pages/2689105939"}}]},{"text":").","type":"text"}]},{"type":"paragraph","content":[{"text":"For better measure accuracy it is recommended to upload the audio file which has the elicitation mentioned on page ","type":"text"},{"type":"inlineCard","attrs":{"__confluenceMetadata":{"isRenamedTitle":true,"linkType":"page","contentTitle":"Vocal Biomarkers - Health Checks","versionAtSave":"2"},"url":"https://sondehealth.atlassian.net/wiki/spaces/SA/pages/2706702353"}},{"text":" .","type":"text"}]},{"type":"paragraph","content":[{"text":"countryCode","type":"text","marks":[{"type":"code"}]},{"text":" should be the country information which you have used while creating the account with Sonde Health.","type":"text"}]},{"type":"codeBlock","content":[{"text":"$ curl --request POST 'https://api.sondeservices.com/platform/v1/storage/files' \\\n--header 'Authorization: ' \\\n--header 'Content-Type: application/json' \\\n--data-raw '{\n \"fileType\": \"wav\",\n \"countryCode\": \"US\",\n \"userIdentifier\": \"\"\n}'\n","type":"text"}]},{"type":"paragraph","content":[{"text":" ","type":"text"}]},{"type":"paragraph","content":[{"text":"Response 3","type":"text","marks":[{"type":"em"}]},{"text":":","type":"text"}]},{"type":"paragraph","content":[{"text":"The response is shown for illustration purposes.","type":"text"}]},{"type":"codeBlock","content":[{"text":"{\n \"requestId\": \"2345234\"\n \"signedURL\": \"https://s3.aws.sondesamle.bucket/234234232ce4f21d-751a-4eb3-a5c3-9061bb2e90b342323\",\n \"filePath\": \"https://s3.aws.sondesamle.bucket/2342342342323\"\n}\n","type":"text"}]},{"type":"paragraph","content":[{"text":"The ","type":"text"},{"text":"signedURL","type":"text","marks":[{"type":"code"}]},{"text":" is required in STEP 4.","type":"text"}]},{"type":"paragraph","content":[{"text":"The ","type":"text"},{"text":"filePath","type":"text","marks":[{"type":"code"}]},{"text":" is required in STEP 8.","type":"text"}]},{"type":"paragraph","content":[{"text":"STEP 4: UPLOAD YOUR AUDIO FILE","type":"text","marks":[{"type":"strong"}]}]},{"type":"paragraph","content":[{"text":"Upload a local audio file to ","type":"text"},{"text":"","type":"text","marks":[{"type":"code"}]},{"text":". In the below curl command replace ","type":"text"},{"text":"","type":"text","marks":[{"type":"code"}]},{"text":" with your local file path and ","type":"text"},{"text":"","type":"text","marks":[{"type":"code"}]},{"text":" with the value of the ","type":"text"},{"text":"signedURL","type":"text","marks":[{"type":"code"}]},{"text":" attribute received in ","type":"text"},{"text":"Response 3","type":"text","marks":[{"type":"em"}]},{"text":".","type":"text","marks":[{"type":"strong"}]}]},{"type":"codeBlock","content":[{"text":"curl --request PUT '' \\\n--header 'Content-Type: audio/wave' \\\n--data-binary '@'\n","type":"text"}]},{"type":"paragraph","content":[{"text":" ","type":"text"}]},{"type":"paragraph","content":[{"text":"You can expect the 20X response code for the above mentioned API.","type":"text"}]},{"type":"paragraph","content":[{"text":"STEP 5: LOOK FOR QUESTIONNAIRE REQUIRED FOR MEASURE","type":"text","marks":[{"type":"strong"}]}]},{"type":"paragraph","content":[{"text":"Call the ","type":"text"},{"text":"/measures/name/{measureName}","type":"text","marks":[{"type":"code"}]},{"text":" API to check the questionnaire required for measure and list of languages in which questionnaire is available on Server.","type":"text"}]},{"type":"codeBlock","content":[{"text":"curl --request GET 'https://api.sondeservices.com/platform/v1/measures/name/XYZ' \\\n--header 'Authorization:'\n\n","type":"text"}]},{"type":"paragraph","content":[{"text":"Response 5:","type":"text"}]},{"type":"codeBlock","content":[{"text":"{\n \"id\": \"3c45dc0840er\",\n \"name\": \"XYZ\",\n \"questionnaire\": {\n \"id\": \"qnr_e23er432w\",\n \"title\": \"COVID-19\",\n \"languages\": [\n \"en\"\n ]\n }\n}\n","type":"text"}]},{"type":"paragraph","content":[{"text":"questionnaire.id","type":"text","marks":[{"type":"code"}]},{"text":" and ","type":"text"},{"text":"questionnaire.languages","type":"text","marks":[{"type":"code"}]},{"text":" is required in STEP 6.","type":"text"}]},{"type":"paragraph","content":[{"text":"STEP 6: GET QUESTIONNAIRE FOR THE MEASURE","type":"text","marks":[{"type":"strong"}]}]},{"type":"paragraph","content":[{"text":"Call ","type":"text"},{"text":"/questionnaires/{questionnaireId}?language=","type":"text","marks":[{"type":"code"}]},{"text":" to get questionnaire.","type":"text"}]},{"type":"paragraph","content":[{"text":"Below API will return questionnaire ","type":"text"},{"text":"qnr_e23er432w","type":"text","marks":[{"type":"code"}]},{"text":" in English language.","type":"text"}]},{"type":"paragraph","content":[{"text":" ","type":"text"}]},{"type":"paragraph","content":[{"text":"Replace ","type":"text"},{"text":"","type":"text","marks":[{"type":"code"}]},{"text":" with the value of the access_token attribute of ","type":"text"},{"text":"Response 1","type":"text","marks":[{"type":"em"}]}]},{"type":"codeBlock","content":[{"text":"curl --request GET 'https://api.sondeservices.com/platform/v1/questionnaires/qnr_e23er432w?language=en' \\\n--header 'Authorization:'\n","type":"text"}]},{"type":"paragraph","content":[{"text":" ","type":"text"}]},{"type":"paragraph","content":[{"text":"Response 6:","type":"text"}]},{"type":"codeBlock","content":[{"text":"{\n \"id\": \"qnr_e23er432w\",\n \"title\": \"covid_19\",\n \"language\": \"en\",\n \"questions\": [\n {\n \"type\": \"MULTIPLE_CHOICE\",\n \"text\": \"Have you been within 6 feet of a person with a lab confirmed case of COVID-19 or with symptoms of COVID-19 for at least 15 minutes, or had direct contact with their mucus or saliva,in the past 14 days?\",\n \"isSkippable\": false,\n \"options\": [\n {\n \"text\": \"No\",\n \"score\": 0\n },\n {\n \"text\": \"Yes\",\n \"score\": 1\n }\n ]\n },\n {\n \"type\": \"MULTIPLE_SELECT\",\n \"text\": \"In the last 48 hours, have you had any of the following NEW symptoms? Select all that apply.\",\n \"isSkippable\": false,\n \"options\": [\n {\n \"text\": \"Fever of 100.4° F or above\",\n \"score\": 3\n },\n {\n \"body\": \"Cough\",\n \"score\": 2\n },\n {\n \"text\": \"Trouble breathing\",\n \"score\": 1\n },\n {\n \"text\": \"None of the above\",\n \"score\": 0\n }\n ]\n },\n {\n \"type\": \"TEXT_FIELD\",\n \"text\": \"How many covid center do you have in your city?\",\n \"isSkippable\": true,\n \"inputDataType\": \"INTEGER\"\n },\n {\n \"type\": \"TEXT_FIELD\",\n \"text\": \"What is your body temperature?\",\n \"isSkippable\": false,\n \"inputDataType\": \"STRING\"\n }\n ]\n}\n\n","type":"text"}]},{"type":"paragraph","content":[{"text":"","type":"text"}]},{"type":"paragraph","content":[{"text":"STEP 7: SUBMIT QUESTIONNAIRE RESPONSE TO SERVER","type":"text","marks":[{"type":"strong"}]}]},{"type":"paragraph","content":[{"text":"Ask questionnaire (Got in STEP 6) to your app user and use API ","type":"text"},{"text":"POST /questionnaire-responses","type":"text","marks":[{"type":"code"}]},{"text":" to submit response to server","type":"text"}]},{"type":"paragraph","content":[{"text":" ","type":"text"}]},{"type":"paragraph","content":[{"text":"Replace ","type":"text"},{"text":"","type":"text","marks":[{"type":"code"}]},{"text":" with the value of the access_token attribute of ","type":"text"},{"text":"Response 1","type":"text","marks":[{"type":"em"}]},{"type":"hardBreak"},{"text":"Replace ","type":"text"},{"text":"","type":"text","marks":[{"type":"code"}]},{"text":" with the value of the ","type":"text"},{"text":"id","type":"text","marks":[{"type":"code"}]},{"text":" attribute of ","type":"text"},{"text":"Response6","type":"text","marks":[{"type":"em"}]},{"type":"hardBreak"},{"text":"Replace","type":"text"},{"text":" ","type":"text","marks":[{"type":"em"}]},{"text":"","type":"text","marks":[{"type":"code"}]},{"text":" with the value of one of the language received in ","type":"text"},{"text":"languages","type":"text","marks":[{"type":"code"}]},{"text":" attribute of ","type":"text"},{"text":"Response6","type":"text","marks":[{"type":"em"}]},{"text":" ","type":"text"},{"type":"hardBreak"},{"text":"Replace ","type":"text"},{"text":"","type":"text","marks":[{"type":"code"}]},{"text":" with the value of ","type":"text"},{"text":"userIdentifier","type":"text","marks":[{"type":"code"}]},{"text":" attribute of ","type":"text"},{"text":"Response2","type":"text","marks":[{"type":"em"}]},{"type":"hardBreak"},{"text":"Fill-up ","type":"text"},{"text":"questionnaire.questionResponses","type":"text","marks":[{"type":"code"}]},{"text":" as per user response to questionnaire","type":"text"}]},{"type":"codeBlock","content":[{"text":"$ curl --request POST 'https://api.sondeservices.com/platform/v1/questionnaire-responses' \\\n--header 'Content-Type: application/json' \\\n--header 'Authorization: ' \\\n--data-raw '{\n \"questionnaire\": {\n \"id\": \"\",\n \"language\": \"\",\n \"userIdentifier\": \"\",\n \"respondedAt\": \"2020-08-17T07:11:02Z\",\n \"questionResponses\": [\n {\n \"optionIndex\": 1\n },\n {\n \"optionIndexes\": [\n 0,\n 2\n ]\n },\n {\n \"isSkipped\": true\n },\n {\n \"response\": \"104F\"\n }\n ]\n }\n}'\n","type":"text"}]},{"type":"paragraph","content":[{"text":"","type":"text"}]},{"type":"paragraph","content":[{"text":"Response 7:","type":"text"}]},{"type":"codeBlock","content":[{"text":"{\n \"id\": \"qrs_67ytu89iu\"\n}\n\n","type":"text"}]},{"type":"paragraph","content":[{"text":"id","type":"text","marks":[{"type":"code"}]},{"text":" is required in STEP 8","type":"text"}]},{"type":"paragraph","content":[{"text":"STEP 8: ASK FOR EXPECTED MEASURE SCORE","type":"text","marks":[{"type":"strong"}]}]},{"type":"paragraph","content":[{"text":"Call the ","type":"text"},{"text":"/inference/score","type":"text","marks":[{"type":"code"}]},{"text":" API to get the \"XYZ\" score. Refer to the below curl command.","type":"text"}]},{"type":"paragraph","content":[{"text":"Replace ","type":"text"},{"text":"","type":"text","marks":[{"type":"code"}]},{"text":" with the value of the access_token attribute of ","type":"text"},{"text":"Response 1","type":"text","marks":[{"type":"em"}]},{"type":"hardBreak"},{"text":"Replace ","type":"text"},{"text":"","type":"text","marks":[{"type":"code"}]},{"text":" with the value of ","type":"text"},{"text":"userIdentifier","type":"text","marks":[{"type":"code"}]},{"text":" attribute of ","type":"text"},{"text":"Response 2","type":"text","marks":[{"type":"em"}]},{"type":"hardBreak"},{"text":"Replace ","type":"text"},{"text":"","type":"text","marks":[{"type":"code"}]},{"text":" with the value of the path attribute of ","type":"text"},{"text":"Response3 ","type":"text","marks":[{"type":"em"}]},{"type":"hardBreak"},{"text":"Replace ","type":"text"},{"text":"","type":"text","marks":[{"type":"code"}]},{"text":" with the value of the ","type":"text"},{"text":"id","type":"text","marks":[{"type":"code"}]},{"text":" attribute of ","type":"text"},{"text":"Response7","type":"text","marks":[{"type":"em"}]}]},{"type":"codeBlock","content":[{"text":"$ curl --request POST 'https://api.sondeservices.com/platform/v1/inference/scores' \\\n--header 'Content-Type: application/json' \\\n--header 'Authorization: ' \\\n--data-raw '{\n \"userIdentifier\": \"\",\n \"filePath\": \"\",\n \"questionnaireResponseId\": \"\",\n \"measureName\": \"XYZ\",\n}'\n","type":"text"}]},{"type":"paragraph","content":[{"text":" ","type":"text"}]},{"type":"paragraph","content":[{"text":"Response 8:","type":"text","marks":[{"type":"em"}]}]},{"type":"codeBlock","content":[{"text":"{\n \"requestId\": \"3c45dc08405e\",\n \"measureId\": \"123\",\n \"name\": \"XYZ\",\n \"scoreId\": \"baafa021c9d0\",\n \"score\": 40\n}\n","type":"text"}]},{"type":"paragraph","content":[{"text":"The User’s","type":"text"},{"text":" \"XYZ\" ","type":"text","marks":[{"type":"strong"}]},{"text":"score","type":"text","marks":[{"type":"code"}]},{"text":" ","type":"text","marks":[{"type":"strong"}]},{"text":"is 40","type":"text"},{"text":" ","type":"text","marks":[{"type":"strong"}]},{"text":"(for score and associated severity level please check","type":"text"},{"text":" ","type":"text","marks":[{"type":"strong"}]},{"type":"inlineCard","attrs":{"__confluenceMetadata":{"isRenamedTitle":true,"linkType":"page","contentTitle":"Vocal Biomarkers - Health Checks","versionAtSave":"2"},"url":"https://sondehealth.atlassian.net/wiki/spaces/SA/pages/2706702353"}},{"text":" ).","type":"text"}]},{"type":"paragraph"}],"version":1}

Browser not supported