POST api/Device/GetRelatedVideo

Documentation for 'GetRelatedVideo'.

Request Information

Parameters

Name	Description	Additional information
request	Documentation for 'request'.	Define this parameter in the request body.

Request body formats

application/json, text/json

Sample:

{
  "file_uuid": "sample string 1",
  "print_ffmpeg_log": true,
  "update_if_failed": true,
  "transcode_options": [
    {
      "type": "sample string 1",
      "degrees": 2.0,
      "reduce_to_width": 3,
      "reduce_to_height": 4,
      "keep_high_quality": true,
      "output_format": "sample string 6"
    },
    {
      "type": "sample string 1",
      "degrees": 2.0,
      "reduce_to_width": 3,
      "reduce_to_height": 4,
      "keep_high_quality": true,
      "output_format": "sample string 6"
    },
    {
      "type": "sample string 1",
      "degrees": 2.0,
      "reduce_to_width": 3,
      "reduce_to_height": 4,
      "keep_high_quality": true,
      "output_format": "sample string 6"
    }
  ]
}

application/xml, text/xml

Sample:

<GetRelatedVideoReqeust xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ContentApi.Client.Rest.Device.Entities">
  <file_uuid>sample string 1</file_uuid>
  <print_ffmpeg_log>true</print_ffmpeg_log>
  <transcode_options>
    <GetRelatedVideoReqeust.TranscodeOption>
      <degrees>2</degrees>
      <keep_high_quality>true</keep_high_quality>
      <output_format>sample string 6</output_format>
      <reduce_to_height>4</reduce_to_height>
      <reduce_to_width>3</reduce_to_width>
      <type>sample string 1</type>
    </GetRelatedVideoReqeust.TranscodeOption>
    <GetRelatedVideoReqeust.TranscodeOption>
      <degrees>2</degrees>
      <keep_high_quality>true</keep_high_quality>
      <output_format>sample string 6</output_format>
      <reduce_to_height>4</reduce_to_height>
      <reduce_to_width>3</reduce_to_width>
      <type>sample string 1</type>
    </GetRelatedVideoReqeust.TranscodeOption>
    <GetRelatedVideoReqeust.TranscodeOption>
      <degrees>2</degrees>
      <keep_high_quality>true</keep_high_quality>
      <output_format>sample string 6</output_format>
      <reduce_to_height>4</reduce_to_height>
      <reduce_to_width>3</reduce_to_width>
      <type>sample string 1</type>
    </GetRelatedVideoReqeust.TranscodeOption>
  </transcode_options>
  <update_if_failed>true</update_if_failed>
</GetRelatedVideoReqeust>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'FormUrlEncodedMediaTypeFormatterTracer' to write type 'GetRelatedVideoReqeust'.

Response Information

Response body formats

application/json, text/json

Sample:

{
  "content_convert_state": 0,
  "last_error_message": "sample string 1",
  "file_info": {
    "is_link": true,
    "file_name": "sample string 2",
    "relative_path": "sample string 3",
    "link_relative_path": "sample string 4",
    "url": "sample string 5",
    "file_size": 6,
    "attribute": "sample string 7",
    "last_utc_modify_time": "sample string 8",
    "uuid": "sample string 9",
    "origin_uuid": "sample string 10",
    "thumb_uuid": "sample string 11",
    "preview_uuid": "sample string 12",
    "like_num": 13,
    "user_like_num": 14,
    "meta_data": {
      "duration": 1,
      "width": 1,
      "height": 1,
      "vidoe_bit_rate": 1,
      "audio_bit_rate": 1,
      "video_codec": "sample string 1",
      "audio_codec": "sample string 2",
      "video_fps": 3.1,
      "artist": "sample string 4",
      "album": "sample string 5",
      "album_artist": "sample string 6",
      "copy_right": "sample string 7",
      "description": "sample string 8",
      "upload_utc_time": "sample string 9",
      "upload_user_name": "sample string 10",
      "dependency_info": {
        "resources": [
          {
            "uuid": "sample string 1",
            "is_placeholder": true
          },
          {
            "uuid": "sample string 1",
            "is_placeholder": true
          },
          {
            "uuid": "sample string 1",
            "is_placeholder": true
          }
        ],
        "screen_tags": [
          {
            "group_id": 1,
            "tag_ids": [
              1,
              2,
              3
            ]
          },
          {
            "group_id": 1,
            "tag_ids": [
              1,
              2,
              3
            ]
          },
          {
            "group_id": 1,
            "tag_ids": [
              1,
              2,
              3
            ]
          }
        ]
      },
      "other_resolutions": [
        null,
        {
          "uuid": "sample string 1",
          "file_type": 0,
          "file_size": 2,
          "file_type_text": "sample string 3",
          "ticks": 4,
          "last_modify_time_utc": "sample string 5",
          "filters": "sample string 6",
          "url": "sample string 7",
          "last_error_message": "sample string 8",
          "resolution": "0.5k",
          "width": 0,
          "height": 0
        },
        {
          "uuid": "sample string 1",
          "file_type": 0,
          "file_size": 2,
          "file_type_text": "sample string 3",
          "ticks": 4,
          "last_modify_time_utc": "sample string 5",
          "filters": "sample string 6",
          "url": "sample string 7",
          "last_error_message": "sample string 8",
          "resolution": "0.5k",
          "width": 0,
          "height": 0
        }
      ],
      "first_frame_images": [
        {
          "uuid": "sample string 1",
          "file_type": 0,
          "file_size": 2,
          "file_type_text": "sample string 3",
          "ticks": 4,
          "last_modify_time_utc": "sample string 5",
          "filters": "sample string 6",
          "url": "sample string 7",
          "last_error_message": "sample string 8",
          "resolution": "0.5k",
          "width": 0,
          "height": 0
        },
        {
          "uuid": "sample string 1",
          "file_type": 0,
          "file_size": 2,
          "file_type_text": "sample string 3",
          "ticks": 4,
          "last_modify_time_utc": "sample string 5",
          "filters": "sample string 6",
          "url": "sample string 7",
          "last_error_message": "sample string 8",
          "resolution": "0.5k",
          "width": 0,
          "height": 0
        },
        {
          "uuid": "sample string 1",
          "file_type": 0,
          "file_size": 2,
          "file_type_text": "sample string 3",
          "ticks": 4,
          "last_modify_time_utc": "sample string 5",
          "filters": "sample string 6",
          "url": "sample string 7",
          "last_error_message": "sample string 8",
          "resolution": "0.5k",
          "width": 0,
          "height": 0
        }
      ],
      "related_videos": [
        {
          "uuid": "sample string 1",
          "file_type": 0,
          "file_size": 2,
          "file_type_text": "sample string 3",
          "ticks": 4,
          "last_modify_time_utc": "sample string 5",
          "filters": "sample string 6",
          "url": "sample string 7",
          "last_error_message": "sample string 8",
          "resolution": "0.5k",
          "width": 0,
          "height": 0
        },
        {
          "uuid": "sample string 1",
          "file_type": 0,
          "file_size": 2,
          "file_type_text": "sample string 3",
          "ticks": 4,
          "last_modify_time_utc": "sample string 5",
          "filters": "sample string 6",
          "url": "sample string 7",
          "last_error_message": "sample string 8",
          "resolution": "0.5k",
          "width": 0,
          "height": 0
        },
        {
          "uuid": "sample string 1",
          "file_type": 0,
          "file_size": 2,
          "file_type_text": "sample string 3",
          "ticks": 4,
          "last_modify_time_utc": "sample string 5",
          "filters": "sample string 6",
          "url": "sample string 7",
          "last_error_message": "sample string 8",
          "resolution": "0.5k",
          "width": 0,
          "height": 0
        }
      ],
      "last_error_message": "sample string 11",
      "content_convert_state": 0,
      "third_part_metadata": {
        "provider": "sample string 1",
        "content_id": "sample string 2",
        "user": "sample string 3",
        "page_url": "sample string 4",
        "is_premium": true
      },
      "font_family_name": "sample string 12",
      "font_bold": true,
      "font_italic": true,
      "font_weight": 1,
      "is_success": true,
      "error_message": "sample string 14",
      "exception_name": "sample string 15",
      "error_code": 16
    },
    "is_success": true,
    "error_message": "sample string 16",
    "exception_name": "sample string 17",
    "error_code": 18
  },
  "is_success": true,
  "error_message": "sample string 3",
  "exception_name": "sample string 4",
  "error_code": 5
}

application/xml, text/xml

Sample:

<GetRelatedVideoResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ContentApi.Client.Rest.Device.Entities">
  <error_code xmlns="http://schemas.datacontract.org/2004/07/Mandoe.Framework.WebApi">5</error_code>
  <error_message xmlns="http://schemas.datacontract.org/2004/07/Mandoe.Framework.WebApi">sample string 3</error_message>
  <exception_name xmlns="http://schemas.datacontract.org/2004/07/Mandoe.Framework.WebApi">sample string 4</exception_name>
  <is_success xmlns="http://schemas.datacontract.org/2004/07/Mandoe.Framework.WebApi">true</is_success>
  <content_convert_state>NotConvert</content_convert_state>
  <file_info>
    <error_code xmlns="http://schemas.datacontract.org/2004/07/Mandoe.Framework.WebApi">18</error_code>
    <error_message xmlns="http://schemas.datacontract.org/2004/07/Mandoe.Framework.WebApi">sample string 16</error_message>
    <exception_name xmlns="http://schemas.datacontract.org/2004/07/Mandoe.Framework.WebApi">sample string 17</exception_name>
    <is_success xmlns="http://schemas.datacontract.org/2004/07/Mandoe.Framework.WebApi">true</is_success>
    <attribute>sample string 7</attribute>
    <file_name>sample string 2</file_name>
    <file_size>6</file_size>
    <is_link>true</is_link>
    <last_utc_modify_time>sample string 8</last_utc_modify_time>
    <like_num>13</like_num>
    <link_relative_path>sample string 4</link_relative_path>
    <meta_data>
      <error_code xmlns="http://schemas.datacontract.org/2004/07/Mandoe.Framework.WebApi">16</error_code>
      <error_message xmlns="http://schemas.datacontract.org/2004/07/Mandoe.Framework.WebApi">sample string 14</error_message>
      <exception_name xmlns="http://schemas.datacontract.org/2004/07/Mandoe.Framework.WebApi">sample string 15</exception_name>
      <is_success xmlns="http://schemas.datacontract.org/2004/07/Mandoe.Framework.WebApi">true</is_success>
      <album>sample string 5</album>
      <album_artist>sample string 6</album_artist>
      <artist>sample string 4</artist>
      <audio_bit_rate>1</audio_bit_rate>
      <audio_codec>sample string 2</audio_codec>
      <content_convert_state>NotConvert</content_convert_state>
      <copy_right>sample string 7</copy_right>
      <dependency_info xmlns:d4p1="http://schemas.datacontract.org/2004/07/Mandoe.Framework.MDFS.IO">
        <d4p1:resources>
          <d4p1:FileDependencyInfo.Dependency>
            <d4p1:is_placeholder>true</d4p1:is_placeholder>
            <d4p1:uuid>sample string 1</d4p1:uuid>
          </d4p1:FileDependencyInfo.Dependency>
          <d4p1:FileDependencyInfo.Dependency>
            <d4p1:is_placeholder>true</d4p1:is_placeholder>
            <d4p1:uuid>sample string 1</d4p1:uuid>
          </d4p1:FileDependencyInfo.Dependency>
          <d4p1:FileDependencyInfo.Dependency>
            <d4p1:is_placeholder>true</d4p1:is_placeholder>
            <d4p1:uuid>sample string 1</d4p1:uuid>
          </d4p1:FileDependencyInfo.Dependency>
        </d4p1:resources>
        <d4p1:screen_tags>
          <d4p1:FileDependencyInfo.ScreenTagItem>
            <d4p1:group_id>1</d4p1:group_id>
            <d4p1:tag_ids xmlns:d7p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
              <d7p1:long>1</d7p1:long>
              <d7p1:long>2</d7p1:long>
              <d7p1:long>3</d7p1:long>
            </d4p1:tag_ids>
          </d4p1:FileDependencyInfo.ScreenTagItem>
          <d4p1:FileDependencyInfo.ScreenTagItem>
            <d4p1:group_id>1</d4p1:group_id>
            <d4p1:tag_ids xmlns:d7p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
              <d7p1:long>1</d7p1:long>
              <d7p1:long>2</d7p1:long>
              <d7p1:long>3</d7p1:long>
            </d4p1:tag_ids>
          </d4p1:FileDependencyInfo.ScreenTagItem>
          <d4p1:FileDependencyInfo.ScreenTagItem>
            <d4p1:group_id>1</d4p1:group_id>
            <d4p1:tag_ids xmlns:d7p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
              <d7p1:long>1</d7p1:long>
              <d7p1:long>2</d7p1:long>
              <d7p1:long>3</d7p1:long>
            </d4p1:tag_ids>
          </d4p1:FileDependencyInfo.ScreenTagItem>
        </d4p1:screen_tags>
      </dependency_info>
      <description>sample string 8</description>
      <duration>1</duration>
      <first_frame_images xmlns:d4p1="http://schemas.datacontract.org/2004/07/Mandoe.Framework.MDFS.IO">
        <d4p1:OtherResolutionFileInfo>
          <height xmlns="http://schemas.datacontract.org/2004/07/Mandoe.Framework.Media">0</height>
          <resolution xmlns="http://schemas.datacontract.org/2004/07/Mandoe.Framework.Media">0.5k</resolution>
          <width xmlns="http://schemas.datacontract.org/2004/07/Mandoe.Framework.Media">0</width>
          <d4p1:file_size>2</d4p1:file_size>
          <d4p1:file_type>Normal</d4p1:file_type>
          <d4p1:file_type_text>sample string 3</d4p1:file_type_text>
          <d4p1:filters>sample string 6</d4p1:filters>
          <d4p1:last_error_message>sample string 8</d4p1:last_error_message>
          <d4p1:last_modify_time_utc>sample string 5</d4p1:last_modify_time_utc>
          <d4p1:ticks>4</d4p1:ticks>
          <d4p1:url>sample string 7</d4p1:url>
          <d4p1:uuid>sample string 1</d4p1:uuid>
        </d4p1:OtherResolutionFileInfo>
        <d4p1:OtherResolutionFileInfo>
          <height xmlns="http://schemas.datacontract.org/2004/07/Mandoe.Framework.Media">0</height>
          <resolution xmlns="http://schemas.datacontract.org/2004/07/Mandoe.Framework.Media">0.5k</resolution>
          <width xmlns="http://schemas.datacontract.org/2004/07/Mandoe.Framework.Media">0</width>
          <d4p1:file_size>2</d4p1:file_size>
          <d4p1:file_type>Normal</d4p1:file_type>
          <d4p1:file_type_text>sample string 3</d4p1:file_type_text>
          <d4p1:filters>sample string 6</d4p1:filters>
          <d4p1:last_error_message>sample string 8</d4p1:last_error_message>
          <d4p1:last_modify_time_utc>sample string 5</d4p1:last_modify_time_utc>
          <d4p1:ticks>4</d4p1:ticks>
          <d4p1:url>sample string 7</d4p1:url>
          <d4p1:uuid>sample string 1</d4p1:uuid>
        </d4p1:OtherResolutionFileInfo>
        <d4p1:OtherResolutionFileInfo>
          <height xmlns="http://schemas.datacontract.org/2004/07/Mandoe.Framework.Media">0</height>
          <resolution xmlns="http://schemas.datacontract.org/2004/07/Mandoe.Framework.Media">0.5k</resolution>
          <width xmlns="http://schemas.datacontract.org/2004/07/Mandoe.Framework.Media">0</width>
          <d4p1:file_size>2</d4p1:file_size>
          <d4p1:file_type>Normal</d4p1:file_type>
          <d4p1:file_type_text>sample string 3</d4p1:file_type_text>
          <d4p1:filters>sample string 6</d4p1:filters>
          <d4p1:last_error_message>sample string 8</d4p1:last_error_message>
          <d4p1:last_modify_time_utc>sample string 5</d4p1:last_modify_time_utc>
          <d4p1:ticks>4</d4p1:ticks>
          <d4p1:url>sample string 7</d4p1:url>
          <d4p1:uuid>sample string 1</d4p1:uuid>
        </d4p1:OtherResolutionFileInfo>
      </first_frame_images>
      <font_bold>true</font_bold>
      <font_family_name>sample string 12</font_family_name>
      <font_italic>true</font_italic>
      <font_weight>1</font_weight>
      <height>1</height>
      <last_error_message>sample string 11</last_error_message>
      <other_resolutions xmlns:d4p1="http://schemas.datacontract.org/2004/07/Mandoe.Framework.MDFS.IO">
        <d4p1:OtherResolutionFileInfo i:nil="true" />
        <d4p1:OtherResolutionFileInfo>
          <height xmlns="http://schemas.datacontract.org/2004/07/Mandoe.Framework.Media">0</height>
          <resolution xmlns="http://schemas.datacontract.org/2004/07/Mandoe.Framework.Media">0.5k</resolution>
          <width xmlns="http://schemas.datacontract.org/2004/07/Mandoe.Framework.Media">0</width>
          <d4p1:file_size>2</d4p1:file_size>
          <d4p1:file_type>Normal</d4p1:file_type>
          <d4p1:file_type_text>sample string 3</d4p1:file_type_text>
          <d4p1:filters>sample string 6</d4p1:filters>
          <d4p1:last_error_message>sample string 8</d4p1:last_error_message>
          <d4p1:last_modify_time_utc>sample string 5</d4p1:last_modify_time_utc>
          <d4p1:ticks>4</d4p1:ticks>
          <d4p1:url>sample string 7</d4p1:url>
          <d4p1:uuid>sample string 1</d4p1:uuid>
        </d4p1:OtherResolutionFileInfo>
        <d4p1:OtherResolutionFileInfo>
          <height xmlns="http://schemas.datacontract.org/2004/07/Mandoe.Framework.Media">0</height>
          <resolution xmlns="http://schemas.datacontract.org/2004/07/Mandoe.Framework.Media">0.5k</resolution>
          <width xmlns="http://schemas.datacontract.org/2004/07/Mandoe.Framework.Media">0</width>
          <d4p1:file_size>2</d4p1:file_size>
          <d4p1:file_type>Normal</d4p1:file_type>
          <d4p1:file_type_text>sample string 3</d4p1:file_type_text>
          <d4p1:filters>sample string 6</d4p1:filters>
          <d4p1:last_error_message>sample string 8</d4p1:last_error_message>
          <d4p1:last_modify_time_utc>sample string 5</d4p1:last_modify_time_utc>
          <d4p1:ticks>4</d4p1:ticks>
          <d4p1:url>sample string 7</d4p1:url>
          <d4p1:uuid>sample string 1</d4p1:uuid>
        </d4p1:OtherResolutionFileInfo>
      </other_resolutions>
      <related_videos xmlns:d4p1="http://schemas.datacontract.org/2004/07/Mandoe.Framework.MDFS.IO">
        <d4p1:OtherResolutionFileInfo>
          <height xmlns="http://schemas.datacontract.org/2004/07/Mandoe.Framework.Media">0</height>
          <resolution xmlns="http://schemas.datacontract.org/2004/07/Mandoe.Framework.Media">0.5k</resolution>
          <width xmlns="http://schemas.datacontract.org/2004/07/Mandoe.Framework.Media">0</width>
          <d4p1:file_size>2</d4p1:file_size>
          <d4p1:file_type>Normal</d4p1:file_type>
          <d4p1:file_type_text>sample string 3</d4p1:file_type_text>
          <d4p1:filters>sample string 6</d4p1:filters>
          <d4p1:last_error_message>sample string 8</d4p1:last_error_message>
          <d4p1:last_modify_time_utc>sample string 5</d4p1:last_modify_time_utc>
          <d4p1:ticks>4</d4p1:ticks>
          <d4p1:url>sample string 7</d4p1:url>
          <d4p1:uuid>sample string 1</d4p1:uuid>
        </d4p1:OtherResolutionFileInfo>
        <d4p1:OtherResolutionFileInfo>
          <height xmlns="http://schemas.datacontract.org/2004/07/Mandoe.Framework.Media">0</height>
          <resolution xmlns="http://schemas.datacontract.org/2004/07/Mandoe.Framework.Media">0.5k</resolution>
          <width xmlns="http://schemas.datacontract.org/2004/07/Mandoe.Framework.Media">0</width>
          <d4p1:file_size>2</d4p1:file_size>
          <d4p1:file_type>Normal</d4p1:file_type>
          <d4p1:file_type_text>sample string 3</d4p1:file_type_text>
          <d4p1:filters>sample string 6</d4p1:filters>
          <d4p1:last_error_message>sample string 8</d4p1:last_error_message>
          <d4p1:last_modify_time_utc>sample string 5</d4p1:last_modify_time_utc>
          <d4p1:ticks>4</d4p1:ticks>
          <d4p1:url>sample string 7</d4p1:url>
          <d4p1:uuid>sample string 1</d4p1:uuid>
        </d4p1:OtherResolutionFileInfo>
        <d4p1:OtherResolutionFileInfo>
          <height xmlns="http://schemas.datacontract.org/2004/07/Mandoe.Framework.Media">0</height>
          <resolution xmlns="http://schemas.datacontract.org/2004/07/Mandoe.Framework.Media">0.5k</resolution>
          <width xmlns="http://schemas.datacontract.org/2004/07/Mandoe.Framework.Media">0</width>
          <d4p1:file_size>2</d4p1:file_size>
          <d4p1:file_type>Normal</d4p1:file_type>
          <d4p1:file_type_text>sample string 3</d4p1:file_type_text>
          <d4p1:filters>sample string 6</d4p1:filters>
          <d4p1:last_error_message>sample string 8</d4p1:last_error_message>
          <d4p1:last_modify_time_utc>sample string 5</d4p1:last_modify_time_utc>
          <d4p1:ticks>4</d4p1:ticks>
          <d4p1:url>sample string 7</d4p1:url>
          <d4p1:uuid>sample string 1</d4p1:uuid>
        </d4p1:OtherResolutionFileInfo>
      </related_videos>
      <third_part_metadata xmlns:d4p1="http://schemas.datacontract.org/2004/07/Mandoe.Framework.MDFS.IO">
        <d4p1:content_id>sample string 2</d4p1:content_id>
        <d4p1:is_premium>true</d4p1:is_premium>
        <d4p1:page_url>sample string 4</d4p1:page_url>
        <d4p1:provider>sample string 1</d4p1:provider>
        <d4p1:user>sample string 3</d4p1:user>
      </third_part_metadata>
      <upload_user_name>sample string 10</upload_user_name>
      <upload_utc_time>sample string 9</upload_utc_time>
      <video_codec>sample string 1</video_codec>
      <video_fps>3.1</video_fps>
      <vidoe_bit_rate>1</vidoe_bit_rate>
      <width>1</width>
    </meta_data>
    <origin_uuid>sample string 10</origin_uuid>
    <preview_uuid>sample string 12</preview_uuid>
    <relative_path>sample string 3</relative_path>
    <thumb_uuid>sample string 11</thumb_uuid>
    <url>sample string 5</url>
    <user_like_num>14</user_like_num>
    <uuid>sample string 9</uuid>
  </file_info>
  <last_error_message>sample string 1</last_error_message>
</GetRelatedVideoResponse>