This section will help understand the data that is being returned. Content is returned in a ContentList and is the root node of all returned XML. The order of the nodes in this schema is not guaranteed to be the same order each time. Not all methods will return all of this data but the purpose of each node and attribute remains the same.
- ContentList - The root node of the XML document.
- ContentObject - The primary node for a piece of content.
- ContentObjectType - The type of content. Currently there are only two types: Document and StreamingMedia.
- ViewCount - The number of times a ContentObject has been viewed by the license that made the request.
- ContentTypeId - The Business Unit Content Type Identifier. See ContentTypes for a complete list.
- ContentId - The Business Unit Content Identifier is a unique identifier within a content type set by the content owner. Note: The combination of ContentTypeId, ContentId, and Owner are used to uniquely identify a piece of content.
- IsCustom - An indicator stating if the content has been changed from the original version by the license. If true, the content has been changed from the original content.
- Owner - The owner of the content.
- Blocked - An indicator stating whether or not the content is blocked. If true, the content is marked as blocked and should not be display to the public.
- ContentObjectId - The primary identification of the content.
- CreatedDate - The date the content was created
- PublishedDate - The date the content was published. Note: If this attribute is missing then the content has not been published.
- RunningTime - The length of the StreamingMedia content. Note: This is only used for StreamingMedia object types.
- Language - The language of the content.
- RegularTitle - The primary title of the content.
- InvertedTitle - The regular title with the words rearranged to bring the primary focus to the front. i.e. "All About Asthma" would have an inverted title like "Asthma, All About". This is used to display titles in lists where the focus is listed together.
- Blurb - A short description, byline, abstract, teaser, etc., of the content
- Keywords - A semi-colon delimited list of words used to describe the content. These could be added to an HTML page's >meta name="keywords" ... /<, for example.
- GenderCode - The targeted gender of the content.
- Rating - The popularity of the content based on user feedback based on a scale from 1 to 5. These numbers are license based, they are not an aggregate of all ratings across all licenses. For example, if content X has been rated 10 times by users of license A, 20 times by users of license B, and 10 times by users of license C, when license B requests a piece of content it will only show the ratings for the 20 times its' users supplied, not the 40 total ratings supplied for the content.
- Total - The combined total of all the ratings from a license.
- Count - The number of times content has been rated by users of a license.
- Average - The calculated rating average by license.
- AgeGroups - The targeted audience of the content.
- CopyrightStatment - The copyright statement of the content.
- PostingDate - The date used by certain content to indicate when it was posted to the internet, versus when it was published in our repository.
- Body - The primary display portion of the ContentObject. This will contain a complete xHTML document that will need to be transformed into standard HTML.
- Disclaimer - The disclaimer statement of the content.
- ReadingLevel - The Gunning-Fog index that measures the readability of the content.
- Authors - A list of authors that have contributed to the content.
- OnlineEditors - A list of editors that have reviewed the content.
- OnlineMedialReviewers - A list of medical reviewers that have reviewed the content.
- PrintSoures - A list of print sources used in creating the content.
- AdditionalTitles - A list of additional titles for this content. These are useful when lists of content are displayed by title sorted alphabetically, but the regular and inverted titles are insufficient for thorough organization.
- OnlineSources - A list of online sources used in creating the content.
- URL - The fully qualified website address of the online source (ie. http://www.staywell.com).
- Node Value - A friendly name for the online source's URL.
- RecommendedSites - A list of sites recommended for further information on the topic(s) discussed in the content.
- URL - The fully qualified website address of the recommended site (ie. http://www.staywell.com).
- Node Value - A friendly name for the recommended site's URL.
- OtherLangauges - A list of the other language versions of this content.
- Formats - A list of the different versions available for a specific piece of StreamingMedia content. For each format available, the followind data is supplied:
- Name - The filename of the streaming media format.
- MimeType - The Multipurpose Internet Mail Extensions (MIME) type of the streaming media format.
- AudioKbps - The audio bitrate of the streaming media format, in kilobits per second. The higher the bitrate, the higher the audio quality. For reference, FM quality is roughly 96 kbit/s, while CD quality audio is encoded at 128 kbit/s.
- VideoKbps - The video bitrate of the streaming media format, in kilobits per second. The higher the bitrate, the higher the video quality. For reference, DVD quality is roughly 8Mbits/second, or 8000 Kbps.
- Height - The pixel height of the streaming media format. Ideally, the video player's height should match the streaming media object's height.
- Width - The pixel width of the streaming media format. Ideally, the video player's height should match the streaming media object's height.
Full schema and data type expected
<ContentList>
<ContentObject ViewCount="[int]" ContentTypeId="[int]" ContentId="[String]" IsCustom="[true, false]" Owner="[String]" Blocked="false" ContentObjectId="[int]" CreatedDate="[Date]" ContentObjectType="[Document, StreamingMedia]" PublishedDate="[Date]" RunningTime="[int]">
<Language Code="[aa,de,en,es,fa,fr,hmn,hy,it,km,ko,po,ru,so,tgl,vi,zh]" >
[Language Name (IE. English, Spanish, etc.)]
</Language>
<RegularTitle>[String]</RegularTitle>
<InvertedTitle>[String]</InvertedTitle>
<Blurb>[String with HTML]</Blurb>
<Keywords>
<Keyword>[String]</Keyword>
</Keywords>
<GenderCode>[A,M,F]</GenderCode>
<Rating Total="[int]" Count="[int]" Average="[int]" />
<AgeGroups>
<AgeGroup>[Infant (0 - 11 mo), Childhood (11 mo - 12 yrs), Teen (12 - 18 yrs), Adult (18+), Senior]</AgeGroup>
</AgeGroups>
<CopyrightStatement>[String]</CopyrightStatement>
<PostingDate>[Date}</PostingDate>
<Body>[ String with HTML]</Body>
<Transcript>[ String with HTML]</Transcript>
<Disclaimer>[String]</Disclaimer>
<ReadingLevel>[4-6, 6-7, 8-13]</ReadingLevel>
<Authors>
<AuthorName>[String]</AuthorName>
</Authors>
<OnlineEditors>
<OnlineEditorName>[String]</OnlineEditorName>
</OnlineEditors>
<OnlineMedicalReviewers>
<OnlineMedicalReviewerName>[String]</OnlineMedicalReviewerName>
</OnlineMedicalReviewers>
<PrintSources>
<PrintSource>[String]</PrintSource>
</PrintSources>
<AdditionalTitles>
<AdditionalTitle>[String]</AdditionalTitle>
</AdditionalTitles>
<OnlineSources>
<OnlineSource url="[Fully Qualified Website Address]">[String]</OnlineSource>
</OnlineSources>
<RecommendedSites>
<RecommendedSite url="[Fully Qualified Website Address]">[String]</RecommendedSite>\
</RecommendedSites>
<OtherLanguages>
<ContentObject Owner="[String]">
<Language Code="[es]" Direction="[ltr, rtl]" />
<RegularTitle>[String]</RegularTitle>
<InvertedTitle />
<Blurb>[String with HTML]</Blurb>
<GenderCode>[A,M,F]</GenderCode>
<PostingDate>[XML Date]</PostingDate>
</ContentObject>
</OtherLanguages>
<Formats>
<Format Name="[String]" MimeType="[MimeType]" AudioKbps="[int]" VideoKbps="[int]" Height="[int]" Width="[int]" />
</Formats>
</ContentObject>
</ContentList>