This Method returns the list of documents identified by the dynamic collection. A dynamic collection differs from a standard collection in that there is no hierarchy of subtopics. A dynamic collection can be thought of as a pre-defined search. All documents from the Content database that match the dynamic collection criteria are included. Dynamic collections are also used to define the content licensed to a client. Dynamic collections select documents using a combination of content type, language and MeSH indexing.
Optionally the documents returned can be paged.
Parameter names: XMLRequest
Expects an XML document in this format:
<DynamicCollectionContentsRequest DynamicCollectionId="[CollectionID]" IncludeBlocked="[true, false]" />
The DynamicCollectionId attribute in the DynamicCollectionContentsRequest element is the only required attribute. By default, blocked documents will not be included in the response. If IncludeBlocked is specified "true" then blocked documents will be included in the response and will have a blocked="true" attribute.
The documents in the response will be sorted alphabetically by regular title.
Optionally the documents returned can be paged:
- A Paging element is used in both the request and the response.
- In the request it allows the content to be returned in pages. <Paging PageNumber="1" PageSize="10" />. PageNumber tells the web service which page of data to return. PageSize is used to specify the number of documents per page.
- In the response it shows information about the number of pages and documents returned. <Paging TotalDocs="15" PageSize="10" Pages="2" Page="1" />.
Sample Request
http://external.ws.staywell.com/[SiteName]/Collections.svc/GetDynamicCollectionContents?XmlRequest=<DynamicCollectionContentsRequest DynamicCollectionId="12" IncludeBlocked="true"/>
Sample Response XML
<?xml version="1.0" encoding="utf-8"?>
<DocumentList xmlns="http://ws.staywell.com">
<Document ContentTypeId="1" ContentId="12" IsCustom="0">
<Language code="en"/>
<RegularTitle xmlns="http://ws.staywell.com/markup">Heart Quiz for Women Only</RegularTitle>
<InvertedTitle xmlns="http://ws.staywell.com/markup">Women's Heart Quiz</InvertedTitle>
<Blurb>
<p>What do you know about a woman's heart?</p>
</Blurb>
<AdditionalTitles/>
</Document>
<Document ContentTypeId="1" ContentId="1" IsCustom="0">
<Language code="en"/>
<RegularTitle xmlns="http://ws.staywell.com/markup">Helping the Heart Through Cardiac Rehab</RegularTitle>
<AdditionalTitles>
<AdditionalTitle xmlns="http://ws.staywell.com/markup">Cardiac Rehab, Helping the Heart</AdditionalTitle>
</AdditionalTitles>
</Document>
<Document ContentTypeId="1" ContentId="567" IsCustom="0">
<Language code="en"/>
<RegularTitle xmlns="http://ws.staywell.com/markup">New Hope for People With Heart Failure</RegularTitle>
<AdditionalTitles/>
</Document>
<Document ContentTypeId="22" ContentId="ClientHeart" IsCustom="1" Owner="ClientSiteName">
<Language code="en"/>
<RegularTitle xmlns="http://ws.staywell.com/markup">Visit Our Heart Health Center</RegularTitle>
<AdditionalTitles/>
</Document>
</DocumentList>