1. Home / Web Services API Version 7.5 / GetPropertySetDefinition

GetPropertySetDefinition

Returns the information of the specified propertset with field definitions.

Syntax

Visual Basic (declaration) 
Public Function GetPropertySetDefinition( _ 
	ByVal AuthenticationTicket as String, _ 
	ByVal PropertySetName as String) as XmlNode

C# (declaration) 
public XmlNode GetPropertySetDefinition( 
	string AuthenticationTicket,
	string PropertySetName)

Parameters

AuthenticationTicket
    string infoRouter ticket
PropertySetName
    string The Name of the PropertySet

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="">
  <PropertySet Name="INCOMINGFAX" Caption="Incoming Fax" AppliesToDocuments="TRUE" AppliesToFolders="FALSE" AppliesToUsers="FALSE" SystemUseOnly="FALSE">
    <DomainRestrictions Global="TRUE" />
    <Fields>
      <field FieldName="FAXTO" Caption="Fax To" DataType="CHAR" DataLength="50" Required="FALSE" ControlSize="50" ControlOrder="2" ControlType="TEXT BOX" />
      <field FieldName="FAXFROM" Caption="Fax From" DataType="CHAR" DataLength="50" Required="FALSE" ControlSize="50" ControlOrder="3" ControlType="TEXT BOX" />
      <field FieldName="SUBJECT" Caption="Subject" DataType="CHAR" DataLength="50" Required="FALSE" ControlSize="50" ControlOrder="4" ControlType="TEXT BOX" />
      <field FieldName="FAXDATE" Caption="Date" DataType="DATE" DataLength="8" Required="FALSE" ControlSize="12" ControlOrder="5" ControlType="TEXT BOX" />
    </Fields>
  </PropertySet>
</response>

See Also