Checkin

The checkin section of the API represents all the end-points associated with the upload, analysis, and retrieval of video selfies.

POST   /api/V1/checkin
GET     /api/V1/checkin/{checkinidentifier}

Checkin

When to use it:

This is the main end-point you will be using on a regular basis.  Use this end-point to send us a video to analyze.

 

Tips:

  • Video Format:  Make sure you use an approved video format (mp4 or mov)
  • Video Length:  The video should be 20 seconds long.
  • Fields required:
    • uploadedFile: The Video file in multipart/form-file format.
    • strDtVideoTaken: The date(yyyy/mm/dd) video was taken.
    • patientID: The Patient ID.
    • datascienceOptions: All the datascience options needed to make sure we can process your request properly.
  • The end-point returns a 201 resource that you can then use in other end-points when accessing information about the file you just uploaded.

Checkin/{checkinIdentifier}

When to use it:

This end-point will return all the information we have about a given video that you’ve sent up for analysis.

 

Tips:

  • Fields required:
    • checkinIdentifier: The Id of the Video file you uploaded earlier. It was returned as part of the 201 response.
  • The end-point returns …
import http.client

conn = http.client.HTTPSConnection(“smarttecapi2021.azurewebsites.net”)
payload = 
headers = {
  ‘Authorization’‘demo 
}
conn.request(“GET”“/api/V1/checkin/603819934”, payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode(“utf-8”))
curl –location –request GET ‘https://smarttecapi2021.azurewebsites.net/api/V1/checkin/603819934’ \
–header ‘Authorization: demo’  
var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener(“readystatechange”function() {
  if(this.readyState === 4) {
    console.log(this.responseText);
  }
});

xhr.open(“GET”“https://smarttecapi2021.azurewebsites.net/api/V1/checkin/603819934”);
xhr.setRequestHeader(“Authorization”“demo”); 

xhr.send();
{
  "patientID": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "utcDate": "2022-01-27T18:21:43.461Z",
  "checkinIdentifier": "string",
  "geographyRenditionLink": "string",
  "videoLink": "string",
  "processingStep": 0,
  "isVideoUsable": true,
  "isAudioAvailable": true,
  "transcript": "string",
  "sentiment": "string",
  "mood": "string",
  "mhci": 0
}