GET,POST | /favorites | Use to get a list Resource Items |
---|
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
DigitalFitness | body | bool | No | Set it to true if requesting saved resources only from digital library |
HealthLibrary | body | bool | No | Set it to true if requesting saved resources only from health library |
Vptr | body | bool | No | Set it to true if requesting saved resources only from vptr |
Wellbeing | body | bool | No | Set it to true if requesting saved resources only from wellbeing |
Health | body | bool | No | Set it to true if requesting saved resources only from health |
Limit | body | string | No | |
Offset | body | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
ResourceLibraryMemberId | form | int | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
ResourceItems | form | List<ResourceCard> | No | |
Meta | form | Meta | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Id | form | string | No | |
Title | form | string | No | |
Description | form | string | No | |
DescriptionSummary | form | string | No | |
Type | form | string | No | |
Content | form | string | No | |
IsComplete | form | bool | No | |
IsFavorite | form | bool | No | |
IsImplicitlyComplete | form | bool | No | |
MediaPath | form | string | No | |
IsConfirmable | form | bool | No | |
IsWcagCompliant | form | bool | No | |
Duration | form | string | No | |
Preview | form | string | No | |
Calories | form | int | No | |
Instructor | form | string | No | |
Thumbnail | form | string | No | |
Difficulty | form | string | No | |
Tags | form | List<Tag> | No | |
Subtitles | form | string | No | |
Screenshots | form | List<ScreenshotItem> | No | |
DrmEncrypted | form | bool | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Id | form | string | No | |
Title | form | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
LargeFilepathS3 | form | string | No | |
ThumbFilepathS3 | form | string | No | |
Order | form | decimal | No | |
Description | form | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
ResourceCount | form | int | 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.
POST /favorites HTTP/1.1
Host: resourcelibrary.api.ashcompanies.com
Accept: application/json
Content-Type: application/json
Content-Length: length
{"digitalFitness":false,"healthLibrary":false,"vptr":false,"wellbeing":false,"health":false,"limit":"String","offset":"String","resourceLibraryMemberId":0}
HTTP/1.1 200 OK Content-Type: application/json Content-Length: length {"resourceItems":[{"id":"String","title":"String","description":"String","descriptionSummary":"String","type":"String","content":"String","isComplete":false,"isFavorite":false,"isImplicitlyComplete":false,"mediaPath":"String","isConfirmable":false,"isWcagCompliant":false,"duration":"String","preview":"String","calories":0,"instructor":"String","thumbnail":"String","difficulty":"String","tags":[{"id":"String","title":"String"}],"subtitles":"String","screenshots":[{"largeFilepathS3":"String","thumbFilepathS3":"String","order":0,"description":"String"}],"drmEncrypted":false}],"meta":{"resourceCount":0,"title":"String"}}