Acquisition of keyword search result

This API returns keywords search result.
Tag will be searched with perfect matching and caption will be searched with partial match.
GET /api/1/videos/search

Note

This API’s behavior depends on the authentication.
If the digest authentication is passed, this API returns a list of keyword result that has “not deleted media”.
If the Referrer + Key authentication is passed, this API returns a list of keyword result that has “activated media”.

Parameters

  • output_type

    • Response type
      • x: Output in XML format
      • blank: Output in JSON format

  • page [required]

    • Page which will be rendered. Integer greater than 1.[Appendix]

  • num [required]

  • keywords [required]

    • search keyword
      #(characters): tag search (Perfect match)
      (characters): caption and description search (Partial match)
      &(integer): (Partial match)

Response

  • status

    • Result of process
      success: success
      other: failure

  • has_next

    • existence on the next page
      true: exist
      false: not exist

  • total

    • total media number

  • info

    • media information

      • id

        • media id

      • caption

        • caption

      • description

        • description

      • tags

        • tag

      • thumbnail_url

        • fv thumbnail URL

      • sound_url

        • fv sound URL

      • tile_info

        • tile information
          • version
            • version of fv encoder
          • type
            • tile type
          • fps
            • fps
          • frames
            • total frame of tile
          • level
            • tile level
          • tile_quality
            • tile quality
          • create_date
            • creation date of tile
          • update_date
            • updated date of tile
          • status
            • tile status

      • create_date

        • creation date of media

      • update_date

        • updated date of media

      • status

        • media status
          0: invalid
          1: valid

Request Example

GET
https://example.com/api/1/videos/search?page=1&num=2&keywords=abc

Response Example - JSON

{
  "status":"success",
  "has_next":true,
  "total":8,
  "info":[
    {
      "id":17,
      "caption":"test caption",
      "tags":[
        "tag",
        "abc",
        "test"
      ],
      "thumbnail_url":[
        "http:\/\/example.com\/r\/p\/images\/tt\/17_144_0.jpg",
        "http:\/\/example.com\/r\/p\/images\/tt\/17_288_0.jpg",
        "http:\/\/example.com\/r\/p\/images\/tt\/17_432_0.jpg",
        "http:\/\/example.com\/r\/p\/images\/tt\/17_576_0.jpg"
      ],
      "sound_url":[
        "http:\/\/example.com\/r\/p\/audios\/ta\/17_1.m4a"
      ],
      "tile_info":{
        "version":"3",
        "type":"hd144",
        "fps":30,
        "frames":4500,
        "level":[
          1,
          2,
          3,
          4
        ],
        "tile_quality":[1,2],
        "create_date":"2013-01-11 12:25:17",
        "update_date":"2013-01-11 12:38:43",
        "status":1
      },
      "create_date":"2013-01-11 12:25:17",
      "update_date":"2013-01-11 15:48:15",
      "status":1
    },
    {
      "id":16,
      "caption":"test caption",
      "tags":[
        "tag",
        "abc",
        "test"
      ],
      "thumbnail_url":[
        "http:\/\/example.com\/r\/p\/images\/tt\/16_144_0.jpg",
        "http:\/\/example.com\/r\/p\/images\/tt\/16_288_0.jpg",
        "http:\/\/example.com\/r\/p\/images\/tt\/16_432_0.jpg",
        "http:\/\/example.com\/r\/p\/images\/tt\/16_576_0.jpg"
      ],
      "sound_url":[
        "http:\/\/example.com\/r\/p\/audios\/ta\/16_1.m4a"
      ],
      "tile_info":{
        "version":"3",
        "type":"hd144",
        "fps":30,
        "frames":3090,
      "level":[
        1,
        2,
        3,
        4
      ],
      "tile_quality":[1,3],
      "create_date":"2013-01-11 12:24:53",
      "update_date":"2013-01-11 12:35:40",
      "status":1
    },
    "create_date":"2013-01-11 12:24:53",
    "update_date":"2013-01-11 12:25:01",
    "status":1
    }
  ]
}

Response Example - XML

<?xml version="1.0" encoding="UTF-8"?>
<response>
<status>success</status>
<has_next>1</has_next>
<total>8</total>
<info>
  <entry>
    <id>17</id>
    <caption>test caption</caption>
    <tags>
      <entry>tag</entry>
      <entry>abc</entry>
      <entry>test</entry>
    </tags>
    <thumbnail_url>
      <entry>http://example.com/r/p/images/tt/17_144_0.jpg</entry>
      <entry>http://example.com/r/p/images/tt/17_288_0.jpg</entry>
      <entry>http://example.com/r/p/images/tt/17_432_0.jpg</entry>
      <entry>http://example.com/r/p/images/tt/17_576_0.jpg</entry>
    </thumbnail_url>
    <sound_url>
      <entry>http://example.com/r/p/audios/ta/17_1.m4a</entry>
    </sound_url>
    <tile_info>
      <version>3</version>
      <type>hd144</type>
      <fps>30</fps>
      <frames>4500</frames>
      <level>
        <entry>1</entry>
        <entry>2</entry>
        <entry>3</entry>
        <entry>4</entry>
      </level>
      <tile_quality>
       <entry>1</entry>
       <entry>2</entry>
      </tile_quality>
      <create_date>2013-01-11 12:25:17</create_date>
      <update_date>2013-01-11 12:38:43</update_date>
      <status>1</status>
    </tile_info>
    <create_date>2013-01-11 12:25:17</create_date>
    <update_date>2013-01-11 15:48:15</update_date>
    <status>1</status>
  </entry>
  <entry>
    <id>16</id>
    <caption>test caption</caption>
    <tags>
      <entry>tag</entry>
      <entry>abc</entry>
      <entry>test</entry>
    </tags>
    <thumbnail_url>
      <entry>http://example.com/r/p/images/tt/16_144_0.jpg</entry>
      <entry>http://example.com/r/p/images/tt/16_288_0.jpg</entry>
      <entry>http://example.com/r/p/images/tt/16_432_0.jpg</entry>
      <entry>http://example.com/r/p/images/tt/16_576_0.jpg</entry>
    </thumbnail_url>
    <sound_url>
      <entry>http://example.com/r/p/audios/ta/16_1.m4a</entry>
    </sound_url>
    <tile_info>
      <version>3</version>
      <type>hd144</type>
      <fps>30</fps>
      <frames>3090</frames>
      <level>
        <entry>1</entry>
        <entry>2</entry>
        <entry>3</entry>
        <entry>4</entry>
      </level>
      <tile_quality>
        <entry>1</entry>
        <entry>3</entry>
      </tile_quality>
      <create_date>2013-01-11 12:24:53</create_date>
      <update_date>2013-01-11 12:35:40</update_date>
      <status>1</status>
    </tile_info>
    <create_date>2013-01-11 12:24:53</create_date>
    <update_date>2013-01-11 12:25:01</update_date>
    <status>1</status>
  </entry>
</info>
</response>