Interface SetCredentialResponse

This field shall indicate the next available index in the database for the credential type set, which is useful for quickly identifying available credential slots in the database. This shall NOT be null if there is at least one available entry after the requested credential index in the corresponding database and shall be null if there are no more available entries. The NextCredentialIndex reported shall NOT exceed the maximum number of credentials for a particular credential type.

Status comes from the Status Codes table and shall be one of the following values:

• SUCCESS, if setting user credential was successful.

• FAILURE, if some unexpected internal error occurred setting user credential.

• OCCUPIED, if OperationType is Add and CredentialIndex in Credential structure points to an occupied slot.

• OCCUPIED, if OperationType is Modify and CredentialIndex in Credential structure does not match the CredentialIndex that is already associated with the provided UserIndex.

• DUPLICATE, if CredentialData provided is a duplicate of another credential with the same CredentialType (e.g. duplicate PIN code).

• RESOURCE_EXHAUSTED, if OperationType is Add and the user referred to by UserIndex already has NumberOfCredentialsSupportedPerUser credentials associated.

• INVALID_COMMAND, if one or more fields violate constraints or are invalid.

• INVALID_COMMAND, if the CredentialIndex in the Credential provided exceeds the number of credentials of the provided CredentialType supported by the lock.

• INVALID_COMMAND, if OperationType is Modify and UserIndex points to an available slot.

This field shall indicate the user index that was created with the new credential. If the status being returned is not success then this shall be null. This shall be null if OperationType was Modify; if the OperationType was Add and a new User was created this shall NOT be null and shall provide the UserIndex created. If the OperationType was Add and an existing User was associated with the new credential then this shall be null.