UserAdd_API

Syntax

ItemResult BM::UserAdd_API(

  Int AccountID;

  Int ExternalID;

  Str(64) Login;

  Str(32) Password;

  Str(30) FName;

  Str(30) MName;

  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 AddFARole.

)

returns

  Int UsersID – created user ID.

Special Notes

Important:
1. Sensitive data is passed to the method. To avoid logging of sensitive data, the Password argument 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.

2. UserID is returned if the method is executed under user credentials.

• Int AccountID – customer account ID. In case Billing is integrated with Operations, it is crucial that account ID falls into range from 1000000 exclusive to 2147483647 inclusive; otherwise it may cause issues with provisioning;
• Int ExternalID – user's identifier for external system. If there is no ID for external system, should be passed '0';
• Str(64) Login – customer user login;
• Str(32) Password – user's password;
• 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 AddFARole – signifies whether Full Access role is assigned to created user (0 – No, 1 – Yes).