AddSOXComment API

Adds a Sarbanes-Oxley (SOX) compliance comment to the latest version of the specified document. The comment is recorded as a SOX log entry and is permanently stored with the document version. The calling user must have Add Comment permission on the document.

Endpoint

/srv.asmx/AddSOXComment

Methods

Parameters

Parameter Type Required Description
authenticationTicket string Yes Authentication ticket obtained from AuthenticateUser.
DocumentPath string Yes Full infoRouter path of the document to comment on (e.g. /Finance/Controls/SOX-Control-A1.pdf).
CommentText string Yes The SOX compliance comment text to record. Leading/trailing whitespace is normalized before saving.

Response

Success Response

<root success="true" />

Error Response

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

Required Permissions


Example

GET Request

GET /srv.asmx/AddSOXComment?authenticationTicket=3f2504e0-4f89-11d3-9a0c-0305e82c3301&DocumentPath=/Finance/Controls/SOX-Control-A1.pdf&CommentText=Control+reviewed+and+confirmed+compliant+with+SOX+Section+404 HTTP/1.1

POST Request

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

authenticationTicket=3f2504e0-4f89-11d3-9a0c-0305e82c3301
&DocumentPath=/Finance/Controls/SOX-Control-A1.pdf
&CommentText=Control reviewed and confirmed compliant with SOX Section 404

SOAP Request

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
               xmlns:tns="http://tempuri.org/">
  <soap:Body>
    <tns:AddSOXComment>
      <tns:AuthenticationTicket>3f2504e0-4f89-11d3-9a0c-0305e82c3301</tns:AuthenticationTicket>
      <tns:DocumentPath>/Finance/Controls/SOX-Control-A1.pdf</tns:DocumentPath>
      <tns:CommentText>Control reviewed and confirmed compliant with SOX Section 404</tns:CommentText>
    </tns:AddSOXComment>
  </soap:Body>
</soap:Envelope>

Notes



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.
Document not found The specified DocumentPath does not exist or the user does not have access to it.
Access denied The calling user does not have DocumentCommentAdds permission on the document.
Document is offline The document is archived (offline state) and cannot accept SOX comments.

For detailed documentation visit: https://support.inforouter.com/api-docs/AddSOXComment