GET api/ShotClass?searchText={searchText}&isTopicEnabled={isTopicEnabled}

Request Information

URI Parameters

Name	Description	Type	Additional information
searchText		string	Required
isTopicEnabled		boolean	Required

Body Parameters

None.

Response Information

Resource Description

Collection of GlobalSearch

Name	Type	Additional information
ShotClassId	integer	None.
ShotClassName	string	None.
ShotClassImageUrl	string	None.
ShotClassDescription	string	None.
ShotClassKeyLearning	string	None.
ShotClassPublishedDate	string	None.
ShotClassType	ShotClassType	None.
Mediatype	ShotClassMediatype	None.
ShotClassTypeName	string	None.
ProgramId	integer	None.
ProgramName	string	None.
ProgramImageUrl	string	None.
ProgramDescription	string	None.
ProgramKeyLearning	string	None.
ProgramIsPublished	boolean	None.
TopicId	integer	None.
TopicName	string	None.
TopicImageUrl	string	None.
TopicDescription	string	None.
TopicKeyLearning	string	None.
TopicIsPublished	boolean	None.
ResponseType	ResponseType	None.
IsUserCompleted	boolean	None.
IsClassFavourite	boolean	None.
IsSeriesFavourite	boolean	None.
IsTopicFavourite	boolean	None.
CompletionStatus	integer	None.
Language	string	None.
TrainingType	integer	None.
VideoUrl	string	None.
AssetId	string	None.
VideoPlayedDuration	time interval	None.
VideoDuration	time interval	None.
ShotclassTags	string	None.
HasCertificate	boolean	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "ShotClassId": 1,
    "ShotClassName": "sample string 2",
    "ShotClassImageUrl": "sample string 3",
    "ShotClassDescription": "sample string 4",
    "ShotClassKeyLearning": "sample string 5",
    "ShotClassPublishedDate": "sample string 6",
    "ShotClassType": 0,
    "Mediatype": 0,
    "ShotClassTypeName": "sample string 7",
    "ProgramId": 8,
    "ProgramName": "sample string 9",
    "ProgramImageUrl": "sample string 10",
    "ProgramDescription": "sample string 11",
    "ProgramKeyLearning": "sample string 12",
    "ProgramIsPublished": true,
    "TopicId": 14,
    "TopicName": "sample string 15",
    "TopicImageUrl": "sample string 16",
    "TopicDescription": "sample string 17",
    "TopicKeyLearning": "sample string 18",
    "TopicIsPublished": true,
    "ResponseType": 1,
    "IsUserCompleted": true,
    "IsClassFavourite": true,
    "IsSeriesFavourite": true,
    "IsTopicFavourite": true,
    "CompletionStatus": 24,
    "Language": "sample string 25",
    "TrainingType": 26,
    "VideoUrl": "sample string 27",
    "AssetId": "sample string 28",
    "VideoPlayedDuration": "00:00:00.1234567",
    "VideoDuration": "00:00:00.1234567",
    "ShotclassTags": "sample string 29",
    "HasCertificate": true
  },
  {
    "ShotClassId": 1,
    "ShotClassName": "sample string 2",
    "ShotClassImageUrl": "sample string 3",
    "ShotClassDescription": "sample string 4",
    "ShotClassKeyLearning": "sample string 5",
    "ShotClassPublishedDate": "sample string 6",
    "ShotClassType": 0,
    "Mediatype": 0,
    "ShotClassTypeName": "sample string 7",
    "ProgramId": 8,
    "ProgramName": "sample string 9",
    "ProgramImageUrl": "sample string 10",
    "ProgramDescription": "sample string 11",
    "ProgramKeyLearning": "sample string 12",
    "ProgramIsPublished": true,
    "TopicId": 14,
    "TopicName": "sample string 15",
    "TopicImageUrl": "sample string 16",
    "TopicDescription": "sample string 17",
    "TopicKeyLearning": "sample string 18",
    "TopicIsPublished": true,
    "ResponseType": 1,
    "IsUserCompleted": true,
    "IsClassFavourite": true,
    "IsSeriesFavourite": true,
    "IsTopicFavourite": true,
    "CompletionStatus": 24,
    "Language": "sample string 25",
    "TrainingType": 26,
    "VideoUrl": "sample string 27",
    "AssetId": "sample string 28",
    "VideoPlayedDuration": "00:00:00.1234567",
    "VideoDuration": "00:00:00.1234567",
    "ShotclassTags": "sample string 29",
    "HasCertificate": true
  }
]

text/html

Sample:

[{"ShotClassId":1,"ShotClassName":"sample string 2","ShotClassImageUrl":"sample string 3","ShotClassDescription":"sample string 4","ShotClassKeyLearning":"sample string 5","ShotClassPublishedDate":"sample string 6","ShotClassType":0,"Mediatype":0,"ShotClassTypeName":"sample string 7","ProgramId":8,"ProgramName":"sample string 9","ProgramImageUrl":"sample string 10","ProgramDescription":"sample string 11","ProgramKeyLearning":"sample string 12","ProgramIsPublished":true,"TopicId":14,"TopicName":"sample string 15","TopicImageUrl":"sample string 16","TopicDescription":"sample string 17","TopicKeyLearning":"sample string 18","TopicIsPublished":true,"ResponseType":1,"IsUserCompleted":true,"IsClassFavourite":true,"IsSeriesFavourite":true,"IsTopicFavourite":true,"CompletionStatus":24,"Language":"sample string 25","TrainingType":26,"VideoUrl":"sample string 27","AssetId":"sample string 28","VideoPlayedDuration":"00:00:00.1234567","VideoDuration":"00:00:00.1234567","ShotclassTags":"sample string 29","HasCertificate":true},{"ShotClassId":1,"ShotClassName":"sample string 2","ShotClassImageUrl":"sample string 3","ShotClassDescription":"sample string 4","ShotClassKeyLearning":"sample string 5","ShotClassPublishedDate":"sample string 6","ShotClassType":0,"Mediatype":0,"ShotClassTypeName":"sample string 7","ProgramId":8,"ProgramName":"sample string 9","ProgramImageUrl":"sample string 10","ProgramDescription":"sample string 11","ProgramKeyLearning":"sample string 12","ProgramIsPublished":true,"TopicId":14,"TopicName":"sample string 15","TopicImageUrl":"sample string 16","TopicDescription":"sample string 17","TopicKeyLearning":"sample string 18","TopicIsPublished":true,"ResponseType":1,"IsUserCompleted":true,"IsClassFavourite":true,"IsSeriesFavourite":true,"IsTopicFavourite":true,"CompletionStatus":24,"Language":"sample string 25","TrainingType":26,"VideoUrl":"sample string 27","AssetId":"sample string 28","VideoPlayedDuration":"00:00:00.1234567","VideoDuration":"00:00:00.1234567","ShotclassTags":"sample string 29","HasCertificate":true}]

text/xml

Sample:

<ArrayOfGlobalSearch xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ShotClassCore.Models">
  <GlobalSearch>
    <AssetId>sample string 28</AssetId>
    <CompletionStatus>24</CompletionStatus>
    <HasCertificate>true</HasCertificate>
    <IsClassFavourite>true</IsClassFavourite>
    <IsSeriesFavourite>true</IsSeriesFavourite>
    <IsTopicFavourite>true</IsTopicFavourite>
    <IsUserCompleted>true</IsUserCompleted>
    <Language>sample string 25</Language>
    <Mediatype>NoContent</Mediatype>
    <ProgramDescription>sample string 11</ProgramDescription>
    <ProgramId>8</ProgramId>
    <ProgramImageUrl>sample string 10</ProgramImageUrl>
    <ProgramIsPublished>true</ProgramIsPublished>
    <ProgramKeyLearning>sample string 12</ProgramKeyLearning>
    <ProgramName>sample string 9</ProgramName>
    <ResponseType>ShotClass</ResponseType>
    <ShotClassDescription>sample string 4</ShotClassDescription>
    <ShotClassId>1</ShotClassId>
    <ShotClassImageUrl>sample string 3</ShotClassImageUrl>
    <ShotClassKeyLearning>sample string 5</ShotClassKeyLearning>
    <ShotClassName>sample string 2</ShotClassName>
    <ShotClassPublishedDate>sample string 6</ShotClassPublishedDate>
    <ShotClassType>InValid</ShotClassType>
    <ShotClassTypeName>sample string 7</ShotClassTypeName>
    <ShotclassTags>sample string 29</ShotclassTags>
    <TopicDescription>sample string 17</TopicDescription>
    <TopicId>14</TopicId>
    <TopicImageUrl>sample string 16</TopicImageUrl>
    <TopicIsPublished>true</TopicIsPublished>
    <TopicKeyLearning>sample string 18</TopicKeyLearning>
    <TopicName>sample string 15</TopicName>
    <TrainingType>26</TrainingType>
    <VideoDuration>PT0.1234567S</VideoDuration>
    <VideoPlayedDuration>PT0.1234567S</VideoPlayedDuration>
    <VideoUrl>sample string 27</VideoUrl>
  </GlobalSearch>
  <GlobalSearch>
    <AssetId>sample string 28</AssetId>
    <CompletionStatus>24</CompletionStatus>
    <HasCertificate>true</HasCertificate>
    <IsClassFavourite>true</IsClassFavourite>
    <IsSeriesFavourite>true</IsSeriesFavourite>
    <IsTopicFavourite>true</IsTopicFavourite>
    <IsUserCompleted>true</IsUserCompleted>
    <Language>sample string 25</Language>
    <Mediatype>NoContent</Mediatype>
    <ProgramDescription>sample string 11</ProgramDescription>
    <ProgramId>8</ProgramId>
    <ProgramImageUrl>sample string 10</ProgramImageUrl>
    <ProgramIsPublished>true</ProgramIsPublished>
    <ProgramKeyLearning>sample string 12</ProgramKeyLearning>
    <ProgramName>sample string 9</ProgramName>
    <ResponseType>ShotClass</ResponseType>
    <ShotClassDescription>sample string 4</ShotClassDescription>
    <ShotClassId>1</ShotClassId>
    <ShotClassImageUrl>sample string 3</ShotClassImageUrl>
    <ShotClassKeyLearning>sample string 5</ShotClassKeyLearning>
    <ShotClassName>sample string 2</ShotClassName>
    <ShotClassPublishedDate>sample string 6</ShotClassPublishedDate>
    <ShotClassType>InValid</ShotClassType>
    <ShotClassTypeName>sample string 7</ShotClassTypeName>
    <ShotclassTags>sample string 29</ShotclassTags>
    <TopicDescription>sample string 17</TopicDescription>
    <TopicId>14</TopicId>
    <TopicImageUrl>sample string 16</TopicImageUrl>
    <TopicIsPublished>true</TopicIsPublished>
    <TopicKeyLearning>sample string 18</TopicKeyLearning>
    <TopicName>sample string 15</TopicName>
    <TrainingType>26</TrainingType>
    <VideoDuration>PT0.1234567S</VideoDuration>
    <VideoPlayedDuration>PT0.1234567S</VideoPlayedDuration>
    <VideoUrl>sample string 27</VideoUrl>
  </GlobalSearch>
</ArrayOfGlobalSearch>