ASH.ResourceLibrary.WebApi

CategoriesRequest

The following routes are available for this service:
GET	/categories	Use to get Resource Library Categories list

**CategoriesRequest** Parameters:
Name	Parameter	Data Type	Required
IncludeCompletionStatus	query	bool	No
IncludeSubtopicItems	query	bool	No
IncludeResourceItems	query	bool	No

**BasicResourceLibraryRequest** Parameters:
Name	Parameter	Data Type	Required	Description
ResourceLibraryMemberId	form	int	No

**CategoriesResponse** Parameters:
Name	Parameter	Data Type	Required	Description
Categories	form	ICollection<Category>	No

**Category** Parameters:
Name	Parameter	Data Type	Required
Id	form	string	No
SubtopicItems	form	ICollection<SubTopic>	No
ResourceItems	form	ICollection<ResourceItem>	No
Title	form	string	No
IsVisible	form	string	No
ResourceCount	form	int	No

**SubTopic** Parameters:
Name	Parameter	Data Type	Required
Id	form	string	No
Title	form	string	No
ResourceCount	form	int	No
ResourceItems	form	ICollection<ResourceItem>	No

**ResourceItem** Parameters:
Name	Parameter	Data Type	Required
Content	form	string	No
Credit	form	string	No
References	form	string	No
Disclaimer	form	string	No
HeaderImage	form	string	No
Origin	form	string	No
OriginId	form	string	No
Tags	form	List<Tag>	No
Categories	form	List<Category>	No
Index	form	int	No
ActivityLevel	form	string	No
ActivityDetails	form	string	No
Transcript	form	string	No
IsArchived	form	bool	No
Activities	form	List<ActivityItem>	No
SeriesItems	form	List<SeriesItem>	No
VideoId	form	string	No
Focus	form	string	No
Series	form	string	No
SeriesUrl	form	string	No
Category	form	string	No
Equipments	form	List<string>	No
DurationRange	form	string	No
ProviderName	form	string	No
UploadDate	form	string	No
CompletionDate	form	DateTime?	No
Level	form	string	No
BodyFocus	form	string	No
AltMediaPaths	form	AltMediaPaths	No
Subtitles	form	string	No
DrmEncrypted	form	bool	No
Screenshots	form	List<ScreenshotItem>	No

**ResourceCard** Parameters:
Name	Parameter	Data Type	Required
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

**Tag** Parameters:
Name	Parameter	Data Type	Required	Description
Id	form	string	No
Title	form	string	No

**ScreenshotItem** Parameters:
Name	Parameter	Data Type	Required
LargeFilepathS3	form	string	No
ThumbFilepathS3	form	string	No
Order	form	decimal	No
Description	form	string	No

**ActivityItem** Parameters:
Name	Parameter	Data Type	Required	Description
Name	form	string	No
Id	form	string	No

**SeriesItem** Parameters:
Name	Parameter	Data Type	Required	Description
Id	form	string	No
Title	form	string	No

**AltMediaPaths** Parameters:
Name	Parameter	Data Type	Required
Webm	form	string	No
Ogv	form	string	No
Mp4Low	form	string	No
Mp4High	form	string	No

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

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

GET /categories HTTP/1.1 
Host: resourcelibrary.api.ashcompanies.com 
Accept: application/xml

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<CategoriesResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ASH.ResourceLibrary.Interfaces.ServiceModels">
  <Categories xmlns:d2p1="http://schemas.datacontract.org/2004/07/ASH.ResourceLibrary.Interfaces.Models" i:nil="true" />
</CategoriesResponse>