1. Home / Web Services API Version 8.x / GetPropertySetDefinitions1

GetPropertySetDefinitions1

Returns the list of property sets defined in the system that are match to the given parameters

Syntax

Visual Basic (declaration) 
Public Function GetPropertySetDefinitions1( _ 
	ByVal AuthenticationTicket as String, _ 
	ByVal DomainNameFilter as String, _ 
	ByVal AppliesToDocuments as bool, _ 
	ByVal AppliesToFolders as bool, _ 
	ByVal AppliesToUsers as bool) as XmlNode

C# (declaration) 
public XmlNode GetPropertySetDefinitions1( 
	string AuthenticationTicket,
	string DomainNameFilter,
	bool AppliesToDocuments,
	bool AppliesToFolders,
	bool AppliesToUsers)

Parameters

AuthenticationTicket
    string infoRouter ticket
DomainNameFilter
    string to filter propertysets that are applicaple to the specified Domain/library names
AppliesToDocuments
    bool to filter propertysets that are applicaple to documents
AppliesToFolders
    bool to filter propertysets that are applicaple to folders
AppliesToUsers
    bool to filter propertysets that are applicaple to users

Return Value

returns xml fragment.
<response success="true" error="">
if success attribute is "true", the results have been received succesfully like the xml sample below.
if success attribute is "false", the error attribute indicates the encountered error.

<response success="true" error="">
  <PropertySets>
    <PropertySet Name="LETTER" Caption="Letter" AppliesToDocuments="TRUE" AppliesToFolders="TRUE" AppliesToUsers="FALSE" SystemUseOnly="FALSE">
      <DomainRestrictions Global="TRUE" />
    </PropertySet>
  </PropertySets>
</response>

See Also