Changes
UserInfo for a
user and
returns an
integer
string
ChangedUserUserInfo
newInfo
The function
overwrites UserInfo
based on the new
UserInfo object.
Returns 1 if Ok, else
returns a negative
integer
ChangeAccountInfoAdmin
Changes
AccountInfo
for a user and
returns an
integer
string
ChangedUserAccountInfo
newInfo
The function
overwrites
AccountInfo based
on the new
AccountInfo object.
Returns 1 if Ok, else
returns a negative
integer
ActivateAccount
Activates a
new or
deactivated
account and
returns an
integer
string Usernamestring
Passwordbool Encrypted
The function
activates an account.
As administrator the
account can be
activated without
Password
DeactivateAccount
Deactivates
one or more
accounts and
returns an
integer
string[] Usernames
The function
deactivates all
accounts in the string
array
DeleteAccount
Deletes one or
more accounts
and returns an
integer
string[] Usernames
bool isReseller
The function deletes
all accounts and
removes all data in
the accounts.
Set 'isReseller' to
true to indicate that
the deleted users are
resellers/groups
ResetPassword
Resets
password and
string Username
The function resets
the password for a
user to ‘Backup01’
7
returns an
integer
ChangePassword
Allows a user
to change a
password and
returns an
integer
string OldPasswordstring
NewPassword
If the token of
request is a normal
user, this user can
change his/her own
password
CreateOwner
Creates a new
storage group
and returns an
integer
OwnerInfo NewInfobool
SetAsDefault
The function creates
a new storage group
Returns 1 if Ok, else
returns a negative
integer
ChangeOwner
Changes a
storage group
and returns an
integer
OwnerInfo NewInfo
The function
changes a storage
group based on an
existing OwnerID in
the OwnerInfo
object.
ChangeDefaultOwner
Sets a storage
group as
default group
string ResellerNamestring
Ownername
The function sets a
default group for an
administrator/reseller
The following descriptions show the required fields when creating or changing information:
UserInfo:
ID (int) - must be set to 0 when editing - Read-only
ParentResellerID (int) - Read-only
UserTypeID (int) - Read-only
ActiveDirectoryGUID - Read-only
ParentReseller (string) - Optional
City (string) - Mandatory
Company (string) - Mandatory
CountryID (integer, 133 is Netherlands) - Mandatory
StateID (integer) - Mandatory if country is US - Optional
AccountInfoID (int) - must be set to 0 when editing - Read-only
UserInfoID (int) - must be set to 0 when editing - Read-only
Status (int) – must be set to 1 - Mandatory
Active (boolean) - Read-only
ChangedBy (string) - Read-only
AccountTypeName (string) - Read-only
AccountType (int) - Mandatory
OwnerID (int) - Mandatory
TrialUser (boolean) - Mandatory
FreeAccount (boolean) - Mandatory
MaxSize (int) - Read-only
UsedSize (long) - must be set to 0 when editing - Read-only
UserProfile (UserProfileType) - Mandatory
StartDate (DateTime) - Mandatory
EndDate (DateTime) - Mandatory
MaxBandwidthUsage (int) - 0 is recommended value - Mandatory
Period (int) – Mandatory in case of provisioning a trial account - Optional
RestoreActive (boolean) – recommended to set to false - Mandatory
HasDigiNotarKey (int) – must be set to 0 when editing - Read-only
DigiNotarKeyIsStored (boolean) - Obsolete
ObjDigiNotarKey (object) - Obsolete
11
HasEncryptionKey (boolean) – must be set to false - Mandatory
MaxVersions (int) – must be set, value 10 is recommended - Obsolete
UserAccountInfo (return objects for GetChildAccountInfo function and is Read-
AccountTypeID (integer) - must be set to 0 when editing - Read-only
TypeName (string) - Mandatory
DescriptionType (string) - Mandatory
IsActive (boolean) - Mandatory
MaxSize (integer) – must be 0 in case of trial account - Mandatory
This paragraph describes important public exception codes that can be thrown if functions are
called incorrectly or the server is not configured properly.
If an exception occurs within BackupAgent logic, the exception type will always be an inherited
SOAPException of type BAServiceException. The Exception message will contain a series of
numbers in the following format:
“BAWSxxx::xxx:: error message”. The first three digits (xxx) will represent the exception type and
is an indicator for the problem. These next three digits will be the specific exception code.
The following table shows all exception codes that can occur in the functions described in this
document:
16
017
001
Error occured creating an account. Most
likely cause is that one of the strings in the
UserInfo or AccountInfo object is too long
to store in the database.
017
017
License does not allow for account creation
through the API
017
other
An exception occured while creating or
updating the account for a user. Most likely
cause is that the token username is not an
administrator or group user.
018
There was a problem sending a notification
email, please check the email server
settings.
004
Bitmap of missing
arguments
Some arguments are missing calling the
function
005
Bitmap of empty string
arguments that are
required
Some required string content is missing or
empty
001
Can only happen if the WebService call is
not a SOAP request
002
A problem occurred caching the user
003
Function indicator
A problem occurred creating a user session.
This occurs if BackupAgent Management
Service is not running
All the information on exceptions is limited to indicate the problem. This is for security reasons.
If the exception information is insufficient, please contact BackupAgent support.
Appendix A - Country codes:
ID CountryName CountryCode
1 Uruguay UY
2 Portugal PT
3 Bolivia BO
4 Fiji Islands FJ
5 Sri Lanka LK
6 Botswana BW
7 Cameroon CM
8 Senegal SN
17
9 Guadeloupe GP
10 Romania RO
11 Paraguay PY
12 Mauritius MU
13 Hungary HU
14 Iceland IS
15 Slovakia SK
16 Barbados BB
17 North Korea KP
18 Algeria DZ
19 Lithuania LT
20 Thailand TH
21 Guernsey GG
22 Spain ES
23 United Arab Emirates AE
24 Egypt EG
25 Togo TG
26 Isle of Man IM
27 Ghana GH
28 Peru PE
29 South Africa ZA
30 New Zealand NZ
31 Mali ML
32 Gambia, the GM
33 Central African Republic CF
34 Cocos (Keeling) Islands CC
35 Bahamas BS
36 Cyprus CY
37 Wallis and Futuna WF
38 Bulgaria BG
39 Turkmenistan TM
40 Russia RU
18
41 Puerto Rico PR
42 Germany DE
43 Guinea GN
44 Antarctica AQ
45 United Kingdom GB
46 Pitcairn Islands PN
47 Rwanda RW
48 Greece GR
49 Afghanistan AF
50 Morocco MA
51 Tristan da Cunha TA
52 Haiti HT
53 Maldives MV
54 Jordan JO
55 Slovenia SI
56 Greenland GL
57 Turkey TR
58 Estonia EE
59 Mauritania MR
60 Bermuda BM
61 Vanuatu VU
62 Venezuela VE
63 Tonga TO
64 Nigeria NG
65 Iran IR
66 Trinidad and Tobago TT
67 Cambodia KH
68 Georgia GE
69 St. Helena SH
70 Falkland Islands (Islas Malvinas) FK
71 El Salvador SV
72 Ireland IE
19
73 Guam GU
74 Cayman Islands KY
75 Palau PW
76 Norfolk Island NF
77 Bahrain BH
78 Grenada GD
79 Sierra Leone SL
80 Nicaragua NI
81 Brunei BN
82 Malaysia MY
83 Nauru NR
84 Ascension Island AC
85 Gibraltar GI
86 China CN
87 Jersey JE
88 Czech Republic CZ
89 Switzerland CH
90 Antigua and Barbuda AG
91 Argentina AR
92 Montserrat MS
93 Belgium BE
94 Ethiopia ET
95 Jamaica JM
96 St. Vincent and The Grenadines VC
97 Belize BZ
98 Myanmar MM
99 Chad TD
100 Mongolia MN
101 Madagascar MG
102 Tanzania TZ
103 Macedonia, former Yugoslav Republic of MK
104 Australia AU
20
105 Indonesia ID
106 San Marino SM
107 Luxembourg LU
108 Guatemala GT
109 Kyrgyzstan KG
110 Benin BJ
111 Liechtenstein LI
112 St. Kitts and Nevis KN
113 Heard Island and Mcdonald Islands HM
114 Dominica DM
115 Timor-leste TP
116 American Samoa AS
117 St. Lucia LC
118 Côte d'Ivoire CI
119 Denmark DK
120 British Indian Ocean Territory IO
121 Virgin Islands, British VG
122 Norway NO
123 Malawi MW
124 Reunion RE
125 Honduras HN
126 Japan JP
127 Tuvalu TV
128 Costa Rica CR
129 Qatar QA
130 Palestinian Authority PS
131 Samoa WS
132 Libya LY
133 Papua New Guinea PG
134 Equatorial Guinea GQ
135 Syria SY
136 Comoros KM
21
137 Nepal NP
138 French Southern and Antarctic Lands TF
139 Namibia NA
140 Malta MT
141 Bhutan BT
142 Philippines PH
143 Iraq IQ
144 French Polynesia PF
145 India IN
146 Northern Mariana Islands MP
147 Ecuador EC
148 Canada CA
149 Poland PL
150 Italy IT
151 St. Pierre and Miquelon PM
152 Taiwan TW
153 Kazakhstan KZ
154 Andorra AD
155 Liberia LR
156 Anguilla AI
157 Congo (drc) CD
158 Guyana GY
159 Bangladesh BD
160 Cook Islands CK
161 Djibouti DJ
162 São Tomé and Príncipe ST
163 Austria AT
164 Niue NU
165 Uganda UG
166 Bosnia and Herzegovina BA
167 Monaco MC
168 French Guiana GF
22
169 Bouvet Island BV
170 Cape Verde CV
171 Zambia ZM
172 South Georgia and The South Sandwich Islands GS
173 Sudan SD
174 Kuwait KW
175 United States Minor Outlying Islands UM
176 Guinea-Bissau GW
177 Christmas Island CX
178 Latvia LV
179 Belarus BY
180 Solomon Islands SB
181 Seychelles SC
182 Kiribati KI
183 Lebanon LB
184 Turks and Caicos Islands TC
185 Suriname SR
186 Finland FI
187 Uzbekistan UZ
188 Croatia HR
189 Lesotho LS
190 Albania AL
191 Virgin Islands, British VG
192 Congo CG
193 Yemen YE
194 France FR
195 Moldova MD
196 Laos LA
197 Panama PA
198 Vietnam VN
199 Mayotte YT
200 Mozambique MZ
23
201 Pakistan PK
202 Serbia and Montenegro YU
203 Netherlands Antilles AN
204 Eritrea ER
205 Burkina Faso BF
206 Cuba CU
207 Sweden SE
208 Tajikistan TJ
209 Brazil BR
210 Netherlands NL
211 Azerbaijan AZ
212 Svalbard and Jan Mayen SJ
213 Armenia AM
214 United States US
215 Israel IL
216 Gabon GA
217 Aruba AW
218 Singapore SG
219 Tokelau TK
220 Mexico MX
221 Vatican City VA
222 Faroe Islands FO
223 Swaziland SZ
224 Ukraine UA
225 Dominican Republic DO
226 Korea KR
227 Oman OM
228 Kenya KE
229 New Caledonia NC
230 Saudi Arabia SA
231 Somalia SO
232 Angola AO
24
233 Burundi BI
234 Tunisia TN
235 Zimbabwe ZW
236 Marshall Islands MH
237 Hong Kong Sar HK
238 Micronesia FM
239 Niger NE
240 Colombia CO
241 Chile CL
242 Martinique MQ
243 Macao Sar MO
244 So Tom and Prncipe ST
Appendix B - US State codes:
ID StateName
1 Alabama
2 Alaska
3 Arizona
4 Arkansas
5 California
6 Colorado
7 Connecticut
8 Delaware
9 Florida
10 Georgia
11 Hawaii
12 Idaho
13 Illinois
14 Indiana
15 Iowa
16 Kansas
25
17 Kentucky
18 Louisiana
19 Maine
20 Maryland
21 Massachusetts
22 Michigan
23 Minnesota
24 Mississippi
25 Missouri
26 Montana
27 Nebraska
28 Nevada
29 New Hampshire
30 New Jersey
31 New Mexico
32 New York
33 North Carolina
34 North Dakota
35 Ohio
36 Oklahoma
37 Oregon
38 Pennsylvania
39 Rhode Island
40 South Carolina
41 South Dakota
42 Tennessee
43 Texas
44 Utah
45 Vermont
46 Virginia
47 Washington
48 West Virginia
26
49 Wisconsin
50 Wyoming
51 District of Columbia
27
Loading...
+ hidden pages
You need points to download manuals.
1 point = 1 manual.
You can buy points or you can get point for every manual you upload.