Skip to main content

 Services

Web services from /about to /webhooks

validate urls

/members/{member}/groups/{group}/externaluris/validate [POST]

Description

Validate the external URIs (also known as URLs) used in a group or on the whole server.

This service starts an Asynchronous process.

Parameters

NameDescriptionRequiredTypeDefault value
failuresonlyWhether to only include results with failed assertionsnobooleanfalse
forIf 'server' then validate all external URIs on the server (edit all URLs permission only)nostring
schemaThe name of the schematron to use for validation (e.g. myschema.sch)yesstring
sharedWhether to share this report with other group members (manager only)nobooleanfalse
urltypeThe URL type of URIs to validatenostring

Permission

This service requires contributor or higher in the group.

Response

The output has the following format:

<url-validation>
  <thread ...> ... </thread>
</url-validation>

Error Handling

0x1207 No URIs to validate
Created on , last edited on