apidocs

TransferUserDocumentSubscriptions API

Transfers document subscriptions from one user to another. The target user is subscribed to all documents that the source user currently subscribes to.

Endpoint

/srv.asmx/TransferUserDocumentSubscriptions

Methods

GET /srv.asmx/TransferUserDocumentSubscriptions?authenticationTicket=...&fromUserName=...&toUserName=...
POST /srv.asmx/TransferUserDocumentSubscriptions (form data)
SOAP Action: http://tempuri.org/TransferUserDocumentSubscriptions

Parameters

Parameter	Type	Required	Description
`authenticationTicket`	string	Yes	Authentication ticket obtained from `AuthenticateUser`.
`fromUserName`	string	Yes	The username whose document subscriptions will be transferred.
`toUserName`	string	Yes	The username who will receive the document subscriptions.

Response

Success Response

<root success="true" />

Success Response (with warnings)

<root success="true" warnings="Some document subscriptions could not be transferred." />

Error Response

<root success="false" error="[ErrorCode] Error message" />

Required Permissions

System administrator. Only system administrators can transfer user data between accounts.

Example

GET Request

GET /srv.asmx/TransferUserDocumentSubscriptions
  ?authenticationTicket=3f2504e0-4f89-11d3-9a0c-0305e82c3301
  &fromUserName=jdoe
  &toUserName=jsmith
HTTP/1.1

POST Request

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

authenticationTicket=3f2504e0-4f89-11d3-9a0c-0305e82c3301
&fromUserName=jdoe
&toUserName=jsmith

SOAP Request

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
               xmlns:tns="http://tempuri.org/">
  <soap:Body>
    <tns:TransferUserDocumentSubscriptions>
      <tns:AuthenticationTicket>3f2504e0-4f89-11d3-9a0c-0305e82c3301</tns:AuthenticationTicket>
      <tns:FromUserName>jdoe</tns:FromUserName>
      <tns:ToUserName>jsmith</tns:ToUserName>
    </tns:TransferUserDocumentSubscriptions>
  </soap:Body>
</soap:Envelope>

Notes

The toUserName is subscribed to all documents that fromUserName is currently subscribed to.
Documents where toUserName is already subscribed are skipped without error.
The response root element is <root>, not <response>.
Typically used as part of a user offboarding process before deleting the source user.

TransferUserFolderSubscriptions - Transfer folder subscriptions
TransferUserDocumentOwnerships - Transfer document ownerships
DeleteUser - Delete a user after transferring their data

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 `fromUserName` or `toUserName` does not exist.
Access denied	The calling user is not a system administrator.
`SystemError:...`	An unexpected server-side error occurred.