POST api/channel/v{version}/{channelId}/EventsLink

Return a link to all events with ALL Keywords in the given channel. List of displayed events depends on dartfish.tv access rights.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
channelId

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

integer

Required

version

string

None.

Body Parameters

Query parameters (keywords + logic)

QueryParam
NameDescriptionTypeAdditional information
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:
{
  "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:
<QueryParam 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>
</QueryParam>

Response Information

Resource Description

URL to all events with ALL Keywords in the given channel

LinkResponse
NameDescriptionTypeAdditional information
Link

string

None.

ApiVersion

string

None.

Response Formats

application/json, text/json

Sample:
{
  "Link": "http://www.dartfish.tv/...",
  "ApiVersion": "1.0"
}

application/xml, text/xml

Sample:
<LinkResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Dartfish.WebAPI.Models">
  <ApiVersion>1.0</ApiVersion>
  <Link>http://www.dartfish.tv/...</Link>
</LinkResponse>