GetISOReviewAssignmentsOfUser API¶
Returns a paged list of documents assigned to the specified user for ISO review.
Endpoint¶
Methods¶
- GET
/srv.asmx/GetISOReviewAssignmentsOfUser?authenticationTicket=...&userName=...&startingRow=...&rowCount=... - POST
/srv.asmx/GetISOReviewAssignmentsOfUser(form data) - SOAP Action:
http://tempuri.org/GetISOReviewAssignmentsOfUser
Parameters¶
| Parameter | Type | Required | Description |
|---|---|---|---|
authenticationTicket |
string | Yes | Authentication ticket obtained from AuthenticateUser |
userName |
string | Yes | The username whose ISO review assignments are to be retrieved |
startingRow |
int | Yes | Zero-based row offset for paging. Pass 0 to start from the first result |
rowCount |
int | Yes | Number of rows to return (page size). Pass 0 to return all results |
Required Permissions¶
- No additional permissions are required when querying the authenticated user's own ISO review assignments.
- To query another user's assignments, the caller must have the ListingAuditLogOfUser admin permission for the target user.
Response¶
Success Response¶
<root success="true" totalcount="12">
<document id="510" name="QualityPolicy.docx" path="/ISO/QualityPolicy.docx" ... />
<document id="622" name="ProcedureManual.pdf" path="/ISO/ProcedureManual.pdf" ... />
</root>
Documents come back as the full <document> element. Since 9.0 it also carries AIEnhanced and
AIExtractConfidence. The first says which of the document's attributes infoRouter Connect
produced, as a set of bits - 0 when none did; the second how sure it was about the weakest value
it put in a property set, as a percentage. See AIEnhanced and
AIExtractConfidence.
Error Response¶
Example¶
Request (GET)¶
GET /srv.asmx/GetISOReviewAssignmentsOfUser?authenticationTicket=abc-123&userName=jsmith&startingRow=0&rowCount=25
Request (POST)¶
POST /srv.asmx/GetISOReviewAssignmentsOfUser HTTP/1.1
Content-Type: application/x-www-form-urlencoded
authenticationTicket=abc-123&userName=jsmith&startingRow=0&rowCount=25
SOAP 1.1 Request¶
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:tns="http://tempuri.org/">
<soap:Body>
<tns:GetISOReviewAssignmentsOfUser>
<tns:authenticationTicket>abc-123</tns:authenticationTicket>
<tns:userName>jsmith</tns:userName>
<tns:startingRow>0</tns:startingRow>
<tns:rowCount>25</tns:rowCount>
</tns:GetISOReviewAssignmentsOfUser>
</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;
}
Lists the ISO and periodic review tasks assigned to one user, a page at a time.
const root = await call('GetISOReviewAssignmentsOfUser', {
authenticationTicket: ticket,
userName: 'jsmith',
startingRow: 0,
rowCount: 100
});
if (Number(root.getAttribute('recordCount')) === 0) {
// nothing assigned - AddISOComment would be refused for every document
}
rowCount=0 means every row, not none, and the answer reports rowCount as the total rather than
the zero that was sent. The root carries recordCount, the total ignoring the paging, alongside the
startingRow and rowCount that were applied.
Worth calling before AddISOComment: that operation answers a review task rather
than adding a free-form comment, and a user with no assignment is refused 4000 for every document.
Notes¶
- Use
startingRow=0androwCount=0to retrieve all ISO review assignments. - Results are returned in ascending order by document name.
- The
totalcountattribute on the root element reflects the total number of ISO review assignments for the user, regardless of paging parameters. - This API was formerly named
GetISOReviewAssignments. Callers using the old name must update toGetISOReviewAssignmentsOfUserand add thestartingRowandrowCountparameters. - Each
<document>element includes aUserViewStatusinteger attribute:0= never viewed,1= viewed but the published version has since changed,2= viewed the current published version. SeeGetDocumentfor the full attribute reference.
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 |
4000 |
no user by that name |
HTTP 400 |
a required string parameter was empty; refused by model binding, so there is no error document |