UserWithIDAdd_API

Description

Parameters

Passed

Returned

This method creates a new user with a specified ID.

Note: The method is obsolete and is left for backward compatibility.

22 1

Syntax

Copy
ErrorMessage BM::UserWithIDAdd_API(

  Int AccountID;

  Str(64) Login;

  Str(32) Password;

  Str(32) ConfirmPassword;

  Str(30) FName;

  Str(30) LName;

  Str(100) Email;

  Str(80) Address1;

  Str(80) Address2;

  Str(40) City;

  Str(80) State;

  Str(10) Zip;

  Str(2) CountryID;

  Str(4) PhCountryCode;

  Str(10) PhAreaCode;

  Str(20) PhNumber;

  Str(10) PhExtention;

  Str(4) FaxCountryCode;

  Str(10) FaxAreaCode;

  Str(20) FaxNumber;

  Str(10) FaxExtention;

  Int UsersID.

)

returns

Copy
   Str ErrorMessage –  message after user has been added: "Operation done."

Special Notes

Important: Sensitive data is passed to the method. To avoid logging of sensitive data, the Password and ConfirmPassword arguments must be escaped as this described in the section Important: Avoid Sensitive Data Logging. Avoiding sensitive data is obligatory, otherwise sensitive data will be logged.

  • Int AccountID – customer account ID;
  • Str(64) Login – customer user login;
  • Str(32) Password – user's password;
  • Str(32) ConfirmPassword – password confirmation field;
  • Str(30) FName – user contact information: first name;
  • Str(30) MName – user contact information: middle name;
  • Str(30) LName – user contact information: last name;
  • Str(100) Email – user contact information: e-mail address;
  • Str(80) Address1 – user contact information: address (line 1/2);
  • Str(80) Address2 – user contact information: address (line 2/2);
  • Str(40) City – user contact information: city;
  • Str(80) State – user contact information: state or province;
  • Str(10) Zip – user contact information: zip or postal code. It will be verified through country specific regular expression. You could modify regular expression under countries list in Billing control panel at System > Settings > Internationalization > Countries;
  • Str(2) CountryID – user contact information: two-letter country code, verified against countries list in Billing control panel at System > Settings > Internationalization > Countries;
  • Str(4) PhCountryCode – user contact information: phone country code;
  • Str(10) PhAreaCode – user contact information: phone area code;
  • Str(20) PhNumber – user contact information: phone number;
  • Str(10) PhExtention – user contact information: phone extension;
  • Str(4) FaxCountryCode – user contact information: fax country code;
  • Str(10) FaxAreaCode – user contact information: fax area code;
  • Str(20) FaxNumber – user contact information: fax number;
  • Str(10) FaxExtention – user contact information: fax extension;
  • Int UsersID – ID of customer user.
CloudBlue, an Ingram Micro business, uses cookies to improve the usability of our site. By continuing to use this site and/or logging in you are accepting the use of these cookies. For more information, visit our Privacy Policy.