POST api/v3/Tenants/semanticsearchs/shotclasses?apiKey={apiKey}

Request Information

URI Parameters

Name	Description	Type	Additional information
apiKey		string	Required

Body Parameters

SemanticSearchObj

Name	Type	Additional information
id	integer	None.
courseType	string	None.
name	string	None.
overview	string	None.
summary	string	None.
trainingType	string	None.
thumbnailURL	string	None.
tags	Collection of string	None.
contentBody	string	None.
contentQuiz	string	None.
contentSurvey	string	None.
fileName	string	None.
indexingRequired	boolean	None.
indexStatus	string	None.
lastTranscribed	string	None.
error	string	None.
languageCode	string	None.
videoURL	string	None.
sections	Collection of sections	None.
apiKey	string	None.
tenantIdOftheCourse	integer	None.
userTrancribeTheCourse	integer	None.

Request Formats

application/json, text/json

Sample:

{
  "id": 1,
  "courseType": "sample string 2",
  "name": "sample string 3",
  "overview": "sample string 4",
  "summary": "sample string 5",
  "trainingType": "sample string 6",
  "thumbnailURL": "sample string 7",
  "tags": [
    "sample string 1",
    "sample string 2"
  ],
  "contentBody": "sample string 8",
  "contentQuiz": "sample string 9",
  "contentSurvey": "sample string 10",
  "fileName": "sample string 11",
  "indexingRequired": true,
  "indexStatus": "sample string 13",
  "lastTranscribed": "sample string 14",
  "error": "sample string 15",
  "languageCode": "sample string 16",
  "videoURL": "sample string 17",
  "sections": [
    {
      "section_id": "sample string 1",
      "section_tags": [
        "sample string 1",
        "sample string 2"
      ],
      "fields_matched": [
        "sample string 1",
        "sample string 2"
      ],
      "section_details": {
        "start_time": 1,
        "section_tags": [
          "sample string 1",
          "sample string 2"
        ],
        "section_filename": "sample string 2",
        "end_time": 3,
        "slide_no": 4,
        "slide_id": 5,
        "page_no": 6
      },
      "content_body": "sample string 2",
      "contentBody": "sample string 3",
      "snippet": {
        "name": [
          "sample string 1",
          "sample string 2"
        ],
        "content_body": [
          "sample string 1",
          "sample string 2"
        ]
      }
    },
    {
      "section_id": "sample string 1",
      "section_tags": [
        "sample string 1",
        "sample string 2"
      ],
      "fields_matched": [
        "sample string 1",
        "sample string 2"
      ],
      "section_details": {
        "start_time": 1,
        "section_tags": [
          "sample string 1",
          "sample string 2"
        ],
        "section_filename": "sample string 2",
        "end_time": 3,
        "slide_no": 4,
        "slide_id": 5,
        "page_no": 6
      },
      "content_body": "sample string 2",
      "contentBody": "sample string 3",
      "snippet": {
        "name": [
          "sample string 1",
          "sample string 2"
        ],
        "content_body": [
          "sample string 1",
          "sample string 2"
        ]
      }
    }
  ],
  "apiKey": "sample string 18",
  "tenantIdOftheCourse": 19,
  "userTrancribeTheCourse": 20
}

text/html

Sample:

{"id":1,"courseType":"sample string 2","name":"sample string 3","overview":"sample string 4","summary":"sample string 5","trainingType":"sample string 6","thumbnailURL":"sample string 7","tags":["sample string 1","sample string 2"],"contentBody":"sample string 8","contentQuiz":"sample string 9","contentSurvey":"sample string 10","fileName":"sample string 11","indexingRequired":true,"indexStatus":"sample string 13","lastTranscribed":"sample string 14","error":"sample string 15","languageCode":"sample string 16","videoURL":"sample string 17","sections":[{"section_id":"sample string 1","section_tags":["sample string 1","sample string 2"],"fields_matched":["sample string 1","sample string 2"],"section_details":{"start_time":1,"section_tags":["sample string 1","sample string 2"],"section_filename":"sample string 2","end_time":3,"slide_no":4,"slide_id":5,"page_no":6},"content_body":"sample string 2","contentBody":"sample string 3","snippet":{"name":["sample string 1","sample string 2"],"content_body":["sample string 1","sample string 2"]}},{"section_id":"sample string 1","section_tags":["sample string 1","sample string 2"],"fields_matched":["sample string 1","sample string 2"],"section_details":{"start_time":1,"section_tags":["sample string 1","sample string 2"],"section_filename":"sample string 2","end_time":3,"slide_no":4,"slide_id":5,"page_no":6},"content_body":"sample string 2","contentBody":"sample string 3","snippet":{"name":["sample string 1","sample string 2"],"content_body":["sample string 1","sample string 2"]}}],"apiKey":"sample string 18","tenantIdOftheCourse":19,"userTrancribeTheCourse":20}

text/xml

Sample:

<SemanticSearchObj xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ShotClassCore.Models">
  <apiKey>sample string 18</apiKey>
  <contentBody>sample string 8</contentBody>
  <contentQuiz>sample string 9</contentQuiz>
  <contentSurvey>sample string 10</contentSurvey>
  <courseType>sample string 2</courseType>
  <error>sample string 15</error>
  <fileName>sample string 11</fileName>
  <id>1</id>
  <indexStatus>sample string 13</indexStatus>
  <indexingRequired>true</indexingRequired>
  <languageCode>sample string 16</languageCode>
  <lastTranscribed>sample string 14</lastTranscribed>
  <name>sample string 3</name>
  <overview>sample string 4</overview>
  <sections>
    <sections>
      <contentBody>sample string 3</contentBody>
      <content_body>sample string 2</content_body>
      <fields_matched xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
      </fields_matched>
      <section_details>
        <end_time>3</end_time>
        <page_no>6</page_no>
        <section_filename>sample string 2</section_filename>
        <section_tags xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:string>sample string 1</d5p1:string>
          <d5p1:string>sample string 2</d5p1:string>
        </section_tags>
        <slide_id>5</slide_id>
        <slide_no>4</slide_no>
        <start_time>1</start_time>
      </section_details>
      <section_id>sample string 1</section_id>
      <section_tags xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
      </section_tags>
      <snippet>
        <content_body xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:string>sample string 1</d5p1:string>
          <d5p1:string>sample string 2</d5p1:string>
        </content_body>
        <name xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:string>sample string 1</d5p1:string>
          <d5p1:string>sample string 2</d5p1:string>
        </name>
      </snippet>
    </sections>
    <sections>
      <contentBody>sample string 3</contentBody>
      <content_body>sample string 2</content_body>
      <fields_matched xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
      </fields_matched>
      <section_details>
        <end_time>3</end_time>
        <page_no>6</page_no>
        <section_filename>sample string 2</section_filename>
        <section_tags xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:string>sample string 1</d5p1:string>
          <d5p1:string>sample string 2</d5p1:string>
        </section_tags>
        <slide_id>5</slide_id>
        <slide_no>4</slide_no>
        <start_time>1</start_time>
      </section_details>
      <section_id>sample string 1</section_id>
      <section_tags xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
      </section_tags>
      <snippet>
        <content_body xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:string>sample string 1</d5p1:string>
          <d5p1:string>sample string 2</d5p1:string>
        </content_body>
        <name xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:string>sample string 1</d5p1:string>
          <d5p1:string>sample string 2</d5p1:string>
        </name>
      </snippet>
    </sections>
  </sections>
  <summary>sample string 5</summary>
  <tags xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </tags>
  <tenantIdOftheCourse>19</tenantIdOftheCourse>
  <thumbnailURL>sample string 7</thumbnailURL>
  <trainingType>sample string 6</trainingType>
  <userTrancribeTheCourse>20</userTrancribeTheCourse>
  <videoURL>sample string 17</videoURL>
</SemanticSearchObj>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

SemanticSearchObj

Name	Type	Additional information
id	integer	None.
courseType	string	None.
name	string	None.
overview	string	None.
summary	string	None.
trainingType	string	None.
thumbnailURL	string	None.
tags	Collection of string	None.
contentBody	string	None.
contentQuiz	string	None.
contentSurvey	string	None.
fileName	string	None.
indexingRequired	boolean	None.
indexStatus	string	None.
lastTranscribed	string	None.
error	string	None.
languageCode	string	None.
videoURL	string	None.
sections	Collection of sections	None.
apiKey	string	None.
tenantIdOftheCourse	integer	None.
userTrancribeTheCourse	integer	None.

Response Formats

application/json, text/json

Sample:

{
  "id": 1,
  "courseType": "sample string 2",
  "name": "sample string 3",
  "overview": "sample string 4",
  "summary": "sample string 5",
  "trainingType": "sample string 6",
  "thumbnailURL": "sample string 7",
  "tags": [
    "sample string 1",
    "sample string 2"
  ],
  "contentBody": "sample string 8",
  "contentQuiz": "sample string 9",
  "contentSurvey": "sample string 10",
  "fileName": "sample string 11",
  "indexingRequired": true,
  "indexStatus": "sample string 13",
  "lastTranscribed": "sample string 14",
  "error": "sample string 15",
  "languageCode": "sample string 16",
  "videoURL": "sample string 17",
  "sections": [
    {
      "section_id": "sample string 1",
      "section_tags": [
        "sample string 1",
        "sample string 2"
      ],
      "fields_matched": [
        "sample string 1",
        "sample string 2"
      ],
      "section_details": {
        "start_time": 1,
        "section_tags": [
          "sample string 1",
          "sample string 2"
        ],
        "section_filename": "sample string 2",
        "end_time": 3,
        "slide_no": 4,
        "slide_id": 5,
        "page_no": 6
      },
      "content_body": "sample string 2",
      "contentBody": "sample string 3",
      "snippet": {
        "name": [
          "sample string 1",
          "sample string 2"
        ],
        "content_body": [
          "sample string 1",
          "sample string 2"
        ]
      }
    },
    {
      "section_id": "sample string 1",
      "section_tags": [
        "sample string 1",
        "sample string 2"
      ],
      "fields_matched": [
        "sample string 1",
        "sample string 2"
      ],
      "section_details": {
        "start_time": 1,
        "section_tags": [
          "sample string 1",
          "sample string 2"
        ],
        "section_filename": "sample string 2",
        "end_time": 3,
        "slide_no": 4,
        "slide_id": 5,
        "page_no": 6
      },
      "content_body": "sample string 2",
      "contentBody": "sample string 3",
      "snippet": {
        "name": [
          "sample string 1",
          "sample string 2"
        ],
        "content_body": [
          "sample string 1",
          "sample string 2"
        ]
      }
    }
  ],
  "apiKey": "sample string 18",
  "tenantIdOftheCourse": 19,
  "userTrancribeTheCourse": 20
}

text/html

Sample:

{"id":1,"courseType":"sample string 2","name":"sample string 3","overview":"sample string 4","summary":"sample string 5","trainingType":"sample string 6","thumbnailURL":"sample string 7","tags":["sample string 1","sample string 2"],"contentBody":"sample string 8","contentQuiz":"sample string 9","contentSurvey":"sample string 10","fileName":"sample string 11","indexingRequired":true,"indexStatus":"sample string 13","lastTranscribed":"sample string 14","error":"sample string 15","languageCode":"sample string 16","videoURL":"sample string 17","sections":[{"section_id":"sample string 1","section_tags":["sample string 1","sample string 2"],"fields_matched":["sample string 1","sample string 2"],"section_details":{"start_time":1,"section_tags":["sample string 1","sample string 2"],"section_filename":"sample string 2","end_time":3,"slide_no":4,"slide_id":5,"page_no":6},"content_body":"sample string 2","contentBody":"sample string 3","snippet":{"name":["sample string 1","sample string 2"],"content_body":["sample string 1","sample string 2"]}},{"section_id":"sample string 1","section_tags":["sample string 1","sample string 2"],"fields_matched":["sample string 1","sample string 2"],"section_details":{"start_time":1,"section_tags":["sample string 1","sample string 2"],"section_filename":"sample string 2","end_time":3,"slide_no":4,"slide_id":5,"page_no":6},"content_body":"sample string 2","contentBody":"sample string 3","snippet":{"name":["sample string 1","sample string 2"],"content_body":["sample string 1","sample string 2"]}}],"apiKey":"sample string 18","tenantIdOftheCourse":19,"userTrancribeTheCourse":20}

text/xml

Sample:

<SemanticSearchObj xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ShotClassCore.Models">
  <apiKey>sample string 18</apiKey>
  <contentBody>sample string 8</contentBody>
  <contentQuiz>sample string 9</contentQuiz>
  <contentSurvey>sample string 10</contentSurvey>
  <courseType>sample string 2</courseType>
  <error>sample string 15</error>
  <fileName>sample string 11</fileName>
  <id>1</id>
  <indexStatus>sample string 13</indexStatus>
  <indexingRequired>true</indexingRequired>
  <languageCode>sample string 16</languageCode>
  <lastTranscribed>sample string 14</lastTranscribed>
  <name>sample string 3</name>
  <overview>sample string 4</overview>
  <sections>
    <sections>
      <contentBody>sample string 3</contentBody>
      <content_body>sample string 2</content_body>
      <fields_matched xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
      </fields_matched>
      <section_details>
        <end_time>3</end_time>
        <page_no>6</page_no>
        <section_filename>sample string 2</section_filename>
        <section_tags xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:string>sample string 1</d5p1:string>
          <d5p1:string>sample string 2</d5p1:string>
        </section_tags>
        <slide_id>5</slide_id>
        <slide_no>4</slide_no>
        <start_time>1</start_time>
      </section_details>
      <section_id>sample string 1</section_id>
      <section_tags xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
      </section_tags>
      <snippet>
        <content_body xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:string>sample string 1</d5p1:string>
          <d5p1:string>sample string 2</d5p1:string>
        </content_body>
        <name xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:string>sample string 1</d5p1:string>
          <d5p1:string>sample string 2</d5p1:string>
        </name>
      </snippet>
    </sections>
    <sections>
      <contentBody>sample string 3</contentBody>
      <content_body>sample string 2</content_body>
      <fields_matched xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
      </fields_matched>
      <section_details>
        <end_time>3</end_time>
        <page_no>6</page_no>
        <section_filename>sample string 2</section_filename>
        <section_tags xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:string>sample string 1</d5p1:string>
          <d5p1:string>sample string 2</d5p1:string>
        </section_tags>
        <slide_id>5</slide_id>
        <slide_no>4</slide_no>
        <start_time>1</start_time>
      </section_details>
      <section_id>sample string 1</section_id>
      <section_tags xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
      </section_tags>
      <snippet>
        <content_body xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:string>sample string 1</d5p1:string>
          <d5p1:string>sample string 2</d5p1:string>
        </content_body>
        <name xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:string>sample string 1</d5p1:string>
          <d5p1:string>sample string 2</d5p1:string>
        </name>
      </snippet>
    </sections>
  </sections>
  <summary>sample string 5</summary>
  <tags xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </tags>
  <tenantIdOftheCourse>19</tenantIdOftheCourse>
  <thumbnailURL>sample string 7</thumbnailURL>
  <trainingType>sample string 6</trainingType>
  <userTrancribeTheCourse>20</userTrancribeTheCourse>
  <videoURL>sample string 17</videoURL>
</SemanticSearchObj>