POST api/collection/v{version}/{collectionId}/VideoInfoList

Return a list of videos with ALL Keywords in the given collection. Access to videos depends on dartfish.tv access rights.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
collectionId

ID of the specific collection (must correspond to the channel key)

integer

Required

version

string

None.

Body Parameters

Page query parameters (keywords + logic + paging index)

PageQueryParam
NameDescriptionTypeAdditional information
StartIndex

Start index. Starts at 0.

integer

None.

EndIndex

End index. Returned items count is EndIndex-StartIndex. EndIndex can be greater than total items count.

integer

None.

VideoKeywords

Video keywords list to use in the query.

Collection of Keyword

None.

EventKeywords

Event keywords list to use in the query.

Collection of Keyword

None.

QueryLogic

Query logic : And (only And is supported for the moment).

QueryLogicEnum

None.

SortingOrder

Sorting order of the result items.

SortingOrderEnum

None.

Request Formats

application/json, text/json

Sample:
{
  "StartIndex": 0,
  "EndIndex": 1,
  "VideoKeywords": [
    {
      "Values": [
        "video kw1 level1",
        "video kw1 level2"
      ]
    },
    {
      "Values": [
        "video kw2 level1",
        "video kw2 level2"
      ]
    }
  ],
  "EventKeywords": [
    {
      "Values": [
        "event kw1 level1",
        "event kw1 level2"
      ]
    },
    {
      "Values": [
        "event kw2 level1",
        "event kw2 level2"
      ]
    }
  ],
  "QueryLogic": 1,
  "SortingOrder": 1
}

application/xml, text/xml

Sample:
<PageQueryParam xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Dartfish.WebAPI.Models">
  <EventKeywords>
    <Keyword>
      <Values xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>event kw1 level1</d4p1:string>
        <d4p1:string>event kw1 level2</d4p1:string>
      </Values>
    </Keyword>
    <Keyword>
      <Values xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>event kw2 level1</d4p1:string>
        <d4p1:string>event kw2 level2</d4p1:string>
      </Values>
    </Keyword>
  </EventKeywords>
  <QueryLogic>And</QueryLogic>
  <SortingOrder>MostRecent</SortingOrder>
  <VideoKeywords>
    <Keyword>
      <Values xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>video kw1 level1</d4p1:string>
        <d4p1:string>video kw1 level2</d4p1:string>
      </Values>
    </Keyword>
    <Keyword>
      <Values xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>video kw2 level1</d4p1:string>
        <d4p1:string>video kw2 level2</d4p1:string>
      </Values>
    </Keyword>
  </VideoKeywords>
  <EndIndex>1</EndIndex>
  <StartIndex>0</StartIndex>
</PageQueryParam>

Response Information

Resource Description

Paged list of videos with ALL Keywords in the given collection

VideoInfoListResponse
NameDescriptionTypeAdditional information
VideoInfoList

Collection of VideoInfo

None.

TotalVideosCount

Total videos count corresponding to the query. Can be used to determine pages count.

integer

None.

ApiVersion

string

None.

Response Formats

application/json, text/json

Sample:
{
  "VideoInfoList": [
    {
      "Id": 10,
      "CollectionId": 2,
      "ChannelId": 3,
      "Name": "Video title 1",
      "Thumbnail": null,
      "Link": "http://www.dartfish.tv/Player?CR=p3c2m10",
      "CreationDate": "2021-09-28T00:10:25.0060701Z",
      "ModifiedDate": "2021-09-28T00:10:25.0060701Z",
      "Duration": 1000000
    },
    {
      "Id": 11,
      "CollectionId": 2,
      "ChannelId": 3,
      "Name": "Video title 2",
      "Thumbnail": null,
      "Link": "http://www.dartfish.tv/Player?CR=p3c2m11",
      "CreationDate": "2021-09-28T00:10:25.0060701Z",
      "ModifiedDate": "2021-09-28T00:10:25.0060701Z",
      "Duration": 100000
    }
  ],
  "TotalVideosCount": 50,
  "ApiVersion": "1.0"
}

application/xml, text/xml

Sample:
<VideoInfoListResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Dartfish.WebAPI.Models">
  <ApiVersion>1.0</ApiVersion>
  <TotalVideosCount>50</TotalVideosCount>
  <VideoInfoList>
    <VideoInfo>
      <ChannelId>3</ChannelId>
      <CollectionId>2</CollectionId>
      <CreationDate>2021-09-28T00:10:25.0060701Z</CreationDate>
      <Duration>1000000</Duration>
      <Id>10</Id>
      <Link>http://www.dartfish.tv/Player?CR=p3c2m10</Link>
      <ModifiedDate>2021-09-28T00:10:25.0060701Z</ModifiedDate>
      <Name>Video title 1</Name>
      <Thumbnail i:nil="true" />
    </VideoInfo>
    <VideoInfo>
      <ChannelId>3</ChannelId>
      <CollectionId>2</CollectionId>
      <CreationDate>2021-09-28T00:10:25.0060701Z</CreationDate>
      <Duration>100000</Duration>
      <Id>11</Id>
      <Link>http://www.dartfish.tv/Player?CR=p3c2m11</Link>
      <ModifiedDate>2021-09-28T00:10:25.0060701Z</ModifiedDate>
      <Name>Video title 2</Name>
      <Thumbnail i:nil="true" />
    </VideoInfo>
  </VideoInfoList>
</VideoInfoListResponse>