com.psoft.hsphere.axis
Interface AdminServices_PortType

All Superinterfaces:
java.rmi.Remote

public interface AdminServices_PortType
extends java.rmi.Remote


Method Summary
 void addCredit(AuthToken at, long accountId, double amount, java.lang.String description, java.lang.String text, java.lang.String id)
          Adds credit for the account.
Credited amounts are never added to credit card balances.
 void billingPeriodBasedDebit(AuthToken at, long accountId, double amount, java.lang.String description, java.lang.String note, java.lang.String adminNote)
          Adds debit for the account.
 void changeDiskUsage(AuthToken at, long accountId, double value)
          Changes disk usage (summary quota) value for an account
 void changeFTPPassword(AuthToken at, java.lang.String newPassword)
          Changes user FTP password for the user from AuthToken
 void changePassword(AuthToken at, java.lang.String newPassword)
          Changes password for the user from AuthToken
 void changePlan(AuthToken at, int planId, int periodId)
          Changes plan for the user from AuthToken
 void changeQuota(AuthToken at, long accountId, double value)
          Changes quota value for the account.
 void changeTraffic(AuthToken at, long accountId, double value)
          Changes value of the account traffic resource for the account
 boolean checkUser(AuthToken at, java.lang.String login)
          Checks if a user login already exists in the system.
 void deleteAccount(AuthToken at, long accountId)
          Deletes the account.
 long[] getAccounts(AuthToken at)
          Returns an array of account identifiers for the user from AuthToken
 java.lang.String getDescription()
           
 double getDiskUsage(AuthToken at, long accountId)
          Returns disk usage (summary quota) amount for an account

 java.lang.String[] getDomains(AuthToken at)
          Returns list of domains for the user from AuthToken
 int getPeriodId(AuthToken at)
          Returns plan period ID for the user from AuthToken
 java.lang.Object[] getPlan(AuthToken at)
          Returns plan properties for the user from AuthToken
 java.lang.Object[] getPlanPeriodIds(AuthToken at, int planId)
          Returns plan period IDs for the user from AuthToken
 java.lang.Object[] getPlans(AuthToken at)
          Returns plan list accessible for the user from AuthToken
 double getQuota(AuthToken at, long accountId)
          Returns quota resource value for the account
 double getTraffic(AuthToken at, long accountId)
          Returns amount of the account traffic
 boolean isAccountSuspended(AuthToken at, long accountId)
          Checks if the account is suspended in the system.
 boolean isAccountTransferrable(long accountId, long targetServerId)
          Checks if account can be transferred to another logical server.
 void monthlyBasedDebit(AuthToken at, long accountId, double amount, int duration, int frequency, java.lang.String description, java.lang.String note, java.lang.String adminNote, int startOn, boolean isInfinite, boolean isInvoice)
          Adds debit for the account.
In this case accounts will be debited every month for regular premium services.
 void oneTimeDebit(AuthToken at, long accountId, double amount, java.lang.String description, java.lang.String note, boolean isInvoice, boolean inclTaxes)
          Adds debit for the account.
 void resumeAccount(AuthToken at, long accountId)
          Resumes the account.
If by the time you are resuming the account, the billing period when it was suspended has ended, a new billing period is open and outstanding recurrent fees are accrued.
If you resume an expired trial account, it will be automatically suspended again within 24 hours.
 java.lang.String searchAccIdBySignupId(long signupId)
          Searches account ID by user's signup ID
 UserInfo[] searchByContactInfo(AuthToken at, java.lang.String firstName, java.lang.String lastName, java.lang.String company, java.lang.String city, java.lang.String state, java.lang.String postalCode, java.lang.String country)
          Search by Contact Info
 UserInfo[] searchByDomainName(AuthToken at, java.lang.String domainName, int emailTypeForMassMail)
          Search by Domain Name.
 UserInfo[] searchDeletedAccounts(AuthToken at, java.lang.String bilingType, java.lang.String plan, java.lang.String accountId, java.lang.String email, int emailTypeForMassMail, java.lang.String regFrom, java.lang.String regTo, java.lang.String delFrom, java.lang.String delTo)
          Searches deleted accounts
 UserInfo[] searchGeneric(AuthToken at, java.lang.String bilingType, java.lang.String suspended, java.lang.String plan, java.lang.String userName, java.lang.String accountId, java.lang.String email, int emailTypeForMassMail, java.lang.String regFrom, java.lang.String regTo)
          Generic Search.
 UserInfo[] searchInResellersDomains(AuthToken at, java.lang.String domainName, int emailTypeForMassMail)
          Search all acounts including accounts under resellers by domain name.
 UserInfo[] searchInResellersUsers(AuthToken at, java.lang.String reseller, java.lang.String accountId, java.lang.String user, java.lang.String email, int emailTypeForMassMail, java.lang.String regFrom, java.lang.String regTo)
          Searches account under a specific reseller.
 UserInfo[] searchSuspended(AuthToken at, java.lang.String bilingType, java.lang.String plan, java.lang.String accountId, java.lang.String user, java.lang.String email, int emailTypeForMassMail, java.lang.String regFrom, java.lang.String regTo, java.lang.String suspendedFrom, java.lang.String suspendedTo)
          Searches suspended users
 java.lang.String searchUserIdBySignupId(long signupId)
          Searches user ID by user's signup ID.
 UserInfo[] searchUsers(AuthToken at, java.lang.String group, java.lang.String physicalServer, java.lang.String logicalServer)
          Searches by Logical and Physical Servers
 NamedParameter[] signupUser(AuthToken at, int planId, int periodId, java.lang.String login, java.lang.String password, java.lang.String descr, ContactInfo ci, ContactInfo bi, ContactInfo srsci, ContactInfo srsbi, PaymentInfo pi, boolean validateUser, java.lang.String mod, NamedParameter[] otherParams)
          Signup the user
 NamedParameter[] signupUser(AuthToken at, int planId, int periodId, java.lang.String login, java.lang.String password, java.lang.String descr, ContactInfo ci, ContactInfo bi, PaymentInfo pi, boolean validateUser)
          Signups a user under admin user from AuthToken
 NamedParameter[] signupUser(AuthToken at, int planId, int periodId, java.lang.String login, java.lang.String password, java.lang.String descr, ContactInfo ci, ContactInfo bi, PaymentInfo pi, boolean validateUser, java.lang.String mod, NamedParameter[] otherParams)
          Signups a user under admin user from AuthToken
 NamedParameter[] signupUserEmpty(AuthToken at, int planId, int periodId, java.lang.String login, java.lang.String password, java.lang.String descr, ContactInfo ci, ContactInfo bi, PaymentInfo pi, boolean validateUser)
          Signups a user under admin user from AuthToken
 NamedParameter[] signupUserFull(AuthToken at, int planId, int periodId, java.lang.String login, java.lang.String password, java.lang.String descr, ContactInfo ci, ContactInfo bi, ContactInfo srsci, ContactInfo srsbi, PaymentInfo pi, boolean validateUser, java.lang.String mod, NamedParameter[] otherParams)
          Signup the user
 NamedParameter[] signupUserWithoutRegistrarInfo(AuthToken at, int planId, int periodId, java.lang.String login, java.lang.String password, java.lang.String descr, ContactInfo ci, ContactInfo bi, PaymentInfo pi, boolean validateUser, java.lang.String mod, NamedParameter[] otherParams)
          Signup the user without registrar info.
 void startAccountMove(AuthToken at, long srcServerId, long targetServerId, long accountId)
          Starts process of account content moving from one to another logical server.
 void suspendAccount(AuthToken at, long accountId, java.lang.String reason)
          Suspends the account.
 

Method Detail

getDomains

java.lang.String[] getDomains(AuthToken at)
                              throws java.rmi.RemoteException
Returns list of domains for the user from AuthToken

Parameters:
at - User authentication information
Returns:
array with domain names for the user from AuthToken
Throws:
java.lang.Exception
java.rmi.RemoteException

getDescription

java.lang.String getDescription()
                                throws java.rmi.RemoteException
Throws:
java.rmi.RemoteException

getPlan

java.lang.Object[] getPlan(AuthToken at)
                           throws java.rmi.RemoteException
Returns plan properties for the user from AuthToken

Parameters:
at - User authentication information
Returns:
array with plan information. Contains 2 elements in the following sequence: Integer plan ID, String plan description
Throws:
java.lang.Exception
java.rmi.RemoteException

getPlans

java.lang.Object[] getPlans(AuthToken at)
                            throws java.rmi.RemoteException
Returns plan list accessible for the user from AuthToken

Parameters:
at - User authentication information
Returns:
array with plans information, each element is array of 2 elements in the following sequence: Integer plan ID, String plan description
Throws:
java.lang.Exception
java.rmi.RemoteException

getPeriodId

int getPeriodId(AuthToken at)
                throws java.rmi.RemoteException
Returns plan period ID for the user from AuthToken

Parameters:
at - User authentication information
Returns:
account plan period ID
Throws:
java.lang.Exception
java.rmi.RemoteException

signupUser

NamedParameter[] signupUser(AuthToken at,
                            int planId,
                            int periodId,
                            java.lang.String login,
                            java.lang.String password,
                            java.lang.String descr,
                            ContactInfo ci,
                            ContactInfo bi,
                            PaymentInfo pi,
                            boolean validateUser)
                            throws java.rmi.RemoteException
Signups a user under admin user from AuthToken

Parameters:
at - Admin user authentication information
planId - plan ID
periodId - plan period ID
login - user login. 5-20 characters, starts with a letter
password - user password. Length 5 to 12 chars. The login and the password must be different. Simple passwords are not allowed.
descr - user description
ci - user contact info
bi - user billing info
pi - user payment info
validateUser -
true - validate user (check is plan available for signup,
false - force account creation
Returns:
array, each element is hash of 3 elements in the following sequence:
"signupId" - String created user's signup ID
"accountId" - String created user's account ID
"userId" - String created user's ID
Throws:
java.lang.Exception
java.rmi.RemoteException

signupUser

NamedParameter[] signupUser(AuthToken at,
                            int planId,
                            int periodId,
                            java.lang.String login,
                            java.lang.String password,
                            java.lang.String descr,
                            ContactInfo ci,
                            ContactInfo bi,
                            PaymentInfo pi,
                            boolean validateUser,
                            java.lang.String mod,
                            NamedParameter[] otherParams)
                            throws java.rmi.RemoteException
Signups a user under admin user from AuthToken

Parameters:
planId - plan ID
periodId - plan period ID
login - user login. 5-20 characters, starts with a letter
password - user password. Length 5 to 12 chars. The login and the password must be different. Simple passwords are not allowed.
descr - user description
ci - user contact info
bi - user billing info
pi - user payment info
validateUser - true - validate user (check is plan available for signup,
false - force account creation
mod - plan modifier for account creation
otherParams - other signup parameters
Returns:
array, each element is hash of 3 elements in the following sequence:
"signupId" - String created user's signup ID
"accountId" - String created user's account ID
"userId" - String created user's ID
Throws:
java.lang.Exception
java.rmi.RemoteException

signupUser

NamedParameter[] signupUser(AuthToken at,
                            int planId,
                            int periodId,
                            java.lang.String login,
                            java.lang.String password,
                            java.lang.String descr,
                            ContactInfo ci,
                            ContactInfo bi,
                            ContactInfo srsci,
                            ContactInfo srsbi,
                            PaymentInfo pi,
                            boolean validateUser,
                            java.lang.String mod,
                            NamedParameter[] otherParams)
                            throws java.rmi.RemoteException
Signup the user

Parameters:
at - admin user authentication information
planId - account's plan ID
periodId - billing period ID
login - user login. 5-20 characters, starts with a letter
password - user password. Length 5 to 12 chars. The login and the password must be different. Simple passwords are not allowed.
descr - user description
ci - user contact info
bi - user billing info
srsci - user contact info for registrar
srsbi - user billing info for registrar
pi - user payment info
validateUser - true - validate user (check is plan available for signup,
false - force account creation
mod - plan modifier for account creation
otherParams - other signup parameters
Returns:
array, each element is hash of 3 elements in the following sequence:
"signupId" - String created user's signup ID
"accountId" - String created user's account ID
"userId" - String created user's ID
Throws:
java.lang.Exception
java.rmi.RemoteException

changePassword

void changePassword(AuthToken at,
                    java.lang.String newPassword)
                    throws java.rmi.RemoteException
Changes password for the user from AuthToken

Parameters:
at - User authentication information
newPassword - New user password. Length 5 to 12 chars. The login and the password must be different. Simple passwords are not allowed.
Throws:
java.lang.Exception
java.rmi.RemoteException

changePlan

void changePlan(AuthToken at,
                int planId,
                int periodId)
                throws java.rmi.RemoteException
Changes plan for the user from AuthToken

Parameters:
at - User authentication information
planId - new plan ID
periodId - new period ID
Throws:
java.lang.Exception
java.rmi.RemoteException

addCredit

void addCredit(AuthToken at,
               long accountId,
               double amount,
               java.lang.String description,
               java.lang.String text,
               java.lang.String id)
               throws java.rmi.RemoteException
Adds credit for the account.
Credited amounts are never added to credit card balances. H-Sphere can't put money on credit cards. Instead, credited amounts are put on the account balance.

Parameters:
at - admin user authentication information
accountId - account ID
amount - amount of credit. don't enter negative amounts; instead, debit the account.
description - the reason for crediting the account. It can be CHECK, MANUAL CC, PROMOTION, OTHER
text - the explanation to the transaction that will show up in the invoice and the balance statement.
id - id of credit (up to 255 symbols)
Throws:
java.lang.Exception
java.rmi.RemoteException

suspendAccount

void suspendAccount(AuthToken at,
                    long accountId,
                    java.lang.String reason)
                    throws java.rmi.RemoteException
Suspends the account.
Account suspension closes user access to their control panel, but on the contrary to removing account, preserves its content and configuration. Starting with version 2.08 visitors to suspended sites are redirected to the predefined Suspended account page in the /hsphere/shared/skel/suspended/ directory. If you edit this page, back it up as it is overwritten with system updates .
In version 2.4 and higher account suspension doesn't close billing period. As a result:
- recurrent fees are not refunded. In earlier versions account suspension interrupts billing period and recurrent fees for the unused resources are refunded.
- user files remain on disk. This may lead to average summary disk usage exceed its limit and user be charged usage fees for exsessive MB.
Owners of suspended accounts get e-mail notifications, and can view their invoices and billing profiles.
In version 2.4 and higher owners of suspended accounts get e-mail notifications only at the e-mail specified in the "Billing info" in their user control panel.

Parameters:
at - admin user authentication information
accountId - account ID to suspend. Integer value
reason - suspension reason
Throws:
java.lang.Exception
java.rmi.RemoteException

getAccounts

long[] getAccounts(AuthToken at)
                   throws java.rmi.RemoteException
Returns an array of account identifiers for the user from AuthToken

Parameters:
at - Admin user authentication information
Returns:
array of account IDs that belong to the admin
Throws:
java.lang.Exception
java.rmi.RemoteException

getTraffic

double getTraffic(AuthToken at,
                  long accountId)
                  throws java.rmi.RemoteException
Returns amount of the account traffic

Parameters:
at - admin user authentication information
accountId - ID of account the traffic amount is returned for. Integer value
Returns:
traffic amount
Throws:
java.lang.Exception
java.rmi.RemoteException

deleteAccount

void deleteAccount(AuthToken at,
                   long accountId)
                   throws java.rmi.RemoteException
Deletes the account.
Even after account is deleted, contact and billing information about this user still remains in H-Sphere database and so sometimes will appear in reports.
Warning: When deleting a reseller account, make sure to delete this reseller's customers first.

Parameters:
at - admin user authentication information
accountId - account ID to delete. Integer value
Throws:
java.lang.Exception
java.rmi.RemoteException

getQuota

double getQuota(AuthToken at,
                long accountId)
                throws java.rmi.RemoteException
Returns quota resource value for the account

Parameters:
at - admin user authentication information
accountId - account ID the amount of quota is returned for. Integer value
Returns:
quota value for the account
Throws:
java.lang.Exception
java.rmi.RemoteException

changeQuota

void changeQuota(AuthToken at,
                 long accountId,
                 double value)
                 throws java.rmi.RemoteException
Changes quota value for the account.

Parameters:
at - admin user authentication information
accountId - account ID the amount of quota is planning to change for. Integer value
value - quota value the account is changed to.
Throws:
java.lang.Exception
java.rmi.RemoteException

getPlanPeriodIds

java.lang.Object[] getPlanPeriodIds(AuthToken at,
                                    int planId)
                                    throws java.rmi.RemoteException
Returns plan period IDs for the user from AuthToken

Parameters:
at - User authentication information
planId - User plan ID
Returns:
array, each element is array of 3 elements in the following sequence: Integer period ID, String period type (DAY, WEEK, MONTH, YEAR) String period size
Throws:
java.lang.Exception
java.rmi.RemoteException

changeFTPPassword

void changeFTPPassword(AuthToken at,
                       java.lang.String newPassword)
                       throws java.rmi.RemoteException
Changes user FTP password for the user from AuthToken

Parameters:
at - User authentication information
newPassword - new user ftp password. Length 5 to 12 chars. The login and the password must be different. Simple passwords are not allowed.
Throws:
java.lang.Exception
java.rmi.RemoteException

signupUserEmpty

NamedParameter[] signupUserEmpty(AuthToken at,
                                 int planId,
                                 int periodId,
                                 java.lang.String login,
                                 java.lang.String password,
                                 java.lang.String descr,
                                 ContactInfo ci,
                                 ContactInfo bi,
                                 PaymentInfo pi,
                                 boolean validateUser)
                                 throws java.rmi.RemoteException
Signups a user under admin user from AuthToken

Parameters:
planId - plan ID
periodId - plan period ID
login - user login. 5-20 characters, starts with a letter
password - user password. Length 5 to 12 chars. The login and the password must be different. Simple passwords are not allowed.
descr - user description
ci - user contact info
bi - user billing info
pi - user payment info
validateUser -
true - validate user (check is plan available for signup,
false - force account creation
Returns:
array, each element is hash of 3 elements in the following sequence:
"signupId" - String created user's signup ID
"accountId" - String created user's account ID
"userId" - String created user's ID
Throws:
java.lang.Exception
java.rmi.RemoteException

signupUserWithoutRegistrarInfo

NamedParameter[] signupUserWithoutRegistrarInfo(AuthToken at,
                                                int planId,
                                                int periodId,
                                                java.lang.String login,
                                                java.lang.String password,
                                                java.lang.String descr,
                                                ContactInfo ci,
                                                ContactInfo bi,
                                                PaymentInfo pi,
                                                boolean validateUser,
                                                java.lang.String mod,
                                                NamedParameter[] otherParams)
                                                throws java.rmi.RemoteException
Signup the user without registrar info.

Parameters:
at - admin user authentication information
planId - account's plan ID
periodId - billing period ID
login - user login. 5-20 characters, starts with a letter
password - user password. Length 5 to 12 chars. The login and the password must be different. Simple passwords are not allowed.
descr - user description
ci - user contact info
bi - user billing info
pi - user payment info
validateUser - true - validate user (check is plan available for signup,
false - force account creation
mod - plan modifier for account creation
otherParams - other signup parameters
Returns:
array, each element is hash of 3 elements in the following sequence:
"signupId" - String created user's signup ID
"accountId" - String created user's account ID
"userId" - String created user's ID
Throws:
java.lang.Exception
java.rmi.RemoteException

signupUserFull

NamedParameter[] signupUserFull(AuthToken at,
                                int planId,
                                int periodId,
                                java.lang.String login,
                                java.lang.String password,
                                java.lang.String descr,
                                ContactInfo ci,
                                ContactInfo bi,
                                ContactInfo srsci,
                                ContactInfo srsbi,
                                PaymentInfo pi,
                                boolean validateUser,
                                java.lang.String mod,
                                NamedParameter[] otherParams)
                                throws java.rmi.RemoteException
Signup the user

Parameters:
at - admin user authentication information
planId - account's plan ID
periodId - billing period ID
login - user login. 5-20 characters, starts with a letter
password - user password. Length 5 to 12 chars. The login and the password must be different. Simple passwords are not allowed.
descr - user description
ci - user contact info
bi - user billing info
srsci - user contact info for registrar
srsbi - user billing info for registrar
pi - user payment info
validateUser - true - validate user (check is plan available for signup,
false - force account creation
mod - plan modifier for account creation
otherParams - other signup parameters
Returns:
array, each element is hash of 3 elements in the following sequence:
"signupId" - String created user's signup ID
"accountId" - String created user's account ID
"userId" - String created user's ID
Throws:
java.lang.Exception
java.rmi.RemoteException

searchUsers

UserInfo[] searchUsers(AuthToken at,
                       java.lang.String group,
                       java.lang.String physicalServer,
                       java.lang.String logicalServer)
                       throws java.rmi.RemoteException
Searches by Logical and Physical Servers

Parameters:
at - admin user authentication information
group - logical server group ID
empty value - search by any server group
physicalServer - physical server ID
empty value - search by any server
logicalServer - logical server ID
empty value - search by any server
Returns:
array of UserInfo
Throws:
java.lang.Exception
java.rmi.RemoteException

searchDeletedAccounts

UserInfo[] searchDeletedAccounts(AuthToken at,
                                 java.lang.String bilingType,
                                 java.lang.String plan,
                                 java.lang.String accountId,
                                 java.lang.String email,
                                 int emailTypeForMassMail,
                                 java.lang.String regFrom,
                                 java.lang.String regTo,
                                 java.lang.String delFrom,
                                 java.lang.String delTo)
                                 throws java.rmi.RemoteException
Searches deleted accounts

Parameters:
at - admin user authentication information
bilingType - billing type.
empty value - find accounts with any billing type
"CC" - credit card
"Check" - check
"none" - search account without billing
"Trial" - find trial accounts
plan - plan ID
accountId - deleted account ID
email - contact email
emailTypeForMassMail - 0 - email from dontact info
1 - email from billing info
regFrom - start date of account registration. Format: YYYY/MM/DD
regTo - end date of account registration. Format: YYYY/MM/DD
delFrom - start date of account deletion. Format: YYYY/MM/DD
delTo - start date of account deletion. Format: YYYY/MM/DD
Returns:
array of UserInfo
Throws:
java.lang.Exception
java.rmi.RemoteException

searchSuspended

UserInfo[] searchSuspended(AuthToken at,
                           java.lang.String bilingType,
                           java.lang.String plan,
                           java.lang.String accountId,
                           java.lang.String user,
                           java.lang.String email,
                           int emailTypeForMassMail,
                           java.lang.String regFrom,
                           java.lang.String regTo,
                           java.lang.String suspendedFrom,
                           java.lang.String suspendedTo)
                           throws java.rmi.RemoteException
Searches suspended users

Parameters:
at - admin user authentication information
bilingType - billing type.
empty value - find accounts with any billing type
"CC" - credit card
"Check" - check
"none" - search account without billing
"Trial" - find trial accounts
plan - plan ID
accountId - account ID
user - username
email - contact email
emailTypeForMassMail - 0 - email from dontact info
1 - email from billing info
regFrom - start date of account registration. Format: YYYY/MM/DD
regTo - end date of account registration. Format: YYYY/MM/DD
suspendedFrom - start date of account suspension. Format: YYYY/MM/DD
suspendedTo - end date of account suspension. Format: YYYY/MM/DD
Returns:
array of UserInfo
Throws:
java.lang.Exception
java.rmi.RemoteException

searchInResellersUsers

UserInfo[] searchInResellersUsers(AuthToken at,
                                  java.lang.String reseller,
                                  java.lang.String accountId,
                                  java.lang.String user,
                                  java.lang.String email,
                                  int emailTypeForMassMail,
                                  java.lang.String regFrom,
                                  java.lang.String regTo)
                                  throws java.rmi.RemoteException
Searches account under a specific reseller.

Parameters:
at - admin user authentication information
reseller - reseller ID
accountId - accoount ID
user - username
email - contact email
emailTypeForMassMail - 0 - email from dontact info
1 - email from billing info
regFrom - start date of account registration. Format: YYYY/MM/DD
regTo - end date of account registration. Format: YYYY/MM/DD
Returns:
array of UserInfo
Throws:
java.lang.Exception
java.rmi.RemoteException

searchInResellersDomains

UserInfo[] searchInResellersDomains(AuthToken at,
                                    java.lang.String domainName,
                                    int emailTypeForMassMail)
                                    throws java.rmi.RemoteException
Search all acounts including accounts under resellers by domain name.

Parameters:
at - admin user authentication information
domainName - domain name
emailTypeForMassMail - 0 - email from dontact info
1 - email from billing info
Returns:
array of UserInfo
Throws:
java.lang.Exception
java.rmi.RemoteException

searchByContactInfo

UserInfo[] searchByContactInfo(AuthToken at,
                               java.lang.String firstName,
                               java.lang.String lastName,
                               java.lang.String company,
                               java.lang.String city,
                               java.lang.String state,
                               java.lang.String postalCode,
                               java.lang.String country)
                               throws java.rmi.RemoteException
Search by Contact Info

Parameters:
at - admin user authentication information
firstName - First name
lastName - Last name
company - Company
city - City
state - State. Format: 2 letters state code
postalCode - ZIP code
country - Country code. Format: 2 letters coutry code
Returns:
array of UserInfo
Throws:
java.lang.Exception
java.rmi.RemoteException

searchByDomainName

UserInfo[] searchByDomainName(AuthToken at,
                              java.lang.String domainName,
                              int emailTypeForMassMail)
                              throws java.rmi.RemoteException
Search by Domain Name.

Parameters:
at - admin user authentication information
domainName - domain name to search
emailTypeForMassMail - 0 - email from dontact info
1 - email from billing info
Returns:
array of UserInfo
Throws:
java.lang.Exception
java.rmi.RemoteException

searchGeneric

UserInfo[] searchGeneric(AuthToken at,
                         java.lang.String bilingType,
                         java.lang.String suspended,
                         java.lang.String plan,
                         java.lang.String userName,
                         java.lang.String accountId,
                         java.lang.String email,
                         int emailTypeForMassMail,
                         java.lang.String regFrom,
                         java.lang.String regTo)
                         throws java.rmi.RemoteException
Generic Search. Use generic search to find your direct customers, not customers of your resellers.

Parameters:
at - admin user authentication information
bilingType - billing type.
empty value - find accounts with any billing type
"CC" - credit card
"Check" - check
"none" - search account without billing
"Trial" - find trial accounts
suspended - not empty value - search accounts that are suspended
"active" - search only active, not suspended accounts
empty value - search all accounts, suspended and not suspended
plan - plan ID. If this value is empty - search any plan
userName - username
accountId - account ID
email - contact or billing email
emailTypeForMassMail - 0 - email from dontact info
1 - email from billing info
regFrom - start date of account registration. Format: YYYY/MM/DD
regTo - end date of account registration. Format: YYYY/MM/DD
Returns:
array of UserInfo
Throws:
java.lang.Exception
java.rmi.RemoteException

searchAccIdBySignupId

java.lang.String searchAccIdBySignupId(long signupId)
                                       throws java.rmi.RemoteException
Searches account ID by user's signup ID

Parameters:
signupId - user's signup ID
Returns:
account ID
Throws:
java.lang.Exception
java.rmi.RemoteException

searchUserIdBySignupId

java.lang.String searchUserIdBySignupId(long signupId)
                                        throws java.rmi.RemoteException
Searches user ID by user's signup ID.

Parameters:
signupId - signup ID of the user
Returns:
user ID
Throws:
java.lang.Exception
java.rmi.RemoteException

monthlyBasedDebit

void monthlyBasedDebit(AuthToken at,
                       long accountId,
                       double amount,
                       int duration,
                       int frequency,
                       java.lang.String description,
                       java.lang.String note,
                       java.lang.String adminNote,
                       int startOn,
                       boolean isInfinite,
                       boolean isInvoice)
                       throws java.rmi.RemoteException
Adds debit for the account.
In this case accounts will be debited every month for regular premium services.

Parameters:
at - admin user authentication information
accountId - account ID
amount - amount of the debit
duration - when this period expires, debit charges are discontinued. Integer value
frequency - the charge cycle; leave 1 to charge the account every month.
description - the title of the charge displayed in user's billing and balance statements.
note - the comment displayed in small font in user' invoice and balance statement
adminNote - this note won't be visible to the user, for admin's use
startOn - choose one of three options when to start debiting the account:
1 - on the first day of the month, pro-rated. account is debited on the 1st of each charge cycle, except for the first time. The first debit charge is conformed with the time left to the end of the charge cycle.
Example: enabled - 20 April; frequency - 2 months; price - $6
On 20 April the first debit charge will be applied. Account will be charged $4 ($3 for May + $1 for ten days of April). The next debit charge ($6) will be applied on 1 June
2 - on the first day of the month. account is debited on the 1st of each charge cycle. The whole debit amount is charged without being pro-rated.
Example: enabled - 20 April; frequency - 2 months; price - $6
On 20 April the first debit charge will be applied. Account will be charged $6. Next $6 charge will occur on 1 June.
3- right now. account is debited on the day you enabled it each charge cycle.
Example: enabled - 20 April; frequency - 2 months; price - $6
On 20 April the account will be debited $6. Next $6 charge will occur on 20 June, then on 20 August, and so on.
isInfinite - true - infinite debit
false - debit has some duration
isInvoice - true - send invoice to the user about this debit
false - do not send invoice
Throws:
java.lang.Exception
java.rmi.RemoteException

billingPeriodBasedDebit

void billingPeriodBasedDebit(AuthToken at,
                             long accountId,
                             double amount,
                             java.lang.String description,
                             java.lang.String note,
                             java.lang.String adminNote)
                             throws java.rmi.RemoteException
Adds debit for the account. In this case accounts will be debited at the beginning of each billing period for regular premium services.

Parameters:
at - admin user authentication information
accountId - account ID
amount - amount of billing period based debit
description - the title of the charge displayed in user' billing and balance statement.
note - the comment displayed in small font in user's billing and balance statement.
adminNote - this note won't show to the user, for admin's use.
Throws:
java.lang.Exception
java.rmi.RemoteException

oneTimeDebit

void oneTimeDebit(AuthToken at,
                  long accountId,
                  double amount,
                  java.lang.String description,
                  java.lang.String note,
                  boolean isInvoice,
                  boolean inclTaxes)
                  throws java.rmi.RemoteException
Adds debit for the account. With this type of debit an account will be debited once.

Parameters:
at - admin user authentication information
accountId - account ID
amount - amount of one-time debit
description - the title of the charge displayed in user' billing and balance statements.
note - the comment displayed in small font in user' invoice and balance statement.
isInvoice - true - send invoice to the user about this debit
false - do not send invoice
inclTaxes - true - apply taxes to this debit.
false - do not apply taxes to this debit.
Throws:
java.lang.Exception
java.rmi.RemoteException

resumeAccount

void resumeAccount(AuthToken at,
                   long accountId)
                   throws java.rmi.RemoteException
Resumes the account.
If by the time you are resuming the account, the billing period when it was suspended has ended, a new billing period is open and outstanding recurrent fees are accrued.
If you resume an expired trial account, it will be automatically suspended again within 24 hours. To bring this account into operation, the trial user should create a valid billing profile.

Parameters:
at - admin user authentication information
accountId - account ID to resume. Integer value
Throws:
java.lang.Exception
java.rmi.RemoteException

changeTraffic

void changeTraffic(AuthToken at,
                   long accountId,
                   double value)
                   throws java.rmi.RemoteException
Changes value of the account traffic resource for the account

Parameters:
at - admin user authentication information
accountId - ID of account the traffic amount is changed for. Integer value
value - new traffic value the account is changed to. Numeric value
Throws:
java.lang.Exception
java.rmi.RemoteException

changeDiskUsage

void changeDiskUsage(AuthToken at,
                     long accountId,
                     double value)
                     throws java.rmi.RemoteException
Changes disk usage (summary quota) value for an account

Parameters:
at - admin user authentication information
accountId - ID of account the value of disk usage is changed for. Integer value
value - value of disk usage the account is changed to. Non-negative integer value
Throws:
java.lang.Exception
java.rmi.RemoteException

getDiskUsage

double getDiskUsage(AuthToken at,
                    long accountId)
                    throws java.rmi.RemoteException
Returns disk usage (summary quota) amount for an account

Parameters:
at - admin user authentication information
accountId - account ID the disk usage is calculated for. Integer value
Returns:
disk usage amount
Throws:
java.lang.Exception
java.rmi.RemoteException

isAccountSuspended

boolean isAccountSuspended(AuthToken at,
                           long accountId)
                           throws java.rmi.RemoteException
Checks if the account is suspended in the system.

Parameters:
at - admin user authentication information
accountId - checked account ID. Integer value
Returns:
true if the account with specified ID is suspended
false if the account isn't suspended
Throws:
java.lang.Exception
java.rmi.RemoteException

checkUser

boolean checkUser(AuthToken at,
                  java.lang.String login)
                  throws java.rmi.RemoteException
Checks if a user login already exists in the system.

Parameters:
at - admin user authentication
login - user login that is checked. 5-20 characters, starts with a letter
Returns:
true if specified user login already exists
false if such user login doesn'ty exist
Throws:
java.lang.Exception
java.rmi.RemoteException

isAccountTransferrable

boolean isAccountTransferrable(long accountId,
                               long targetServerId)
                               throws java.rmi.RemoteException
Checks if account can be transferred to another logical server.

Parameters:
accountId - ID of checked account. Integer value
targetServerId - ID of the logical server where account is planning yo move
Returns:
true if account can be transferred
false if account can't be moved to the logical server
Throws:
java.lang.Exception
java.rmi.RemoteException

startAccountMove

void startAccountMove(AuthToken at,
                      long srcServerId,
                      long targetServerId,
                      long accountId)
                      throws java.rmi.RemoteException
Starts process of account content moving from one to another logical server.

Parameters:
at - admin user authentication
srcServerId - ID of the source logical server. Integer value
targetServerId - ID of the target logical server. Integer value
accountId - ID of account that planning to be moved. Integer value
Throws:
java.lang.Exception
java.rmi.RemoteException


Copyright © 2005 Positive Software Corporation. All Rights Reserved.