Retrieve an entity

Retrieving an entity means retrieving an enrolled the person with their attributes, selected biometric objects, and person properties.

BioClient.Web offers these retrieval verbs:

retrieve-person

This method retrieves an enrolled the person with their attributes, selected biometric objects, and person properties.

Usage

Call the Javascript method bioClient.retrieve_person(). This method is defined in bioclient-plugin.js and calls build_retrieve_person to build the BioClient.Web command, and calls retrieved_person to process the response. See The BioClient Javascript plugin for information on how to use and customise the BioClient Javascript plugin.

Event handlers

The JS method bc_addButtonEvents defines event handlers for this method for all buttons and anchors of class retrieve-person. It is recommended to use these event handlers.

Remarks

The method retrieves the person from the biometric store, identified by the uniqueName. If no unique name is provided, the current, default adapter is used.

This method also retrieves biometric features and samples of the current person. If the sampleClass or featureClass is null, all samples or features are retrieved. If the sampleClass or featureClass is zero, no samples or features are retrieved. If the sampleClass or featureClass is non-zero, only samples or features of the specified class are retrieved.

Input parameters

Parameter Type Value Remark
command string enrol The command to be executed.
adapter AdapterTypes Store The adapter type. Always Store.
storeName string The unique name of the store adapter to use. If null, the current adapter is used.
name string The unique name of the person identity to retrieve.
mode Processor mode The biometric process mode, which determines what aspects of the person to retrieve.
sampleClass int? The class of samples of the current person to retrieve. If null, all samples are retrieved. If zero, no samples are retrieved.
featureClass int? The class of features of the current person to retrieve. If null, all features are retrieved. If zero, no features are retrieved.
data boolean false true
props string A pipe (

Output parameters

Parameter Type Value Remark
command string enrol The command which was executed.
status string Success The success or failure status.
person person The retrieved person and their attributes.
person_msg string A friendly result message, relating to the person.
person_sev string success The severity of the person result message.
capture_msg string A friendly result message, relating to biometrics. Might be the same as the person message.
capture_sev string success The severity of the biometrics result message.
props [ props ] An array of retrieved properties.
sets [ subtype ] An array of retrieved subtypes.
features [ feature ] An array of retrieved features.
samples [ sample ] An array of retrieved samples.

retrieve-list

This method retrieves a list of person names (and optionally, some of their properties), based on search criteria.

Usage

Call the Javascript method bioClient.retrieve_list(). This method is defined in bioclient-plugin.js and calls build_retrieve_list to build the BioClient.Web command, and calls retrieved_person to process the response. See The BioClient Javascript plugin for information on how to use and customise the BioClient Javascript plugin.

Event handlers

The JS method bc_addButtonEvents defines event handlers for this method for all buttons and anchors of class retrieve-list. It is recommended to use these event handlers.

Remarks

Biometric stores potentially contain thousands, or even millions of enrolled identities. Therefore, this method could return a large number of person names and properties, if the search criteria are not carefully selected.

Input parameters

Parameter Type Value Remark
command string enrol The command to be executed.
adapter AdapterTypes Store The adapter type. Always Store.
storeName string The unique name of the store adapter to use. If null, the current adapter is used.
name string A name pattern of person identities to retrieve. The interpretation of this pattern is store-specific.
status PersonStatus The status attribute of the person. If None, the current status is not changed.
substatus int? The substatus attribute of the person. If null, the current substatus is not changed.
group int? The group attribute of the person. If null, the current group is not changed.
subgroup int? The subgroup attribute of the person. If null, the current subgroup is not changed.
props [ props ] An array of properties to match.
max int? The maximum number of person identity names to retrieve.

Output parameters

Parameter Type Value Remark
command string enrol The command which was executed.
status string Success The success or failure status.
persons [ names ] The array of retrieved person identity names.

References