Welcome videos

Use this resource to retrieve all Welcome Videos or add new Welcome Videos to a company. Once uploaded, a Welcome Video can be assigned to multiple projects (documentation pending) and will be played back by candidates who are invited to those projects.

See a project’s videos attribute to work with uploaded Welcome Videos in the context of a single project.

Attributes

Name	Type	Description
resource_uri	reference	read only
company	reference	read only
submitted_by	reference	read only
description	string	can be updated, this attribute will be shown to candidates
internal_description	string	can be updated, this attribute will not be shown to candidates
file	file	can not be updated
length	integer	read only
name	string	can be updated, this attribute has been deprecated, it is not guaranteed that the candidate will see it
submit_date	date	read only
thumb_conversion_id	integer	read only
thumb_file	file path	read only
thumb	reference	read only
upload_filename	string	read only
video_conversion_id	integer	read only
video_conversion_status	string	read only
streams	object	read only
dimensions	object	read only

List

/companies/{{companyId}}/videos/

Methods

• GET
• POST

POST example

The following CURL command will upload the file SampleVideo_640x360_1mb.mp4 from the current directory and set it as a Welcome Video for company 2:

curl https://interview-suite.com/api/v3/companies/2/videos/ -H 'Authorization: Token <redacted>' -F name="mytestvideo" -F file=@SampleVideo_640x360_1mb.mp4

Example response

{
    "meta": {
        "next": "https://interview-suite.com/api/v3/companies/2/videos/?page=2&page_size=1",
        "previous": null,
        "total_count": 2
    },
    "objects": [
        {
            "resource_uri": "https://interview-suite.com/api/v3/companies/2/videos/7/",
            "company": "https://interview-suite.com/api/v3/companies/2/",
            "submitted_by": "https://interview-suite.com/api/v3/companies/2/customers/3/",
            "description": null,
            "file": "video/2-04b95164145def480547572e8cfda619.flv",
            "length": 37,
            "name": "test#name",
            "submit_date": "2015-06-25T18:52:26Z",
            "thumb_conversion_id": null,
            "thumb_file": "video/2-04b95164145def480547572e8cfda619.png",
            "thumb": "https://interview-suite.com/api/v3/companies/2/videos/7/thumb/a76b5e78cd3/",
            "upload_filename": "2-04b95164145def480547572e8cfda619",
            "video_conversion_id": null,
            "video_conversion_status": "successful",
            "streams":{
                "mp4":"https://interview-suite.com/api/v3/companies/2/videos/7/video/ImU4MmViMmQ1YzNlNDQ3M2M5NWRlOGViZTFiMzE4MTExODgzYTQ0ZWEi.CMBwZw.3_mqOHSBCXe36ffPf_F4hq57_xk.mp4",
                "flv":"https://interview-suite.com/api/v3/companies/2/videos/7/video/ImU4MmViMmQ1YzNlNDQ3M2M5NWRlOGViZTFiMzE4MTExODgzYTQ0ZWEi.CMBwZw.3_mqOHSBCXe36ffPf_F4hq57_xk.flv"
            }
        }
    ]
}

Object

/companies/{{companyId}}/videos/{{videoId}}/

Methods

• GET
• PUT
• PATCH
• DELETE

Example response

{
    "company": "https://interview-suite.com/api/v3/companies/2/",
    "submitted_by": "https://interview-suite.com/api/v3/companies/2/customers/3/",
    "description": null,
    "file": "video/2-04b95164145def480547572e8cfda619.flv",
    "length": 37,
    "name": "test#name",
    "resource_uri": "https://interview-suite.com/api/v3/companies/2/videos/7/",
    "submit_date": "2015-06-25T18:52:26Z",
    "thumb_conversion_id": null,
    "thumb_file": "video/2-04b95164145def480547572e8cfda619.png",
    "thumb": "https://interview-suite.com/api/v3/companies/2/videos/7/thumb/a76b5e78cd3/",
    "upload_filename": "2-04b95164145def480547572e8cfda619",
    "video_conversion_id": null,
    "video_conversion_status": "successful",
    "streams":{
       "mp4":"https://interview-suite.com/api/v3/companies/2/videos/7/video/ImU4MmViMmQ1YzNlNDQ3M2M5NWRlOGViZTFiMzE4MTExODgzYTQ0ZWEi.CMBwZw.3_mqOHSBCXe36ffPf_F4hq57_xk.mp4",
       "flv":"https://interview-suite.com/api/v3/companies/2/videos/7/video/ImU4MmViMmQ1YzNlNDQ3M2M5NWRlOGViZTFiMzE4MTExODgzYTQ0ZWEi.CMBwZw.3_mqOHSBCXe36ffPf_F4hq57_xk.flv"
    }
}

Video Thumbnail URL

/companies/{{companyId}}/videos/{{videoId}}/thumb/{{token}}/

This URL is generated with time limited token for security concerns and provided by Welcome Video resource response, which means each user session will get different tokens every time such Welcome Video is requested. The token expires when the authorization token expires.

Content type returned is a valid image type (i.e. JPEG, PNG)

Video File URLs

/companies/{{companyId}}/videos/{{answerVideoId}}/video/{{token}}.mp4
/companies/{{companyId}}/videos/{{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.

Video Dimensions

The video dimensions is given by width and height attributes of dimensions, it will be 0 while the video is still being converted