This web service provides methods that allow you to open, manage and report upon accounts and their sub-accounts
Returns an account balance.<br /><br /><table border=1 width=900px><tr><td align=center width=135><h5>Parameter</h5></td><td align=center><h5>Notes</h5></td></tr><tr><td valign=top>Username:</td><td valign=top> </td></tr><tr><td valign=top>Password:</td><td valign=top> </td></tr><tr><td valign=top>AnyTimeBalance:</td><td valign=top>Provide a decimal data type output parameter. This will be populated with the account's current any time balance.</td></tr><tr><td valign=top>OffPeakBalance:</td><td valign=top>Provide a decimal data type output parameter. This will be populated with the account's current off peak balance.</td></tr><tr><td valign=top>ResultText:</td><td valign=top>E.g. Account balance for your.address@your.company.</td></tr><tr><td valign=top>Code:</td><td valign=top> </td> </tr></table>
Verifies that an account exists.<br /><br /><table border=1 width=900px><tr><td align=center width=135><h5>Parameter</h5></td><td align=center><h5>Notes</h5></td></tr><tr><td valign=top>Username:</td><td valign=top> </td></tr><tr><td valign=top>Password:</td><td valign=top> </td></tr><tr><td valign=top>ResultText:</td><td valign=top>E.g. The account for your.address@your.company was successfully verified.</td></tr><tr><td valign=top>Code:</td><td valign=top> </td></tr></table>
Validates an account using the validation codes sent after registering.<br /><br /><table border=1 width=900px><tr><td align=center width=135><h5>Parameter</h5></td><td align=center><h5>Notes</h5></td></tr><tr><td valign=top>Username:</td><td valign=top> </td></tr><tr><td valign=top>Password:</td><td valign=top> </td></tr><tr><td valign=top>ValidationCode:</td><td valign=top>This is the code sent to you in two sections after you first create an account. The first is sent by email and the second by text message. Simply join the two sections together and enter them into this parameter.</td></tr><tr><td valign=top>ResultText:</td><td valign=top>E.g. Account for your.address@your.company has been validated.</td></tr><tr><td valign=top>Code:</td><td valign=top> </td></tr></table>
Opens a new account. If you supply values for the ParentUsername and ParentPassword parameter you will create a sub-account.<br /><br /><table border=1 width=900px><tr><td align=center width=135><h5>Parameter</h5></td><td align=center><h5>Notes</h5></td></tr><tr><td valign=top>ParentUsername:</td><td valign=top>This should only be populated if you are creating a sub-account.</td></tr><tr><td valign=top>ParentPassword:</td><td valign=top>This should only be populated if you are creating a sub-account.</td></tr><tr><td valign=top>Username:</td><td valign=top>Provide a valid email address for the account holder.</td></tr><tr><td valign=top>Password:</td><td valign=top>This must be at least 6 or more alphanumeric characters long and contain at least one digit, one upper case and one lower case character.</td></tr><tr><td valign=top>FirstName:</td><td valign=top>The account holder's first name.</td></tr><tr><td valign=top>LastName:</td><td valign=top>The account holder's second name.</td></tr><tr><td valign=top>MobilePhone:</td><td valign=top>Provide a valid mobile device number for the account holder.</td></tr><tr><td valign=top>Company:</td><td valign=top>The account holder's company name.</td></tr><tr><td valign=top>Phone:</td><td valign=top>Provide a valid phone number for the account holder.</td></tr><tr><td valign=top>ResultText:</td><td valign=top>E.g. Account for main.account@company.com was created successfully.</td></tr><tr><td valign=top>Code:</td><td valign=top> </td></tr></table>
Modifies an accounts details.<br /><br /><table border=1 width=900px><tr><td align=center width=135><h5>Parameter</h5></td><td align=center><h5>Notes</h5></td></tr><tr><td valign=top>Username:</td><td valign=top> </td></tr><tr><td valign=top>Password:</td><td valign=top> </td></tr><tr><td valign=top>NewUsername:</td><td valign=top>Modified user name. This should be a valid email address. If you do not wish to modify this parameter set it to null.</td></tr><tr><td valign=top>NewPassword:</td><td valign=top>Modified password. This must be at least 6 or more alphanumeric characters long and contain at least one digit, one upper case and one lower case character.</td></tr><tr><td valign=top>FirstName:</td><td valign=top>Modified first name. If you do not wish to modify this parameter set it to null.</td></tr><tr><td valign=top>LastName:</td><td valign=top>Modified second name. If you do not wish to modify this parameter set it to null.</td></tr><tr><td valign=top>MobilePhone:</td><td valign=top>Modified mobile device number. If you do not wish to modify this parameter set it to null.</td></tr><tr><td valign=top>Phone:</td><td valign=top>Modified phone number. If you do not wish to modify this parameter set it to null.</td></tr><tr><td valign=top>Company:</td><td valign=top>Modified company name. If you do not wish to modify this parameter set it to null.</td></tr><tr><td valign=top>ResultText:</td><td valign=top>E.g. Account for your.address@your.company was successfully updated.</td></tr><tr><td valign=top>Code:</td><td valign=top> </td></tr></table>
Lists a users sub-accounts.<br /><br /><table border=1 width=900px><tr><td align=center width=135><h5>Parameter</h5></td><td align=center><h5>Notes</h5></td></tr><tr><td valign=top>Username:</td><td valign=top> </td></tr><tr><td valign=top>Password:</td><td valign=top> </td></tr><tr><td valign=top>ReportCSV:</td><td valign=top>Provide a string data type output parameter. This will be populated with a CSV standard format string of records containing information about all of the account’s sub-accounts.</td></tr><tr><td valign=top>ResultText:</td><td valign=top>E.g. Account your.address@your.company has 2 sub accounts.</td></tr><tr><td valign=top>Code:</td><td valign=top> </td> </tr></table>
Transfers credits to a sub-account.<br /><br /><table border=1 width=900px><tr><td align=center width=135><h5>Parameter</h5></td><td align=center><h5>Notes</h5></td></tr><tr><td valign=top>Username:</td><td valign=top> </td></tr><tr><td valign=top>Password:</td><td valign=top> </td></tr><tr><td valign=top>SubAccount:</td><td valign=top>Provide the user name of the sub-account you wish to transfer credits to.</td></tr><tr><td valign=top>AnyTimeBalance:</td><td valign=top>Provide a decimal value that represents the number of any time credits you wish to transfer to the sub-account. e.g. 10, -10. A negative balance indicates the transfer of credits back to the parent account from the sub-account.</td></tr><tr><td valign=top>OffPeakBalance:</td><td valign=top>Provide a decimal value that represents the number of off peak credits you wish to transfer to the sub-account. e.g. 10, -10. A negative balance indicates the transfer of credits back to the parent account from the sub-account.</td></tr><tr><td valign=top>ParentAnyTimeBalance:</td><td valign=top>Provide a decimal output parameter. This will be populated with the current any time balance on the parent account.</td></tr><tr><td valign=top>ParentOffPeakBalance:</td><td valign=top>Provide a decimal output parameter. This will be populated with the current off peak balance on the parent account.</td></tr><tr><td valign=top>SubAnyTimeBalance:</td><td valign=top>Provide a decimal output parameter. This will be populated with the number of any time credits on the selected sub-account.</td></tr><tr><td valign=top>SubOffPeakBalance:</td><td valign=top>Provide a decimal output parameter. This will be populated with the number of off peak credits on the selected sub-account.</td></tr><tr><td valign=top>ResultText:</td><td valign=top>E.g. Credits successfully exchanged between your.address@your.company (master account) and sub.account@company.com (sub account).</td></tr><tr><td valign=top>Code:</td><td valign=top> </td> </tr></table>
This web service provides methods that allow you to open, manage and report upon accounts and their sub-accounts