GetTagDefintions API¶

Obsolete: This API name contains a typo (Defintions instead of Definitions). It is kept for backward compatibility only. Use GetTagDefinitions for all new integrations.

Returns the list of all tag definitions configured in the infoRouter system. Tags are predefined text labels that can be applied to documents for categorisation, filtering, and search.

Endpoint¶

/srv.asmx/GetTagDefintions

Methods¶

• GET /srv.asmx/GetTagDefintions?AuthenticationTicket=...
• POST /srv.asmx/GetTagDefintions (form data)
• SOAP Action: http://tempuri.org/GetTagDefintions

Parameters¶

Response¶

Success Response¶

Returns a <response> element with success="true" containing a <TagDefinitions> element with zero or more <TagDefinition> child elements. Each <TagDefinition> element's text content is the tag label string.

<response success="true" error="">
  <TagDefinitions>
    <TagDefinition>Approved</TagDefinition>
    <TagDefinition>For Review</TagDefinition>
    <TagDefinition>Draft</TagDefinition>
    <TagDefinition>Confidential</TagDefinition>
    <TagDefinition>Final</TagDefinition>
  </TagDefinitions>
</response>

No Tags Configured Response¶

<response success="true" error="">
  <TagDefinitions />
</response>

Error Response¶

<response success="false" error="[900] Authentication failed." />

Required Permissions¶

Any authenticated user with a valid ticket may call this API. No additional permissions are required.

Notes¶

• Obsolete: Use GetTagDefinitions for all new integrations. This endpoint is retained only for backward compatibility with existing integrations.
• Tag Text is Case-Sensitive: Tag values are returned exactly as configured. Use the tag text exactly as returned when calling SetTagToDocument or RemoveTagFromDocument.
• Read-Only: This API only reads the tag list.

Related APIs¶

• GetTagDefinitions - Correctly-spelled replacement for this API
• SetTagToDocument - Apply a tag to the latest version of a document
• RemoveTagFromDocument - Remove a tag from a document

Error Codes¶