AddPropertySetRowForUser API

Adds one or more property set rows to the specified infoRouter user. Property sets are custom metadata schemas; each row contains field values for a given property set definition.

Endpoint

/srv.asmx/AddPropertySetRowForUser

Methods

Parameters

Parameter Type Required Description
authenticationTicket string Yes Authentication ticket obtained from AuthenticateUser.
userName string Yes The username of the user to add property set rows to.
xmlpset string Yes An XML string describing the property set rows to add (see format below).

xmlpset Format

The xmlpset parameter is an XML string. The root element contains one child element per property set; each property set element contains one child element per row to add.

<propertysets>
  <propertyset name="EmployeeInfo">
    <row RowNbr="0" Department="Finance" CostCenter="CC001" StartDate="2023-01-15" />
  </propertyset>
  <propertyset name="ContactInfo">
    <row RowNbr="0" PhoneNumber="+1-555-0100" OfficeLocation="Building A" />
  </propertyset>
</propertysets>

Response

Success Response

<response success="true" error="" />

Error Response (single error)

<response success="false" error="Error message" />

Error Response (multiple errors)

<response success="false" error="[log]">
  <logitem propertyset="PropertySetName" error="Error detail" />
</response>

Required Permissions

System administrator or a user with permission to manage the target user's property sets.


Example

GET Request

GET /srv.asmx/AddPropertySetRowForUser
  ?authenticationTicket=3f2504e0-4f89-11d3-9a0c-0305e82c3301
  &userName=jdoe
  &xmlpset=%3Cpropertysets%3E%3Cpropertyset+name%3D%22EmployeeInfo%22%3E%3Crow+RowNbr%3D%220%22+Department%3D%22Finance%22+%2F%3E%3C%2Fpropertyset%3E%3C%2Fpropertysets%3E
HTTP/1.1

POST Request

POST /srv.asmx/AddPropertySetRowForUser HTTP/1.1
Content-Type: application/x-www-form-urlencoded

authenticationTicket=3f2504e0-4f89-11d3-9a0c-0305e82c3301
&userName=jdoe
&xmlpset=<propertysets><propertyset name="EmployeeInfo"><row RowNbr="0" Department="Finance" CostCenter="CC001" /></propertyset></propertysets>

SOAP Request

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
               xmlns:tns="http://tempuri.org/">
  <soap:Body>
    <tns:AddPropertySetRowForUser>
      <tns:AuthenticationTicket>3f2504e0-4f89-11d3-9a0c-0305e82c3301</tns:AuthenticationTicket>
      <tns:UserName>jdoe</tns:UserName>
      <tns:XmlPset>&lt;propertysets&gt;&lt;propertyset name="EmployeeInfo"&gt;&lt;row RowNbr="0" Department="Finance" /&gt;&lt;/propertyset&gt;&lt;/propertysets&gt;</tns:XmlPset>
    </tns:AddPropertySetRowForUser>
  </soap:Body>
</soap:Envelope>

Notes



Error Codes

Error Description
[900] Authentication failed Invalid or missing authentication ticket.
[901] Session expired or Invalid ticket The ticket has expired or does not exist.
User not found The specified username does not exist.
Property set not found A property set named in the XML does not exist.
SystemError:... An unexpected server-side error occurred.

For detailed documentation visit: https://support.inforouter.com/api-docs/AddPropertySetRowForUser