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

Parameter Types, Data Representation, XMLRPC Faults

Page 7 highlights

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 Array Boolean Flag Integer Number Scalar String Struct Description Associative array using numeric keys with a 0-based index True or false Scalar value of 0 or 1, implicitly Boolean Integer, 32-bit range Numeric value, floating point OK Non-array value String, UTF-8 encoded Associative array using string keys May be nested (shown in the syntax as first.second, etc.) Data Representation Unless otherwise specified, all strings should be considered to be UTF-8 encoded Unicode. Dates and times are represented in an ISO-8601 compatible format YYYY-MM-DD hh:mm:ss XMLRPC Faults An XMLRPC Fault is a specific kind of return value indicating that an error has occurred in the presentation layer. The return value is a struct containing three named values: Name error faultCode faultString Type Description Flag Set to 1 for an XMLRPC Fault Integer Status code indicating the cause of the fault String Description of the fault This type of return might appear as 'error' => 1, 'faultCode' => 401, 'faultString' => 'Invalid username or password', These are the predefined XMLRPC Fault codes: Code 401 Description Authentication problem - invalid username or password CONFIDENTIAL 7

  • 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
7
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
Associative array using numeric keys with a 0-based index
Boolean
True or false
Flag
Scalar value of 0 or 1, implicitly Boolean
Integer
Integer, 32-bit range
Number
Numeric value, floating point OK
Scalar
Non-array value
String
String, UTF-8 encoded
Struct
Associative array using string keys
May be nested (shown in the syntax as
first.second
, etc.)
Data Representation
Unless otherwise specified, all strings should be considered to be UTF-8
encoded Unicode.
Dates and times are represented in an ISO-8601 compatible format
YYYY-MM-DD hh:mm:ss
XMLRPC Faults
An XMLRPC Fault is a specific kind of return value indicating that an error
has occurred in the presentation layer. The return value is a struct containing
three named values:
Name
Type
Description
error
Flag
Set to 1 for an XMLRPC Fault
faultCode
Integer
Status code indicating the cause of the
fault
faultString
String
Description of the fault
This type of return might appear as
'error' => 1,
'faultCode' => 401,
'faultString' => 'Invalid username or password',
These are the predefined XMLRPC Fault codes:
Code
Description
401
Authentication problem – invalid username or password