Supplemental Files

This API uploads files to associate with the specified video. Typical file types include PowerPoint and PDF documents to provide the viewer with additional information. Supported file types are listed in Rev’s online help.

POST
/api/uploads/supplemental-files/{videoId}

Request Parameters

Name Type Description Required
videoId path GUID for the specific video Yes
Content-Type header multipart/form-data Yes
files [] string FileName = string with file name and extension Yes

Example – curl

curl -X POST https://doug.rev-eu.demo.vbrick.com/api/uploads/supplemental-files/f63b69c8-3646-4350-a8e7-df263aa96f9f \
  -H 'Authorization: VBrick jCqpQawR1fY6PIOw5avvI-qMrB9b7pPU81EK5xkI_8g-DFUhfoaVFNWV1LfUWxyeBv5mlyLRo04Lz3FPgIgMlg4TypcNQlqj9oU0SqJg3TWMPtFoG-AHi-8s0fftqsNbVcVhqR8KwcoU78E0KhgFgg2' \
  -H 'Cache-Control: no-cache' \
  -H 'Postman-Token: be1e803c-84e2-4608-a9b3-37e83ff8e039' \
  -H 'content-type: multipart/form-data; boundary=----WebKitFormBoundary7MA4YWxkTrZu0gW' \
  -F '=@C:\Doug\Samples\Sample.docx' \
  -F 'SupplementalFiles={
  "files": [
    {
      "fileName": "myfile"
    }
  ]
}'

Response Codes

Code Description
200 ok
401 Unauthorized error
500 Internal server error
Errors MalformedRequest = “Bad request format. Please check your request.”;
FileNotSupported = “Sorry! Cannot upload this file type.”;
FileNotSent = “The video file was not uploaded.”;
UserNotProvided = “Unable to upload video. Please ensure that video is associated to a valid user.”;
UserDoesNotExist = “Unable to upload video. Please ensure that video is associated to a valid user.”;
InternalServerError = “Unable to process request at this time. Please try again later.”

Subtitle Files

These are subtitle files for hearing impaired viewers. The only file type accepted .srt

POST
/api/uploads/transcription-files/{videoId}

Request Parameters

Name Type Description Required
videoId path GUID for the specific video Yes
TranscriptionFiles multipart/form-data The actual file Yes
files [] string fileName = subtitle filename
language = two character language code

Supported Language codes – { “de”, “en”, “es-ES”, “es”, “fr”, “it”, “nl”, “pl”, “pt”, “fi”, “sv”, “ru”, “el”, “zh”, “ja” }Yes

Example Request

 
--------FormBoundary
                      Content-Disposition: form-data; name="TranscriptionFiles"

                      {"files":[{"fileName":"english.srt", "language": "en"}, {"fileName":"german.srt", "language":"de"}]}

--------FormBoundary
Content-Disposition: form-data; name="File1"; filename="english.srt"
Content-Type: application/octet-stream
���ftypmp42����isommp42��­:moov���lmvhd�������[���[��[1]X��/��������������������������������������������@������������������������������
���iods�����O��)��� 
--------FormBoundary
Content-Disposition: form-data; name="File2"; filename="german.srt"
Content-Type: application/octet-stream
���ftypmp42����isommp42��­:moov���lmvhd�������[���[��[1]X��/��������������������������������������������@������������������������������
���iods�����O��)��� 
--------FormBoundary

Response Codes

Code Description
200 ok
401 Unauthorized error
500 Internal server error
Errors MalformedRequest = “Bad request format. Please check your request.”;
FileNotSupported = “Sorry! Cannot upload this file type.”;
FileNotSent = “The video file was not uploaded.”;
UserNotProvided = “Unable to upload video. Please ensure that video is associated to a valid user.”;
UserDoesNotExist = “Unable to upload video. Please ensure that video is associated to a valid user.”;

Thumbnail Image Files

This allows you to select a different image used for the thumbnail image for the video player.

POST
/api/uploads/images/{videoId}

Request Parameters

Name Type Description Required
videoId path GUID for the specific video Yes
Thumbnail image file multipart/form-data Accepted file types include – .jpg .png .gif Yes

Example – curl

curl -X POST --https://doug.rev-eu.demo.vbrick.com/api/uploads/images/f63b69c8-3646-4350-a8e7-df263aa96f9f \
  -H 'Authorization: VBrick -XQhEjgurerpdQzRwuTpSOfi826imBv0IiK2JUb5APiUx53X4nyIlp6Vr02UjpMFrTRIZtOHP0bbE6LKZaHQWSnounfzXeSwd3XgpbtCwnw-aDYnG01_o7NrYM50LAv0d4XGepgrJ_o2d5fp4AIPMQ2' \
  -H 'Cache-Control: no-cache' \
  -H 'Content-Type: application/x-www-form-urlencoded' \
  -H 'Postman-Token: 38fcb2d4-e5ea-4bd8-9025-c0e65aa2e7a2' \
  -H 'content-type: multipart/form-data; boundary=----WebKitFormBoundary7MA4YWxkTrZu0gW' \
  -F '=@C:\Doug\Samples\Thumbnail.jpg'

Response Codes

Code Description
200 ok
401 Unauthorized error
500 Internal server error
Errors MalformedRequest = “Bad request format. Please check your request.”;
FileNotSupported = “Sorry! Cannot upload this file type.”;
FileNotSent = “The video file was not uploaded.”;
UserNotProvided = “Unable to upload video. Please ensure that video is associated to a valid user.”;
UserDoesNotExist = “Unable to upload video. Please ensure that video is associated to a valid user.”;