ListFolders - method

Input

Input is .xml file with following marks.

Element

Item description

Obligation

<FolderSearchQuery>

 

 

+<Page>

Page - determins portion of downloaded folder metadata

yes

+<PageSize>

Page size - determins number of downloaded folder metadata

yes

+<apiClientID>

Api client ID - ID of caller of the method which has credentials to deal with eRegistrator

yes

+<FolderStatus>

Folder status of folder metadata to be downloaded. Possible values are: InProgress, MissedDueDate, WithinDueDate, WithoutDueDate, Closed, All. Default value is InProgress.

 

no

+<FolderType>

Folder type. Default value is download metadata regardless of folder type.

no

+<FilterParameters>

 

no

++<FilterParameter>

* if there is specified more one filter parameter they are linked by AND

 

+++<ColumnName>

Column name - Column name on which to apply the filter
Possible values are FolderCode, FolderName, Public, AdministratorID, FolderDueDate, FolderEntityType, FolderEntityCode, ClassificationTypeCode, ClassificationCode, FolderExpirationDate.

 

+++<Operand>

Operand - possible value are =, <, <=, >, >=, <>, LIKE, NOT LIKE, IN

 

+++<Value>

Value

 

+<OrderParameters>

 

no

++<OrderParameter>

* if there is specified more than one order parameter input sequence represents order sequence

 

+++<ColumnName>

Column name - Column name on which order is applied

 

+++<Operand>

Operand - possible value are asc, desc

 

 

 

 

Output

Output is .xml file with following marks.

Element

Item description

<ArrayOfFolderDetail>

 

+<FolderDetail>

 

++<apiClientID>

Api client ID

++<FolderID>

Folder ID

++<FolderType>

Folder type

++<FolderTypeName>

Folder type name

++<FolderCode>

Folder code

++<FolderName>

Folder name

++<OrganisationID>

Organisation ID

++<Public>

Public

++<AdministratorID>

Administrator ID

++<FolderStatus>

Folder status

++<FolderDueDate>

Folder due date

++<FolderEntityType>

Folder entity type

++<FolderEntityCode>

Folder entity code

++<FolderEntityName>

Folder entity name

++<ClassificationTypeCode>

Classification type code

++<ClassificationCode>

Classification code

++<ClassificationName>

Classification name

++<FolderExpirationDate>

Folder expiration date

Natisni