Project’s Answer Videos

Please read about the Answer Video workflow before diving into this page.

Attributes

Name Type Description
resource_uri reference read only
ratings reference read only
notes list read only
candidate reference  
question reference  
streams object read only
video_conversion_id string read only
id integer read only
video_conversion_status string read only. See more.
filename string read only. See more.
dimensions object read only

List

/companies/{{companyId}}/projects/{{projectId}}/answervideos/

Methods

  • GET
  • POST

Example response

{"meta":{
    "total_count":6,
    "previous":null,
    "next":"https://interview-suite.com/api/v3/companies/1/projects/1/answervideos/?page=2&page_size=1"
 },
 "objects":[
    {"resource_uri":"https://interview-suite.com/api/v3/companies/1/projects/1/answervideos/1/",
     "id":1,
     "ratings":[],
     "candidate":"https://interview-suite.com/api/v3/companies/4/projects/14/candidates/506/",
     "question":"https://interview-suite.com/api/v3/companies/4/projects/14/questions/28/",
     "streams":{
        "mp4":"https://interview-suite.com/api/v3/companies/1/projects/1/answervideos/1/video/ImU4MmViMmQ1YzNlNDQ3M2M5NWRlOGViZTFiMzE4MTExODgzYTQ0ZWEi.CMBwZw.3_mqOHSBCXe36ffPf_F4hq57_xk.mp4",
        "flv":"https://interview-suite.com/api/v3/companies/1/projects/1/answervideos/1/video/ImU4MmViMmQ1YzNlNDQ3M2M5NWRlOGViZTFiMzE4MTExODgzYTQ0ZWEi.CMBwZw.3_mqOHSBCXe36ffPf_F4hq57_xk.flv"
     },
     "video_conversion_id":null,
     "video_conversion_status":"converting",
     "filename":"5583df99"
     }
   ]
}

Object

/companies/{{companyId}}/projects/{{projectId}}/answervideos/{{answerVideoId}}/

Methods

  • GET

Example response

{"resource_uri":"https://interview-suite.com/api/v3/companies/1/projects/1/answervideos/1/",
 "id":1,
 "ratings":[],
 "candidate":"https://interview-suite.com/api/v3/companies/4/projects/14/candidates/506/",
 "question":"https://interview-suite.com/api/v3/companies/4/projects/14/questions/28/",
 "streams":{
    "mp4":"https://interview-suite.com/api/v3/companies/1/projects/1/answervideos/1/video/ImU4MmViMmQ1YzNlNDQ3M2M5NWRlOGViZTFiMzE4MTExODgzYTQ0ZWEi.CMBwZw.3_mqOHSBCXe36ffPf_F4hq57_xk.mp4",
    "flv":"https://interview-suite.com/api/v3/companies/1/projects/1/answervideos/1/video/ImU4MmViMmQ1YzNlNDQ3M2M5NWRlOGViZTFiMzE4MTExODgzYTQ0ZWEi.CMBwZw.3_mqOHSBCXe36ffPf_F4hq57_xk.flv"
 },
 "video_conversion_id":null,
 "video_conversion_status":"converting",
 "filename":"5583df99"
 }

Video File URLs

/companies/{{companyId}}/projects/{{projectId}}/answervideos/{{answerVideoId}}/video/{{token}}.mp4
/companies/{{companyId}}/projects/{{projectId}}/answervideos/{{answerVideoId}}/video/{{token}}.flv

These URLs is provided by Video resource response, contained a time limited token generated for each request, which means each user session will return a different token, which expires when the authorization token expires.

One URL is returned for each supported video format (i.e. MPeg4, Flash Video).

New formats may apply in the future in this object.

Generate video poster

Triggers generation of poster for this video.

/companies/{{companyId}}/projects/{{projectId}}/answervideos/{{answerVideoId}}/poster/generate/

Methods

  • PATCH

Payload is empty.

Video Dimensions

The video dimensions is given by width and height attributes of dimensions, it will be 0 0 while the video is being converted or if the video submited by the candidate is corrupted.