DocumentReaderGetDocumentsInCategory Method (ConnectionId, SessionId, String, Int32, Int32, Int32, Int32, Int32, String) Content Studio 5.7 SDK
Content Studio Web Content Management System

[This is preliminary documentation and is subject to change.]

Returns a pageable list of documents that exists in a category. It is possible to apply filters to this list.

Namespace: ContentStudio.Document
Assembly: CSServer5 (in CSServer5.dll) Version: 5.7.5016.0 (5.7.5016.0)

public string GetDocumentsInCategory(
	ConnectionId connectionId,
	SessionId sessionId,
	string xmlParameterData,
	int pageSize,
	ref int pageNumber,
	out int pageCount,
	out int recordCount,
	out int status,
	out string statusText


Type: ContentStudioConnectionId
A value that identifies the web site
Type: ContentStudio.SecuritySessionId
A value that identifies the user's session. This value usually originates from a call to OpenSession(ConnectionId).
Type: SystemString
XML that contains the parameters that this call uses. This XML is according to the Content Studio parameters XML schema
Type: SystemInt32
The size of the pages to read. If this parameter is less than 1 pageSize will be 10.
Type: SystemInt32
The page number to read. If this value is less than 1 PageNumber will be 1.
Type: SystemInt32
The total pages of data found
Type: SystemInt32
The total entries found
Type: SystemInt32
An integer indicating result of the call. Zero is success.
Type: SystemString
The textual representation of the call result.

Return Value

Type: String
Xml with the following syntax (full return level i specified).

    <document publishstatus="2" id="4420" name="HelloCS5" type="text/html" modified="2007-02-28T15:27:57.323" filename="MyUnit/HTML/BCC7232E-BD9F-4112-9929-275EE7121204.aspx" checkoutstatus="1" publishdate="2007-02-28T15:25:00" filesize="996" revisionstatus="0" deleteddate="1900-01-01T00:00:00" wfstatustext="" description="" contentsize="0">
      <user createdby="John Oscar" />
  <!-- more documents following -->

The checkoutstatus attribute, specifies whether the document is checked out and if so, whether the document is checked out by the caller or someone else.

0Not checked out.
1Checked out by the caller.
2Checked out by someone else.

The publishstatus attribute, which is defined in the PublishStatuses enumeration, can have one of the following values and meaning

0DraftOnlyThe document exists only as a draft (utkast).
5ExpiredThe document has expired.
3InRecyclingBinThe document is in the Recycling bin.
2PublishedThe document is published.
1QueuedThe document is waiting to be published.
6WithdrawnThe document is withdrawn.

The revisionstatus attribute, can have one of the following values and meaning

Possible values of the revision status attribute
0NoneThe document has only a draft and is not deleted and has not been subject to versioning.
1RejectedThe document was on versioning but was rejected.
2VersioningThe document is on versioning
3DeletedThe document is deleted
4ApprovedThe document is approved.

When limited level is requested the following syntax is expected

Content Studio permissions

READ permission on the category is required.

When listing deleted documents the passed in category id is ignored thus all documents in the recycling bin are listed.

This is the backwards compatible implementation of this method. This implementation does not throw any exceptions, instead callers must examine the outcome of the call in the Status and StatusText output parameters.
See Also