EnrollmentErrorURL Property

Location where card range and enrollment verification errors are posted to.

Syntax

 mpi.getEnrollmentErrorURL([callback])
 mpi.setEnrollmentErrorURL( enrollmentErrorURL, [callback])

Default Value

""

Callback

The 'callback' parameter specifies a function which will be called when the operation completes (or an error is encountered). If the 'callback' parameter is not specified, then the method will block and will not return until the operation completes (or an error is encountered).

The callback for the getEnrollmentErrorURL([callback]) method is defined as:

function(err, data){ }

'err' is the error that occurred. If there was no error, then 'err' is 'null'.

'data' is the value returned by the method.

The callback for the setEnrollmentErrorURL([callback]) method is defined as:

function(err){ }

'err' is the error that occurred. If there was no error, then 'err' is 'null'.

'err' has 2 properties which hold detailed information:

err.code
err.message

Remarks

This property is automatically filled whenever the DirectoryServerURL is set, as normally the EnrollmentErrorURL should be identical to the DirectoryServerURL. If it is required that errors be posted to a different address, this property can be changed before calling RequestCardRanges or VerifyEnrollment. Only errors generated by the RequestCardRanges and VerifyEnrollment methods will be posted to this URL. Errors generated by the CheckAuthenticationResponse method will be posted to the AuthenticationErrorURL. If this property is set to empty before calling the RequestCardRanges or VerifyEnrollment methods no errors will be posted.

Data Type

String