ASH.ResourceLibrary.WebApi

<back to all web services

ResourceItemRequest

Requires Authentication
The following routes are available for this service:
GET/resourceItems/{ResourceItemId}Use to get a specific Resource Item
ResourceItemRequest Parameters:
NameParameterData TypeRequiredDescription
ChunkIdquerystringNo
IncludeCompletionStatusqueryboolNo
IncludeContentqueryboolNo
ResourceItemIdpathstringNo
BasicResourceLibraryRequest Parameters:
NameParameterData TypeRequiredDescription
ResourceLibraryMemberIdformintNo
ResourceItemResponse Parameters:
NameParameterData TypeRequiredDescription
ResourceItemformResourceItemNo
ResourceItem Parameters:
NameParameterData TypeRequiredDescription
ContentformstringNo
CreditformstringNo
ReferencesformstringNo
DisclaimerformstringNo
HeaderImageformstringNo
OriginformstringNo
OriginIdformstringNo
TagsformList<Tag>No
CategoriesformList<Category>No
IndexformintNo
ActivityLevelformstringNo
ActivityDetailsformstringNo
TranscriptformstringNo
IsArchivedformboolNo
ActivitiesformList<ActivityItem>No
SeriesItemsformList<SeriesItem>No
VideoIdformstringNo
FocusformstringNo
SeriesformstringNo
SeriesUrlformstringNo
CategoryformstringNo
EquipmentsformList<string>No
DurationRangeformstringNo
ProviderNameformstringNo
UploadDateformstringNo
CompletionDateformDateTime?No
LevelformstringNo
BodyFocusformstringNo
AltMediaPathsformAltMediaPathsNo
SubtitlesformstringNo
DrmEncryptedformboolNo
ScreenshotsformList<ScreenshotItem>No
ResourceCard Parameters:
NameParameterData TypeRequiredDescription
IdformstringNo
TitleformstringNo
DescriptionformstringNo
DescriptionSummaryformstringNo
TypeformstringNo
ContentformstringNo
IsCompleteformboolNo
IsFavoriteformboolNo
IsImplicitlyCompleteformboolNo
MediaPathformstringNo
IsConfirmableformboolNo
IsWcagCompliantformboolNo
DurationformstringNo
PreviewformstringNo
CaloriesformintNo
InstructorformstringNo
ThumbnailformstringNo
DifficultyformstringNo
TagsformList<Tag>No
SubtitlesformstringNo
ScreenshotsformList<ScreenshotItem>No
DrmEncryptedformboolNo
Tag Parameters:
NameParameterData TypeRequiredDescription
IdformstringNo
TitleformstringNo
ScreenshotItem Parameters:
NameParameterData TypeRequiredDescription
LargeFilepathS3formstringNo
ThumbFilepathS3formstringNo
OrderformdecimalNo
DescriptionformstringNo
Category Parameters:
NameParameterData TypeRequiredDescription
IdformstringNo
SubtopicItemsformICollection<SubTopic>No
ResourceItemsformICollection<ResourceItem>No
TitleformstringNo
IsVisibleformstringNo
ResourceCountformintNo
SubTopic Parameters:
NameParameterData TypeRequiredDescription
IdformstringNo
TitleformstringNo
ResourceCountformintNo
ResourceItemsformICollection<ResourceItem>No
ActivityItem Parameters:
NameParameterData TypeRequiredDescription
NameformstringNo
IdformstringNo
SeriesItem Parameters:
NameParameterData TypeRequiredDescription
IdformstringNo
TitleformstringNo
AltMediaPaths Parameters:
NameParameterData TypeRequiredDescription
WebmformstringNo
OgvformstringNo
Mp4LowformstringNo
Mp4HighformstringNo

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

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /resourceItems/{ResourceItemId} HTTP/1.1 
Host: resourcelibrary.api.ashcompanies.com 
Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"resourceItem":{"content":"String","credit":"String","references":"String","disclaimer":"String","headerImage":"String","origin":"String","originId":"String","tags":[{"id":"String","title":"String"}],"categories":[{"id":"String","subtopicItems":null,"resourceItems":null,"title":"String","isVisible":"String","resourceCount":0}],"index":0,"activityLevel":"String","activityDetails":"String","transcript":"String","isArchived":false,"activities":[{"name":"String","id":"String"}],"seriesItems":[{"id":"String","title":"String"}],"videoId":"String","focus":"String","series":"String","seriesUrl":"String","category":"String","equipments":["String"],"durationRange":"String","providerName":"String","uploadDate":"String","completionDate":"0001-01-01T00:00:00.0000000","level":"String","bodyFocus":"String","altMediaPaths":{"webm":"String","ogv":"String","mp4Low":"String","mp4High":"String"},"subtitles":"String","drmEncrypted":false,"screenshots":[{"largeFilepathS3":"String","thumbFilepathS3":"String","order":0,"description":"String"}],"id":"String","title":"String","description":"String","descriptionSummary":"String","type":"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"}}