Back to index

GenerateAndAssignPin_v1

This method allows you to generate a unique pin and assign it for a driver. Minimum length of PIN allowed is 4 Numerals. Maximum length of PIN allowed is 8 Numerals. The generated pin will consist of numerals between 0 and 9.

Parameters:

[in] usn The user-name that you need to use to authenticate on this interface.
[in] pwd The password that you need to use to authenticate on this interface.
[in] options String parameter. This is currently unused and reserved for future versions of the API. Pass in an empty string.
[in] driverID The driverID item for the driver who's pin is to be created/modified.
[in] pinLength Int parameter. This is the number of characters to be used in the new pin for the driver, the minimum length is 4 characters and the maximum length is 8 characters.
[out] pin String parameter. This is the new generated pin.
[out] errorMsg If an error happpens this string contains the error message. In case an error has happened (this variable contains a valid non-empty string) then the return value will not contain any usable data, do not try to parse it as an xml.
return value If the errorMsg variable is null or empty then the returned string contains the requested data in xml format. The xml has the following structure:
<?xml version="1.0" encoding="utf-16"?>
<root>
<PIN>
  < PIN"newpin" error="" />
</PIN>
</root>
Please note this.

Remarks

Minimum R-COM Database version

0.2009

Error messages

Please see this page.