Content Studio Web Content Management System
Assembly: CSServer5 (in CSServer5.dll) Version: 5.7.5016.0 (5.7.5016.0)
Xml according to the following sample
Any authenticated user can execute this method. However documents on versioning and rejected documents will only return documents that you have sent or that you have permission to reject or apporve.
[This is preliminary documentation and is subject to change.]
Returns a special list of documents such as MyOwnDocuments or MyCheckedOutDocuments.
Namespace: ContentStudio.Document
Assembly: CSServer5 (in CSServer5.dll) Version: 5.7.5016.0 (5.7.5016.0)
Syntax
public string GetDocumentsSpecialList( ConnectionId connectionId, SessionId sessionId, DocumentReaderDocumentSpecialList listType, DocumentId currentId, DocumentReaderDocumentListFilters filterCriteria, DocumentReaderDocumentListSortOrder sortOrder, int pageSize, ref int pageNumber, out int pageCount, out int recordCount )
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). - listType
- Type: ContentStudio.DocumentDocumentReaderDocumentSpecialList
Determines which list to return - currentId
- Type: ContentStudio.DocumentDocumentId
An identifier to a document that should be included in the returned page. This parameter can be zero to ignore this functionality. Specifying this value, and if the document exists in the list, will cause the pageNumber parameter to be ignored on input. - filterCriteria
- Type: ContentStudio.DocumentDocumentReaderDocumentListFilters
A member of the DocumentReaderDocumentListFilters enumeration that specifies which documents to return. - sortOrder
- Type: ContentStudio.DocumentDocumentReaderDocumentListSortOrder
A member in the DocumentReaderDocumentListSortOrder enumeration that specifies the sort order of the list. - pageSize
- Type: SystemInt32
The size of the pageing to use. - pageNumber
- Type: SystemInt32
The page to return. If currentId is specified the input of this value is ignored but after the call the parameter is filled with the number of the page actually returned. - pageCount
- Type: SystemInt32
Returns the number of pages found - recordCount
- Type: SystemInt32
Returns the number of records found.
Return Value
Type: StringXml according to the following sample
<root> <status>0</status> <statustext>Success</statustext> <pageno>1</pageno> <pagecount>3</pagecount> <recordcount>28</recordcount> <unitid>6</unitid> <parentid>0</parentid> <module></module> <location></location> <currentid>0</currentid> <documents> <document id="1609" name="16_critical.gif" type="image/gif" modified="2008-05-07T14:29:07.747" filename="Sve/Bilder/16_critical.gif" checkoutstatus="0" publishdate="2008-04-10T10:05:00" filesize="907" revisionstatus="4" publishstatus="2" deleteddate="1900-01-01T00:00:00" module="Fil" documentfilenamingconvention="1" DocumentType="10" wfstatustext="" description="" virtualpath="" imagesavailable="0"> <user createdby="John Doe" /> </document> <!--More document element can follow--> </documents> </root>
Element/attribute | Description |
---|---|
root/status | Integer: indicates outcome of the call; Always 0 which indicates success |
root/statustext | String: textual representation of the outcome of the call; Always "Success". |
root/pageno | Integer: The number of the page displayed. |
root/pagecount | Integer: The total number of pages found. |
root/recordcount | Integer: The total number of records in all pages found |
root/unitid | Not used |
root/parentid | Not used |
root/module | Not used |
root/location | Not used |
root/currentid | Integer: the currentId parameter value |
root/documents | No value; the root node for returned documents |
root/documents/document | No value; Represents a returned document |
root/documents/document@id | Integer: The document's internal identifier |
root/documents/document@name | String: The document name |
root/documents/document@type | String: The document content type (MIME type) |
root/documents/document@modified | DateTime: Indicates the document's modified date. |
root/documents/document@filename | String: The document's relative path name |
root/documents/document@checkoutstatus | Bit (0 or 1); 1 if the document is checked out, 0 otherwise |
root/documents/document@publishdate | DateTime: Indicates the document's publish date. |
root/documents/document@filesize | Integer: The size in bytes (on disk) of the document. |
root/documents/document@revisionstatus | D |
root/documents/document@publishstatus | D |
root/documents/document@deleteddate | DateTime: Indicates the document's deleted date. For not deleted document this value is 1900-01-01T00:00:00 |
root/documents/document@module | String; the document's module. For a list of possible values see ModuleName |
root/documents/document@documentfilenamingconvention | Integer; Determines how document files are named. For a list of possible values see FolderBaseDocumentFileNamingConvention |
root/documents/document@DocumentType | Integer; The type of document returned. For more information see DocumentTypes. |
root/documents/document@wfstatustext | String; Workflow status text. |
root/documents/document@description | String; Description of the document |
root/documents/document@virtualpath | String; Empry of the unique virtual path to the document. |
root/documents/document@imagesavailable | Integer: Indicates which versions of an image processed image are available. For more information see ImagesAvailable. |
root/documents/document/user | No value: represents the user that created the document. |
root/documents/document/user@createdby | String: The name of the user that created the document. |
Exceptions
Exception | Condition |
---|---|
CSException | A business rule was violated in the underlying Content Studio database |
SqlException | An error occurred when executing the command against the Content Studio database |
Content Studio permissions
See Also