Skip to content

RemoveISOReviewDefinition API

Removes the ISO review schedule from a document. After removal, no periodic review tasks or workflows will be generated for the document.

Endpoint

/srv.asmx/RemoveISOReviewDefinition

Methods

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

Parameters

Parameter Type Required Description
authenticationTicket string Yes Authentication ticket obtained from AuthenticateUser
documentPath string Yes Full path of the document

Response

Success Response

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

Error Response

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

Required Permissions

The caller must have Change Document Properties permission on the document.

Example

Remove ISO review from a document (GET)

GET /srv.asmx/RemoveISOReviewDefinition?authenticationTicket=abc123-def456&documentPath=/Library/Policies/policy.pdf HTTP/1.1

Remove ISO review from a document (POST)

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

authenticationTicket=abc123-def456&documentPath=/Library/Policies/policy.pdf

Request (SOAP 1.1)

POST /srv.asmx HTTP/1.1
Content-Type: text/xml; charset=utf-8
SOAPAction: "http://tempuri.org/RemoveISOReviewDefinition"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <RemoveISOReviewDefinition xmlns="http://tempuri.org/">
      <authenticationTicket>abc123-def456</authenticationTicket>
      <documentPath>/Library/Policies/policy.pdf</documentPath>
    </RemoveISOReviewDefinition>
  </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 the ISO review off a document. It is safe to repeat - a document that has none is a success.

await call('RemoveISOReviewDefinition', {
  authenticationTicket: ticket,
  documentPath: '/Quality/Procedures/qp-001.pdf'
});

Afterwards GetISOReviewDefinition answers the sentinel <isoDef> again rather than nothing.

Notes

  • Has no effect if no ISO review schedule is currently set on the document
  • Does not cancel any review tasks or workflows already in progress

Error Codes

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

errorCode When
4010 the ticket is expired or unknown, or there is no ticket at all
4041 no document at that path - including a folder path
4030 the caller may not change that document
HTTP 400 a required string parameter was empty; refused by model binding, so there is no error document