POST Search/All

Search Videos, Courses, Teachers

Request Information

URI Parameters

None.

Body Parameters

RequestSearchAll
NameDescriptionTypeAdditional information
SearchString

Search keyword - minimum 3 characters

string

None.

Limit

Limit max numbers of results - ignored if 0

integer

None.

Request Formats

application/json, text/json

Sample:
{
  "SearchString": "sample string 1",
  "Limit": 2
}

text/html

Sample:
{"SearchString":"sample string 1","Limit":2}

application/xml, text/xml

Sample:
<RequestSearchAll xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/YogaStreamAPIv2">
  <Limit>2</Limit>
  <SearchString>sample string 1</SearchString>
</RequestSearchAll>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'RequestSearchAll'.

Response Information

Resource Description

Collection of SearchData
NameDescriptionTypeAdditional information
Type

1 = video, 2 = course, 3 = teacher

integer

None.

TypeID

integer

None.

Title

string

None.

Image

string

None.

Line1

string

None.

Line2

string

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "Type": 1,
    "TypeID": 2,
    "Title": "sample string 3",
    "Image": "sample string 4",
    "Line1": "sample string 5",
    "Line2": "sample string 6"
  },
  {
    "Type": 1,
    "TypeID": 2,
    "Title": "sample string 3",
    "Image": "sample string 4",
    "Line1": "sample string 5",
    "Line2": "sample string 6"
  }
]

text/html

Sample:
[{"Type":1,"TypeID":2,"Title":"sample string 3","Image":"sample string 4","Line1":"sample string 5","Line2":"sample string 6"},{"Type":1,"TypeID":2,"Title":"sample string 3","Image":"sample string 4","Line1":"sample string 5","Line2":"sample string 6"}]

application/xml, text/xml

Sample:
<ArrayOfSearchData xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/YogaStreamAPIv2">
  <SearchData>
    <Image>sample string 4</Image>
    <Line1>sample string 5</Line1>
    <Line2>sample string 6</Line2>
    <Title>sample string 3</Title>
    <Type>1</Type>
    <TypeID>2</TypeID>
  </SearchData>
  <SearchData>
    <Image>sample string 4</Image>
    <Line1>sample string 5</Line1>
    <Line2>sample string 6</Line2>
    <Title>sample string 3</Title>
    <Type>1</Type>
    <TypeID>2</TypeID>
  </SearchData>
</ArrayOfSearchData>