AddISOComment API¶

Adds an ISO compliance review comment to the latest version of the specified document. The comment is recorded as an ISO log entry and the document's last ISO review date is updated. The calling user must have an active ISO Review Task assigned to them for the target document.

Endpoint¶

/srv.asmx/AddISOComment

Methods¶

• GET /srv.asmx/AddISOComment?authenticationTicket=...&DocumentPath=...&CommentText=...

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

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

Parameters¶

Response¶

Success Response¶

<root success="true" />

Error Response¶

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

Required Permissions¶

• The caller must be an authenticated user with a valid ticket.

• The caller must have an active ISO Review Task assigned to them for the specified document. Users without an assigned ISO Review Task will receive an error even if they have other permissions on the document.

• The document must not be in an Offline (archived) state.

Example¶

GET Request¶

GET /srv.asmx/AddISOComment?authenticationTicket=3f2504e0-4f89-11d3-9a0c-0305e82c3301&DocumentPath=/Finance/Reports/Q1Report.pdf&CommentText=Reviewed+and+approved+per+ISO+9001+requirements HTTP/1.1

POST Request¶

POST /srv.asmx/AddISOComment HTTP/1.1

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

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

&DocumentPath=/Finance/Reports/Q1Report.pdf

&CommentText=Reviewed and approved per ISO 9001 requirements

SOAP Request¶

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

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

  <soap:Body>

    <tns:AddISOComment>

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

      <tns:DocumentPath>/Finance/Reports/Q1Report.pdf</tns:DocumentPath>

      <tns:CommentText>Reviewed and approved per ISO 9001 requirements</tns:CommentText>

    </tns:AddISOComment>

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

This is not a free-form comment. It answers an ISO or periodic review task assigned to the calling user, and a caller with no such task on the document is refused with 4000 - so it cannot be used to annotate a document the way AddDocumentComment and AddSOXComment can. Assign the review first; the entry then appears in GetISOLogs.

try {
  await call('AddISOComment', {
    authenticationTicket: ticket,
    DocumentPath: '/Quality/Procedures/SOP-12.pdf',
    CommentText: 'Reviewed, no change required.'
  });
} catch (error) {
  // 4000 here means "you have no review task on this document", not "the text was wrong"
  console.warn(error.message);
}

Notes¶

• The comment is always applied to the latest version of the document (LastVersionNumber). There is no way to add an ISO comment to a specific older version via this API.

• The document's Last ISO Review Date field is automatically updated to the current server date and time when the comment is successfully added.

• Comment text is sanitized (whitespace normalized) before being stored.

• If the document is in an Offline state (archived to secondary storage), the API returns an error. The document must be online to accept ISO comments.

• An ISO Review Task is created as part of a Workflow process that includes an ISO review step. If no such workflow task exists for the calling user on this document, this API call will fail.

Related APIs¶

• AddSOXComment - Add an SOX compliance comment to a document

• GetISOLogs - Retrieve the ISO comment history for a document

• GetISOReviewAssignmentsOfUser - Get documents assigned to the current user for ISO review

• Search - Search for documents, e.g. by next ISO review date

Error Codes¶

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