UpdatePropertySetRowForUser API¶

Updates an existing property set row for the specified user.

It can only rewrite a row that is already there; use AddPropertySetRowForUser to create the first one. Asking it to update a row the user does not have is refused, as is rownbr="0". Until 9.0 the first of those was a plain success that stored nothing - so the obvious first call to this operation, before any row had been created, silently did nothing at all. Like the other row operations it replaces the whole row rather than merging into it.

Endpoint¶

/srv.asmx/UpdatePropertySetRowForUser

Methods¶

• GET /srv.asmx/UpdatePropertySetRowForUser?authenticationTicket=...&userName=...&xmlpset=...
• POST /srv.asmx/UpdatePropertySetRowForUser (form data)
• SOAP Action: http://tempuri.org/UpdatePropertySetRowForUser

Parameters¶

xmlpset Format¶

<psets>
  <pset name="PROPERTYSETNAME">
    <row rownbr="1" FIELDNAME1="value1" FIELDNAME2="value2" />
  </pset>
</psets>

• name: Internal uppercase name of the property set.
• rownbr: Required -" identifies which existing row to update. Must be the 1-based row number of the row to update.
• Field attributes: Each field in the property set is specified as an attribute using its internal uppercase name.
• Multiple <pset> elements can be included to update rows in multiple property sets in one call.

Response¶

Success Response¶

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

Error Response¶

<response success="false" error="[901]Session expired or Invalid ticket" />

Required Permissions¶

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

Example¶

GET Request¶

GET /srv.asmx/UpdatePropertySetRowForUser
    ?authenticationTicket=3f7a1b2c-4d5e-6f7a-8b9c-0d1e2f3a4b5c
    &userName=jsmith
    &xmlpset=<psets><pset+name="HRDATA"><row+rownbr="1"+DEPARTMENT="Engineering"+LOCATION="HQ"/></pset></psets>
HTTP/1.1
Host: yourserver

POST Request¶

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

authenticationTicket=3f7a1b2c-4d5e-6f7a-8b9c-0d1e2f3a4b5c&userName=jsmith&xmlpset=<psets><pset name="HRDATA"><row rownbr="1" DEPARTMENT="Engineering" LOCATION="HQ"/></pset></psets>

JavaScript¶

Every call answers XML with HTTP 200, success or not, so success is the thing to branch on and errorCode is the number to report.

async function call(action, params) {
  const response = await fetch(`/srv.asmx/${action}?${new URLSearchParams(params)}`);
  const root = new DOMParser()
    .parseFromString(await response.text(), 'text/xml')
    .documentElement;

  if (root.getAttribute('success') !== 'true') {
    throw new Error(`${root.getAttribute('errorCode')}: ${root.getAttribute('error')}`);
  }
  return root;
}

UpdatePropertySetRow against a user account rather than a path.

await call('UpdatePropertySetRowForUser', {
  authenticationTicket: ticket,
  userName: 'jsmith',
  xmlpset: `
    <propertysets>
      <propertyset name="EMPLOYEEDETAILS">
        <row rownbr="1" COSTCENTRE="4400" />
      </propertyset>
    </propertysets>`
});

It can only rewrite a row that is already there - use AddPropertySetRowForUser to create the first one. Asking it to update a row the user does not have is a plain success that stores nothing, while rownbr="0" is refused 4000.

Notes¶

• The rownbr attribute is required and must match an existing row number for the property set on that user.
• Only fields listed as attributes in the <row> element are updated. Fields not mentioned are unchanged.
• The property set must have AppliesToUsers = true to be applicable to user objects.
• To add a new row for a user, use AddPropertySetRowForUser. To remove a row, use DeletePropertySetRowForUser.
• To update a property set row on a document or folder, use UpdatePropertySetRow.

Related APIs¶

• AddPropertySetRowForUser -" Add a new property set row to a user.
• DeletePropertySetRowForUser -" Delete a property set row from a user.
• UpdatePropertySetRow -" Update a property set row on a document or folder.
• GetPropertySets -" Get all applied property set rows for a document or folder.

Error Codes¶

The errorCode values this operation returns, checked against a running server: