GET | /searchResults | Use to search Resource Items |
---|
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Request | query | string | No | |
Tags | query | List<string> | No | |
CategoryId | query | string | No | |
Offset | query | int | No | |
Limit | query | int | No | |
digitalFitness | query | bool | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
ResourceLibraryMemberId | form | int | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
SearchResults | form | SearchResult | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Id | form | string | No | |
ResourceItems | form | List<ResourceItemForSearch> | No | |
SearchItems | form | List<ResourceItemForSearch> | No | |
Tags | form | List<Tag> | No | |
ItemCount | form | long | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Id | form | string | No | |
Type | form | string | No | |
Categories | form | List<string> | No | |
CategoryIndexes | form | List<string> | No | |
Title | form | string | No | |
Description | form | string | No | |
DescriptionSummary | form | string | No | |
Content | form | string | No | |
Tags | form | List<string> | No | |
IsComplete | form | bool | No | |
IsFavorite | form | bool | No | |
IsImplicitlyComplete | form | bool | No | |
Transcript | form | string | No | |
Thumbnail | form | string | No | |
Difficulty | form | string | No | |
Duration | form | string | No | |
MediaPath | form | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Id | form | string | No | |
Title | form | string | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json
To embed the response in a jsonp callback, append ?callback=myCallback
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /searchResults HTTP/1.1 Host: resourcelibrary.api.ashcompanies.com Accept: application/json
HTTP/1.1 200 OK Content-Type: application/json Content-Length: length {"searchResults":{"id":"String","resourceItems":[{"id":"String","type":"String","categories":["String"],"categoryIndexes":["String"],"title":"String","description":"String","descriptionSummary":"String","content":"String","tags":["String"],"isComplete":false,"isFavorite":false,"isImplicitlyComplete":false,"transcript":"String","thumbnail":"String","difficulty":"String","duration":"String","mediaPath":"String"}],"searchItems":[{"id":"String","type":"String","categories":["String"],"categoryIndexes":["String"],"title":"String","description":"String","descriptionSummary":"String","content":"String","tags":["String"],"isComplete":false,"isFavorite":false,"isImplicitlyComplete":false,"transcript":"String","thumbnail":"String","difficulty":"String","duration":"String","mediaPath":"String"}],"tags":[{"id":"String","title":"String"}],"itemCount":0}}