GET api/v3/SemanticSearchs/autocomplete?query={query}
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| query | string |
Required |
Body Parameters
None.
Response Information
Resource Description
SemanticSearchAutoComplete| Name | Description | Type | Additional information |
|---|---|---|---|
| suggestions | SemanticSearchSuggestionResults |
None. |
|
| totalResultsFound | integer |
None. |
|
| queryString | string |
None. |
|
| returnedRows | integer |
None. |
|
| startIndex | integer |
None. |
|
| suggestion | Collection of string |
None. |
|
| results | Collection of SearchClassDetails |
None. |
Response Formats
application/json, text/json
Sample:
{
"suggestions": {
"Suggestions": [
"sample string 1",
"sample string 2"
],
"nameSuggestions": [
"sample string 1",
"sample string 2"
],
"tagSuggestions": [
"sample string 1",
"sample string 2"
],
"bodySuggestions": [
"sample string 1",
"sample string 2"
]
},
"totalResultsFound": 1,
"queryString": "sample string 2",
"returnedRows": 3,
"startIndex": 4,
"suggestion": [
"sample string 1",
"sample string 2"
],
"results": [
{
"course_id": "sample string 1",
"course_type": "sample string 2",
"courseType": "sample string 3",
"content_body": "sample string 4",
"name": "sample string 5",
"file_name": "sample string 6",
"thumbnailURL": "sample string 7",
"section_id": "sample string 8",
"ranking": 9,
"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
},
"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"
]
}
}
]
},
{
"course_id": "sample string 1",
"course_type": "sample string 2",
"courseType": "sample string 3",
"content_body": "sample string 4",
"name": "sample string 5",
"file_name": "sample string 6",
"thumbnailURL": "sample string 7",
"section_id": "sample string 8",
"ranking": 9,
"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
},
"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"
]
}
}
]
}
]
}
text/html
Sample:
{"suggestions":{"Suggestions":["sample string 1","sample string 2"],"nameSuggestions":["sample string 1","sample string 2"],"tagSuggestions":["sample string 1","sample string 2"],"bodySuggestions":["sample string 1","sample string 2"]},"totalResultsFound":1,"queryString":"sample string 2","returnedRows":3,"startIndex":4,"suggestion":["sample string 1","sample string 2"],"results":[{"course_id":"sample string 1","course_type":"sample string 2","courseType":"sample string 3","content_body":"sample string 4","name":"sample string 5","file_name":"sample string 6","thumbnailURL":"sample string 7","section_id":"sample string 8","ranking":9,"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},"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"]}}]},{"course_id":"sample string 1","course_type":"sample string 2","courseType":"sample string 3","content_body":"sample string 4","name":"sample string 5","file_name":"sample string 6","thumbnailURL":"sample string 7","section_id":"sample string 8","ranking":9,"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},"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"]}}]}]}
text/xml
Sample:
<SemanticSearchAutoComplete xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ShotClassCore.Models">
<queryString>sample string 2</queryString>
<results>
<SearchClassDetails>
<content_body>sample string 4</content_body>
<courseType>sample string 3</courseType>
<course_id>sample string 1</course_id>
<course_type>sample string 2</course_type>
<file_name>sample string 6</file_name>
<name>sample string 5</name>
<ranking>9</ranking>
<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 8</section_id>
<sections>
<sections>
<contentBody>sample string 3</contentBody>
<content_body>sample string 2</content_body>
<fields_matched xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d6p1:string>sample string 1</d6p1:string>
<d6p1:string>sample string 2</d6p1: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:d7p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d7p1:string>sample string 1</d7p1:string>
<d7p1:string>sample string 2</d7p1: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:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d6p1:string>sample string 1</d6p1:string>
<d6p1:string>sample string 2</d6p1:string>
</section_tags>
<snippet>
<content_body xmlns:d7p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d7p1:string>sample string 1</d7p1:string>
<d7p1:string>sample string 2</d7p1:string>
</content_body>
<name xmlns:d7p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d7p1:string>sample string 1</d7p1:string>
<d7p1:string>sample string 2</d7p1:string>
</name>
</snippet>
</sections>
<sections>
<contentBody>sample string 3</contentBody>
<content_body>sample string 2</content_body>
<fields_matched xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d6p1:string>sample string 1</d6p1:string>
<d6p1:string>sample string 2</d6p1: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:d7p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d7p1:string>sample string 1</d7p1:string>
<d7p1:string>sample string 2</d7p1: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:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d6p1:string>sample string 1</d6p1:string>
<d6p1:string>sample string 2</d6p1:string>
</section_tags>
<snippet>
<content_body xmlns:d7p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d7p1:string>sample string 1</d7p1:string>
<d7p1:string>sample string 2</d7p1:string>
</content_body>
<name xmlns:d7p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d7p1:string>sample string 1</d7p1:string>
<d7p1:string>sample string 2</d7p1:string>
</name>
</snippet>
</sections>
</sections>
<thumbnailURL>sample string 7</thumbnailURL>
</SearchClassDetails>
<SearchClassDetails>
<content_body>sample string 4</content_body>
<courseType>sample string 3</courseType>
<course_id>sample string 1</course_id>
<course_type>sample string 2</course_type>
<file_name>sample string 6</file_name>
<name>sample string 5</name>
<ranking>9</ranking>
<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 8</section_id>
<sections>
<sections>
<contentBody>sample string 3</contentBody>
<content_body>sample string 2</content_body>
<fields_matched xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d6p1:string>sample string 1</d6p1:string>
<d6p1:string>sample string 2</d6p1: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:d7p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d7p1:string>sample string 1</d7p1:string>
<d7p1:string>sample string 2</d7p1: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:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d6p1:string>sample string 1</d6p1:string>
<d6p1:string>sample string 2</d6p1:string>
</section_tags>
<snippet>
<content_body xmlns:d7p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d7p1:string>sample string 1</d7p1:string>
<d7p1:string>sample string 2</d7p1:string>
</content_body>
<name xmlns:d7p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d7p1:string>sample string 1</d7p1:string>
<d7p1:string>sample string 2</d7p1:string>
</name>
</snippet>
</sections>
<sections>
<contentBody>sample string 3</contentBody>
<content_body>sample string 2</content_body>
<fields_matched xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d6p1:string>sample string 1</d6p1:string>
<d6p1:string>sample string 2</d6p1: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:d7p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d7p1:string>sample string 1</d7p1:string>
<d7p1:string>sample string 2</d7p1: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:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d6p1:string>sample string 1</d6p1:string>
<d6p1:string>sample string 2</d6p1:string>
</section_tags>
<snippet>
<content_body xmlns:d7p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d7p1:string>sample string 1</d7p1:string>
<d7p1:string>sample string 2</d7p1:string>
</content_body>
<name xmlns:d7p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d7p1:string>sample string 1</d7p1:string>
<d7p1:string>sample string 2</d7p1:string>
</name>
</snippet>
</sections>
</sections>
<thumbnailURL>sample string 7</thumbnailURL>
</SearchClassDetails>
</results>
<returnedRows>3</returnedRows>
<startIndex>4</startIndex>
<suggestion xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>sample string 1</d2p1:string>
<d2p1:string>sample string 2</d2p1:string>
</suggestion>
<totalResultsFound>1</totalResultsFound>
<suggestions>
<Suggestions xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d3p1:string>sample string 1</d3p1:string>
<d3p1:string>sample string 2</d3p1:string>
</Suggestions>
<bodySuggestions xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d3p1:string>sample string 1</d3p1:string>
<d3p1:string>sample string 2</d3p1:string>
</bodySuggestions>
<nameSuggestions xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d3p1:string>sample string 1</d3p1:string>
<d3p1:string>sample string 2</d3p1:string>
</nameSuggestions>
<tagSuggestions xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d3p1:string>sample string 1</d3p1:string>
<d3p1:string>sample string 2</d3p1:string>
</tagSuggestions>
</suggestions>
</SemanticSearchAutoComplete>