Content Studio Web Content Management System
Assembly: CSServer5 (in CSServer5.dll) Version: 5.7.5016.0 (5.7.5016.0)
Xml with the following syntax (full return level i specified).
Possible values of the revision status attribute
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.
[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)
Syntax
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 )
Parameters
- connectionId
- Type: ContentStudioConnectionId
A value that identifies the web site - sessionId
- Type: ContentStudio.SecuritySessionId
A value that identifies the user's session. This value usually originates from a call to OpenSession(ConnectionId). - xmlParameterData
- Type: SystemString
XML that contains the parameters that this call uses. This XML is according to the Content Studio parameters XML schema - pageSize
- Type: SystemInt32
The size of the pages to read. If this parameter is less than 1 pageSize will be 10. - pageNumber
- Type: SystemInt32
The page number to read. If this value is less than 1 PageNumber will be 1. - pageCount
- Type: SystemInt32
The total pages of data found - recordCount
- Type: SystemInt32
The total entries found - status
- Type: SystemInt32
An integer indicating result of the call. Zero is success. - statusText
- Type: SystemString
The textual representation of the call result.
Return Value
Type: StringXml with the following syntax (full return level i specified).
<root> <status>0</status> <statustext>Success</statustext> <pageno>1</pageno> <pagecount>1</pagecount> <recordcount>1</recordcount> <unitid>40</unitid> <parentid>561</parentid> <module>Dokument</module> <location>MyUnit/HTML/</location> <categoryid>561</categoryid> <isenabledforpdf>0</isenabledforpdf> <documents> <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" /> </document> <!-- more documents following --> </documents> </root>
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.
Value | Meaning |
---|---|
0 | Not checked out. |
1 | Checked out by the caller. |
2 | Checked out by someone else. |
The publishstatus attribute, which is defined in the PublishStatuses enumeration, can have one of the following values and meaning
Value | Name | Description |
---|---|---|
0 | DraftOnly | The document exists only as a draft (utkast). |
5 | Expired | The document has expired. |
3 | InRecyclingBin | The document is in the Recycling bin. |
2 | Published | The document is published. |
1 | Queued | The document is waiting to be published. |
6 | Withdrawn | The document is withdrawn. |
The revisionstatus attribute, can have one of the following values and meaning
Value | Name | Description |
---|---|---|
0 | None | The document has only a draft and is not deleted and has not been subject to versioning. |
1 | Rejected | The document was on versioning but was rejected. |
2 | Versioning | The document is on versioning |
3 | Deleted | The document is deleted |
4 | Approved | The document is approved. |
When limited level is requested the following syntax is expected
Content Studio permissions
Remarks
Remarks
See Also