AMIGOPOD PowerConnect W Clearpass 100 Software Manual
Xmlrpc interface technote
Hide thumbs
Also See for PowerConnect W Clearpass 100 Software:
- Deployment manual (128 pages) ,
- Integration manual (52 pages) ,
- Release note (38 pages)
Table of Contents
Advertisement
Quick Links
Download this manual
See also:
Manual
Advertisement
Table of Contents
Related Manuals for AMIGOPOD PowerConnect W Clearpass 100 Software
Summary of Contents for AMIGOPOD PowerConnect W Clearpass 100 Software
- Page 1 amigopod XMLRPC Interface Unified Visitor Management API CONFIDENTIAL Revision Date 4 December 2007 Copyright © 2007 amigopod Pty Ltd www.amigopod.com...
-
Page 2: Table Of Contents
amigopod XMLRPC Interface Version 0.9 Table of Contents Introduction ........................... 4 Audience ........................... 4 System Requirements ....................... 4 More Information ....................... 4 API Overview ........................5 About the API ........................5 Architecture Overview ....................5 API Symmetry........................ 6 Access Control....................... 6 Parameter Names...................... - Page 3 amigopod XMLRPC Interface Version 0.9 Method amigopod.guest.enable..................17 Parameters ........................17 Return Values ......................17 Access Control......................17 Example Usage ......................17 Method amigopod.guest.get .................... 18 Parameters ........................18 Return Values ......................18 Access Control......................18 Example Usage ......................18 Method amigopod.guest.list.....................
-
Page 4: Introduction
amigopod XMLRPC Interface Version 0.9 Introduction This document describes the XMLRPC interface available to third-party applications that will integrate with the amigopod Visitor Management Appliance. Audience Developers of integrated applications. Some familiarity with HTTP based web services and XMLRPC is assumed. System administrators of the amigopod appliance. -
Page 5: Api Overview
amigopod XMLRPC Interface Version 0.9 API Overview About the API The amigopod XMLRPC API provides direct access to the underlying functionality of the amigopod Visitor Management Appliance. Developers wishing to provide integrated applications can make use of this API to programmatically perform actions that would otherwise require manual operation of the GUI. -
Page 6: Api Symmetry
amigopod XMLRPC Interface Version 0.9 XMLRPC and HTML presentation methods are supplied, which adapt the underlying basic presentation to appropriate conventions suitable for a machine-to-machine or human-to-machine interaction. The application layer provides the page templates, business logic, and the concrete features making up visitor management applications, such as Guest Manager or Hotspot Manager. -
Page 7: Parameter Types
amigopod XMLRPC Interface Version 0.9 These custom fields are automatically inherited as XMLRPC parameters, and the same policy-based processing is applied to them. Parameter Types The XMLRPC specification supports a wide range of data types. The following data types are supported by the XMLRPC presentation layer: Data Type Description Array... -
Page 8: Access Control
amigopod XMLRPC Interface Version 0.9 Code Description File implementation of XMLRPC method not found XMLRPC implementation not found XMLRPC method registration failed XMLRPC server creation failed Access denied No XMLRPC implementation for this page Access Control Accessing the API requires an operator account with a profile that has the XMLRPC API privilege, plus any privileges required for the API calls. -
Page 9: Invoking The Api
amigopod XMLRPC Interface Version 0.9 Use the XMLRPC profile when creating a user account for API access: Invoking the API An XMLRPC method call consists of: An XML document specifying the method name and parameters Sent as a HTTP POST with Content-Type: text/xml Using HTTP Basic user authorization https://amigopod/xmlrpc.php... -
Page 10: Method Summary
amigopod XMLRPC Interface Version 0.9 either installing an SSL certificate signed by a well-known certificate authority, or issue your own certificates from a network’s certificate authority. Method Summary These methods are currently available: Method Name Synopsis amigopod.guest.change.expiration Change the expiration time of a guest account amigopod.guest.create Create a new guest account... -
Page 11: Api Documentation
amigopod XMLRPC Interface Version 0.9 API Documentation Method amigopod.guest.change.expiration Change the expiration time of a guest account. Parameters Name Type Description Scalar ID of the guest account to update guestaccountexpiry Scalar Amount of time in hours before the guest account will expire Return Values Name Type... -
Page 12: Method Amigopod.guest.create
amigopod XMLRPC Interface Version 0.9 Method amigopod.guest.create Create a new guest account. Parameters Name Type Description sponsor_name String Name of the person sponsoring the guest account visitor_name String Name of the visitor visitor_company String Company name of the visitor email String The visitor’s email address. -
Page 13: Method Amigopod.guest.delete
amigopod XMLRPC Interface Version 0.9 'expire_after' => 4, 'expire_time' => '', 'role_id' => 2, 'visitor_phone' => '0', 'creator_accept_terms' => 1, Result returned by a successful operation: 'username' => 'demo@example.com', 'password' => '73067792', 'role_id' => 2, 'role_name' => 'Guest', 'simultaneous_use' => '1', 'do_schedule' =>... -
Page 14: Return Values
amigopod XMLRPC Interface Version 0.9 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... -
Page 15: Return Values
amigopod XMLRPC Interface Version 0.9 Name Type Description username String Name of the guest account password String May be: random_password to indicate the account’s password should be set to a random password password_value to indicate the account’s password should be set to the value in the password_value field the empty string to leave the password unmodified... -
Page 16: Access Control
amigopod XMLRPC Interface Version 0.9 Access Control Requires the full-user-control privilege (Guest Manager Full User Control). Example Usage Sample parameters for call: 'uid' => 162, 'username' => 'demo@example.com', 'password' => 'password_value', 'password_value' => 'password', 'role_id' => 2, 'enabled' => 1, 'simultaneous_use' =>... -
Page 17: Method Amigopod.guest.enable
amigopod XMLRPC Interface Version 0.9 'do_expire_error_flag' => 1, 'expire_time_error' => 'Parameter must be a string', 'expire_time_error_flag' => 1, 'expire_postlogin_error' => 'Please choose from one of the available options', 'expire_postlogin_error_flag' => 1, 'error' => 1, Method amigopod.guest.enable Enable a guest account. Parameters Name Type... -
Page 18: Method Amigopod.guest.get
amigopod XMLRPC Interface Version 0.9 'error' => 1, 'message' => 'Account not found: ID 162', Method amigopod.guest.get List one or more guest accounts. Parameters Name Type Description Integer Retrieve a single guest account by ID (integer parameter), or multiple guest Array accounts by ID (array parameter) Return Values... -
Page 19: Method Amigopod.guest.list
amigopod XMLRPC Interface Version 0.9 'ip_address' => '', 'netmask' => '', 1 => array ( 'id' => '162', 'username' => 'demo@example.com', 'enabled' => '1', 'role_id' => '2', 'email' => 'demo@example.com', 'notes' => '', 'do_expire' => '4', 'expire_time' => '1196253480', 'simultaneous_use' => '1', 'expire_postlogin' =>... -
Page 20: Method Amigopod.guest.reset.password
amigopod XMLRPC Interface Version 0.9 Example Usage Sample parameters 'details' => 0, Sample successful call: 'ids' => array ( 0 => '37', 1 => '141', 2 => '40', Method amigopod.guest.reset.password Reset a guest account’s password to a random value. Parameters Name Type Description... - Page 21 amigopod XMLRPC Interface Version 0.9 Sample failed call: 'error' => 1, 'message' => 'Account not found: ID 162', CONFIDENTIAL...