getAccessAccountViaUniqueID() Method

Table of Contents

  1. Function
  2. Syntax
  3. Parameters
  4. Return Value
  5. Sample Code
  6. Remarks
  7. Possible Errors
  8. Alternate Methods
  9. Related Methods

Function

  • Returns an operator’s access account informational structure

Syntax

  • AeAccessAccount = AeXMLBridge.getAccessAccountViaUniqueID(UniqueID);

Parameters

  • Integer - UniqueID

Return Value

Sample Code

C#

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
TAeAccessAccount[] accounts = ws.getAccessAccounts();                     
 // retrieve a list of access accounts (if uniqueID is unknown)
 
foreach (TAeAccessAccount accessAcct in accounts)                          
// iterate through the list to find the uniqueID you want

{
   try
   {
      TAeAccessAccount account = ws.getAccessAccountViaUniqueID(accessAcct.UniqueID);
   }
   catch (Exception ex)
   {
      MessageBox.Show(ex.Message);
   }
}

VB.Net

1
2
3
4
5
6
7
8
9
10
11
12
Dim accounts As TAeAccessAccount() = ws.getAccessAccounts()
' retrieve a list of access accounts (if uniqueID is unknown)
 
For Each accessAcct As TAeAccessAccount In accounts
' iterate through the list to find the uniqueID you want

    Try
        Dim account As TAeAccessAccount = ws.getAccessAccountViaUniqueID(accessAcct.UniqueID)
    Catch ex As Exception
        MessageBox.Show(ex.Message)
    End Try
Next

Remarks

  • Use getAccessAccounts) to retrieve a list of access accounts which contain the UniqueID parameter needed
  • Account returned executing the method will not display the password value

Possible Errors

  • Account with Unique ID not found in system

Alternate Methods

getAccessAccountViaAccountCode

accessAccountCodeExists
addAccessAccount
addAccessAccountWorkgroupAccessRightByAccountCode
editAccessAccount
getAccessAccounts
getAccessAccountWorkgroupAccessRightsByAccountCode
getCurrentAccessAccount
getEmptyAccessAccount
loadAccessAccountActivitysInRange
removeAccessAccount
removeAccessAccountAllWorkgroupAccessRightsByAccountCode

Back to Top