POST api/video/v{version}/{collectionId}/{videoId}/EventInfoList

Return all events of the given video.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
collectionId

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

integer

Required

videoId

ID of the specific video

integer

Required

version

string

None.

Body Parameters

None.

Response Information

Resource Description

Paged list of events with ALL Keywords in the given video

EventInfoListResponse
NameDescriptionTypeAdditional information
EventInfoList

Collection of EventInfo

None.

TotalEventsCount

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

integer

None.

ApiVersion

string

None.

Response Formats

application/json, text/json

Sample:
{
  "EventInfoList": [
    {
      "Id": 10,
      "SceneId": 1,
      "VideoId": 2,
      "CollectionId": 0,
      "Name": "Event title 1 ",
      "Thumbnail": "http://media.dartfish.tv/thumbnail",
      "Link": "http://www.dartfish.tv/Player?CR=p3c2m1",
      "CreationDate": "2021-06-14T05:59:14.4096516Z",
      "Position": 5000000,
      "Duration": 1000000
    },
    {
      "Id": 11,
      "SceneId": 1,
      "VideoId": 2,
      "CollectionId": 0,
      "Name": "Event title 2",
      "Thumbnail": "http://media.dartfish.tv/thumbnail",
      "Link": "http://www.dartfish.tv/Player?CR=p3c2m1",
      "CreationDate": "2021-06-14T05:59:14.4096516Z",
      "Position": 5000000,
      "Duration": 1000000
    }
  ],
  "TotalEventsCount": 50,
  "ApiVersion": "1.0"
}

application/xml, text/xml

Sample:
<EventInfoListResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Dartfish.WebAPI.Models">
  <ApiVersion>1.0</ApiVersion>
  <EventInfoList>
    <EventInfo>
      <CollectionId>0</CollectionId>
      <CreationDate>2021-06-14T05:59:14.4096516Z</CreationDate>
      <Duration>1000000</Duration>
      <Id>10</Id>
      <Link>http://www.dartfish.tv/Player?CR=p3c2m1</Link>
      <Name>Event title 1 </Name>
      <Position>5000000</Position>
      <SceneId>1</SceneId>
      <Thumbnail>http://media.dartfish.tv/thumbnail</Thumbnail>
      <VideoId>2</VideoId>
    </EventInfo>
    <EventInfo>
      <CollectionId>0</CollectionId>
      <CreationDate>2021-06-14T05:59:14.4096516Z</CreationDate>
      <Duration>1000000</Duration>
      <Id>11</Id>
      <Link>http://www.dartfish.tv/Player?CR=p3c2m1</Link>
      <Name>Event title 2</Name>
      <Position>5000000</Position>
      <SceneId>1</SceneId>
      <Thumbnail>http://media.dartfish.tv/thumbnail</Thumbnail>
      <VideoId>2</VideoId>
    </EventInfo>
  </EventInfoList>
  <TotalEventsCount>50</TotalEventsCount>
</EventInfoListResponse>