validate

Validate validates a value against the index on a field.

With validate you can effectively check whether a value already occurs in the index on a field.

Syntax

command=validate&<parameter>=<value>&.

  • database (String) name of the database configuration on which to perform the validate function. The name of this database must have been specified in the adlibweb.xml file.
  • field (String) English name of the field in the data dictionary used for validation. Check that the field actually has an index.
  • value (String) value to validate.
  • limit (Integer) [optional] maximum amount of keys to return (default = 10).
  • startfrom (Integer) [optional] first key number to return in the result (default = 1)

Examples

The object_name field is linked to the Thesaurus, so the validate command lists the priref (record number) from the linked records referrred to from the index on the object_name field. The TE tag in the XML result contains the retrieved index key. The 'a' value does not exist as an object name, so wwwopac.ashx retrieves the next values from the index, in alphabetical order.

https://webapi.axiell.com/demowebapi/wwwopac.ashx?database=collect.inf&command=validate&field=object_name&value=a

run example

- no further description -

https://webapi.axiell.com/demowebapi/wwwopac.ashx?database=collect.inf&command=validate&field=object_name&value=a&limit=30&startfrom=10

run example

The administration_name field is a local field, so the record numbers (prirefs) listed in the XML result refer to object records.

https://webapi.axiell.com/demowebapi/wwwopac.ashx?database=collect.inf&command=validate&field=administration_name&value=york

run example