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

AddPropertySetRow

Adds a property set row to a document or a folder in the specified path.

Syntax

Visual Basic (declaration) 
Public Function AddPropertySetRow( _ 
	ByVal AuthenticationTicket as String, _ 
	ByVal Path as String, _ 
	ByVal xmlpset as String) as XmlNode

C# (declaration) 
public XmlNode AddPropertySetRow( 
	string AuthenticationTicket,
	string Path,
	string xmlpset)

Parameters

AuthenticationTicket
    string inforouter ticket
Path
    string an infoRouter document or folder path
xmlpset
    string a XML fragment for property set and it's values. See the remarks section.

Return Value

returns xml fragment.
<response success="true" error="">
if success attribute is "true", the property set has been applied successfully.
if success attribute is "false", the error attribute indicates the encountered error.

Remarks

The caller must have at least "Change" Permission on the document or Folder.

xmlPset must be organized as sample below:

<Propertysets>
<propertyset Name="LETTER">
<propertyrow LetterType="Business" Subject="Subject 1 - Lorem Dolor Sit amet.."/>
<propertyrow LetterType="Business" Subject="Subject 2 - Lorem Dolor Sit amet.."/>
</propertyset>
</Propertysets>

minus gif Example

Visual Basic Example 
    Public Sub AddPropertySetRow()
        Const IRAuthenticationTicket As String = "sid-XXXXXXXXXXXX"
	Const ServiceURL As String="http://docsrv/inforouter/srv.asmx"
        Const TargetIRPath As String = "/Human Resources/Letters/1234-1234-AB-Reference.PDF"
        Dim IR_OBJ As InfoRouter.srv
        Dim xml_response As System.Xml.XmlNode
        Try

            IR_OBJ = New InfoRouter.srv
            IR_OBJ.Url = ServiceURL

            Dim xmlPset As String = "<Propertysets>" + _
                                    "<propertyset Name=""LETTER"">" + _
                                    "<propertyrow LetterType=""Reference"" FromWhom=""Joe Doe"" Subject=""Subject 1 - Lorem Dolor Sit amet.."" />" + _
                                    "<propertyrow LetterType=""Business"" FromWhom=""Marry Smith"" Subject=""Subject 2 - Lorem Dolor Sit amet.."" />" + _
                                    "</propertyset>" + _
                                    "</Propertysets>"

            xml_response = IR_OBJ.AddPropertySetRow(AuthenticationTicket, TargetIRPath, xmlPset)
            'check response xml if any error occured.
            If xml_response.Attributes("success").Value = "true" Then
                Console.WriteLine("Propertyset has been added")
            Else
                Console.WriteLine("server response:" + xml_response.Attributes("error").Value)
            End If
            xml_response = Nothing
            Return


        Catch ex As Exception
  		Console.WriteLine("error:" & ex.Message)
        Finally
            xml_response = Nothing
            IR_OBJ = Nothing
        End Try
    End Sub

See Also