RemoveFromFavorites API¶

Removes the specified document or folder from the currently authenticated user's favorites list. If the item is not currently in the favorites list, the call completes successfully without making any changes.

Endpoint¶

/srv.asmx/RemoveFromFavorites

Methods¶

• GET /srv.asmx/RemoveFromFavorites?authenticationTicket=...&itemPath=...

• POST /srv.asmx/RemoveFromFavorites (form data)

• SOAP Action: http://tempuri.org/RemoveFromFavorites

Parameters¶

Response¶

Success Response¶

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

Error Response¶

<response success="false" error="Document/Folder not found." />

Required Permissions¶

No special permissions are required beyond authentication. The call always operates on the currently authenticated user's favorites list; a user cannot modify another user's favorites through this API.

Example¶

GET Request (document)¶

GET /srv.asmx/RemoveFromFavorites

  ?authenticationTicket=3f2504e0-4f89-11d3-9a0c-0305e82c3301

  &itemPath=/Finance/Reports/Q1-2024-Report.pdf

HTTP/1.1

GET Request (folder)¶

GET /srv.asmx/RemoveFromFavorites

  ?authenticationTicket=3f2504e0-4f89-11d3-9a0c-0305e82c3301

  &itemPath=/Finance/Reports

HTTP/1.1

POST Request¶

POST /srv.asmx/RemoveFromFavorites HTTP/1.1

Content-Type: application/x-www-form-urlencoded

authenticationTicket=3f2504e0-4f89-11d3-9a0c-0305e82c3301

&itemPath=/Finance/Reports/Q1-2024-Report.pdf

SOAP Request¶

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"

               xmlns:tns="http://tempuri.org/">

  <soap:Body>

    <tns:RemoveFromFavorites>

      <tns:authenticationTicket>3f2504e0-4f89-11d3-9a0c-0305e82c3301</tns:authenticationTicket>

      <tns:itemPath>/Finance/Reports/Q1-2024-Report.pdf</tns:itemPath>

    </tns:RemoveFromFavorites>

  </soap:Body>

</soap:Envelope>

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;
}

Takes a document or folder off the calling user's favourites.

await call('RemoveFromFavorites', {
  authenticationTicket: ticket,
  itemPath: '/Finance/Reports'
});

Removing something that is not on the list is a success, so this is safe to call without checking first. A path that names nothing at all is 4041.

A caller with no ticket is refused with 4010, the same as every other write in this area. It used to be answered success - the anonymous user has no lists so nothing was removed, but a client could not tell that apart from a removal that happened.

Notes¶

• Both documents and folders can be removed from favorites using this API. The path is resolved as a document first; if no document is found at the path, it is resolved as a folder.

• The call always modifies the currently authenticated user's favorites list only.

• If the item is not in the favorites list, the call still returns success -" it is a safe no-op.

• Use GetFavorites to retrieve the current favorites list before calling this API.

• Use AddToFavorites to add a document or folder to the favorites list.

Related APIs¶

• AddToFavorites - Add a document or folder to the current user's favorites list

• GetFavorites - Get the list of documents and folders marked as favorites by the current user

Error Codes¶

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