Dell PowerConnect W Clearpass 100 Software XMLRPC Interface TechNote - Page 14

Method amigopod.guest.edit

Page 14 highlights

amigopod XMLRPC Interface Version 0.9 Return Values NOTE This function may return a Boolean false value if some input parameters are invalid. Name error message item uid *_error *_error_flag Type Flag String Struct Integer String Flag Description Set to 1 if the account was not deleted Message describing the success or failure of the operation User structure containing updated field values ID of the guest account Field-specific error message Field-specific error flag, set to 1 if present Access Control Requires the remove_account privilege (GuestManager Accounts). Remove Example Usage Sample parameters for call: 'uid' => '162', 'delete_account' => '0', Result returned by a successful operation: 'error' => 0, 'message' => 'Disabled guest account ', 'item' => array ( 'id' => 162, 'enabled' => 0, 'username' => '', ), Result returned by a failed operation: 'uid' => 162, 'username' => '', 'expiration_time' => '', 'user_enabled' => '', 'delete_account_error' => 'Please choose from one of these options.', 'delete_account_error_flag' => 1, 'error' => 1, Method amigopod.guest.edit Change one or more properties of a guest account. Parameters Name uid Type Description Integer ID of the guest account to edit CONFIDENTIAL 14

  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8
  • 9
  • 10
  • 11
  • 12
  • 13
  • 14
  • 15
  • 16
  • 17
  • 18
  • 19
  • 20
  • 21

amigopod XMLRPC Interface
Version 0.9
CONFIDENTIAL
14
Return Values
NOTE
This function may return a Boolean
false
value if some input parameters are
invalid.
Name
Type
Description
error
Flag
Set to 1 if the account was not deleted
message
String
Message describing the success or
failure of the operation
item
Struct
User structure containing updated field
values
uid
Integer
ID of the guest account
*_error
String
Field-specific error message
*_error_flag
Flag
Field-specific error flag, set to 1 if present
Access Control
Requires the
remove_account
privilege (GuestManager
±
Remove
Accounts).
Example Usage
Sample parameters for call:
'uid' => '162',
'delete_account' => '0',
Result returned by a successful operation:
'error' => 0,
'message' => 'Disabled guest account ',
'item' =>
array (
'id' => 162,
'enabled' => 0,
'username' => '',
),
Result returned by a failed operation:
'uid' => 162,
'username' => '',
'expiration_time' => '',
'user_enabled' => '',
'delete_account_error' => 'Please choose from one of these options.',
'delete_account_error_flag' => 1,
'error' => 1,
Method amigopod.guest.edit
Change one or more properties of a guest account.
Parameters
Name
Type
Description
uid
Integer
ID of the guest account to edit