DocumentReaderGetDocumentsInCategory Method (ConnectionId, SessionId, DocumentReaderDocumentsInCategoryReturnLevel, CategoryId, DocumentId, DocumentReaderDocumentListFilters, DocumentReaderDocumentListSortOrder, Int32, String, Int32, Int32, Int32) 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,
	DocumentReaderDocumentsInCategoryReturnLevel returnLevel,
	CategoryId categoryId,
	DocumentId currentId,
	DocumentReaderDocumentListFilters filterCriteria,
	DocumentReaderDocumentListSortOrder sortOrder,
	int pageSize,
	string[] fileTypes,
	ref int pageNumber,
	out int pageCount,
	out int recordCount


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: ContentStudio.DocumentDocumentReaderDocumentsInCategoryReturnLevel
Determines how detailed return data to return.
Type: ContentStudio.DocumentCategoryId
An identifier to the category to list from. When currentId is specified and the document exists and for documents in the recycling bin, this parameter is ignored.
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 to an existing document, will cause the pageNumber and categoryId parameters to be ignored on input. Instead the call searches the category where currentId belongs, applies the filter on that category and returns the data page where currentId fits in.
Type: ContentStudio.DocumentDocumentReaderDocumentListFilters
A member of the DocumentReaderDocumentListFilters enumeration that specifies which documents to return.
Type: ContentStudio.DocumentDocumentReaderDocumentListSortOrder
A member in the DocumentListSortOrder enumeration that specifies the sort order of the list.
Type: SystemInt32
The size of the pageing to use. If this value is zero or negative 1 is used.
Type: SystemString
Defines an array of file extensions that can be used for filter documents in this category. The file extension must start with a period (.). Use the value *. to allow any file extension. If any of the entries contains .* all other items will be discarded. This parameter can be an empty array. This parameter can be null (Nothing in Visual Basic) to use the default value (.*). Internally this array is joined to a comma delimited string of file extensions and the size of this inter value cannot exceed MAX_ALLOWED_FILETYPES_SIZE number of characters, thus always keep in mind the extra comma added to each file extension when checking the text length of all elements in the array.
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.
Type: SystemInt32
Returns the number of pages found
Type: SystemInt32
Returns the number of records found.

Return Value

Type: String
Xml with the following syntax when full return level is specified.

    <document publishstatus="2" 
      <user createdby="John Oscar" />
  <!-- more documents follow -->
root/statusInteger: Indicates the outcome of the call, always 0 which indicates success
root/statustextString: The textual representation of the status, always OK
root/pagecountInteger: the number of data pages found.
root/recordcountInteger: the total number of records found.
root/unitidInteger: an identifier of the unit of the category represented by categoryId.
root/parentidInteger: an identifier of the parent of the category represented by categoryId.
root/locationString: The relative path name to the category referenced by categoryId (e.g. MyUnit/TheCategory).
root/categoryidInteger: The category identifier. This is the categoryId parameter.
root/isenabledforpdfBit: 1 if the category represented by categoryId uses a PDF-server; otherwise, 0.
root/documentsDocument list container element.
root/documents/documentElement that contains attributes that represents properties of a document returned.
root/documents/document/@publishstatusInteger: for more information see below
root/documents/document/@idInteger: The numeric identifier of the document
root/documents/document/@nameString: the document name
root/documents/document/@typeString: the mime type of the document e.g. text/html
root/documents/document/@modifiedSortable DateTime value: indicates when the document was last modified e.g. 2007-02-28T15:27:57.323.
root/documents/document/@filenameString: the name of the file in the file system that represents this document.
root/documents/document/@checkoutstatusInteger: for more information about this attribute: see section below.
root/documents/document/@publishdateSortable DateTime value: indicates when the document can be published e.g. 2007-02-28T15:27:57.323.
root/documents/document/@filesizeInteger: the size (in bytes) of the file in the file system that represents this document.
root/documents/document/@revisionstatusInteger: for more information see below
root/documents/document/@deleteddateSortable DateTime value: indicates when the document was deleted e.g. 2007-02-28T15:27:57.323. Empty or missing if not deleted.
root/documents/document/@wfstatustextString: the workflow status text. Empty unless workflow is used.
root/documents/document/@description>String: the description of the document.
root/documents/document/@contentsize>Integer: the size (in bytes) of the raw content of the document when stored in the database.
root/documents/document/@imagesavailableInteger: indicates how the image processor scales images uploaded. Value is one of the numeric values of the ImagesAvailable enumeration.
root/documents/document/@virtualpathString: the virtual path of the document or empty.
root/documents/document/userElement that contains attributes with information about the user that created the document.
root/documents/document/user/@createdby>String: the name of the user that created the document

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

    <document id="4420" 
    <!-- more document elements follow -->

CSExceptionA business rule was violated in the underlying Content Studio database
SqlExceptionAn error occurred when executing the command against the Content Studio database
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.
Note Note
In version 5.3 support for reading only the document deleted by the caller has been introduced as a new filter option.

Starting with version 5.3, programmers that write their own code to list documents in the recycling bin might like to use the alternative method GetDocumentsInRecyclingBin instead which is easier and more friendly to use.

See Also