Web Service API - Using XML-RPC

XML-RPC

XML-RPC is a specification for doing remote procedure calls over HTTP/HTTPS, using XML as the encoding for the procedure calls. It is open, lightweight, simple and easy to implement.

Methods : List of Methods

Method Details

pmp.resources.create

This will create a resource in the PMP repository with all the details.

URL: https://pmp-server:7070/xmlrpc


Request Parameters

Name Type Required Description

resourceName

String

YES

Unique name of the resource in PMP.

resourceType

String

YES

Type of the resource.

accountName

String

YES

User account name of the resource.

newPassword

String

Optional

The password of the user account.

notes

String

YES

Notes about the user account.


Request Parameters

Name Description Values

resultCode

A number describing the result of the requested method call.

0 - Success
All other values - Failure with reason in the message parameter.

message

A text describing the reason for the result of the operation, based on the resultCode

"SUCCESS" on Success
<Message> on other failure cases


Example Request XML

<?xml version="1.0" encoding="utf-8"?>


<methodCall>
<methodName>pmp.resource.create</methodName>
<params>
    <param>
        <value><string>pmp-server<>string></value>
    </param>
    <param>
        <value><string>Windows</string></value>
    </param>
    <param>
        <value><string>administrator</string></value>
    </param>
    <param>
        <value><string>SMP</string></value>
    </param>
 <param>


 <value><string>Admin user</string></value>


   </param> </params>


</methodCall>


Example Response XML

Success

<?xml version="1.0" encoding="utf-8"?>


<methodResponse>


 <params>
     <param>
         <value>
              <struct>
                 <member>
                     <name>resultCode</name>
                      value><int>0</int></value>
                    </member>
                 <member>
                     <name>message</name>
                     <value><string>SUCCESS</string>/value>
                 </member>
             </struct>
         </value>
  </param>
 </params> 


</methodResponse> 

Failure

<?xml version="1.0" encoding="utf-8"?>


<methodResponse>


 <params>
     <param>
         <value>
              <struct>
                 <member>
                     <name>resultCode</name>
                      <value><int>1</int></value>
                    </member>
                 <member>
                     <name>message</name>
                     <value><string>Resource with the given resource name already exists.</string></value>
                 </member>
             </struct>
         </value>
  </param>
 </params> 


</methodResponse>

pmp.password.retrieve

This will retrieve the password of a specified user account from the PMP repository. After the retrieval PMP will do all the configured actions like notifying admins and auditing the operation.

URL: https://pmp-server:7070/xmlrpc

Request Parameters

Name Type Required Description

resourceName

String

YES

Unique name of the resource in PMP.

userAccount

String

YES

The account name under the resource whose password is to be retrieved.

reason

String

optional

Reason for retrieving the password.


Request Parameters

Name Description Values

resultCode

A number describing the result of the requested method call.

0 - Success
All other values - Failure with reason in the message parameter.

message

A text describing the reason for the result of the operation, based on the resultCode

The password required

The password returned as a string (or)
on other failure cases


Example Request XML


<?xml version="1.0" encoding="utf-8"?>
<methodCall>
<methodName>pmp.password.retrieve</methodName>
<params>
<param>
<value><string>pmp-server</string></value>
</param>
<param>
<value><string>administrator</string></value>
</param>
</params>
</methodCall>


Example Response XML

Success

<?xml version="1.0" encoding="utf-8"?>


<methodResponse>


 <params>
     <param>
         <value>
              <struct>
                 <member>
                     <name>resultCode</name>
                      <value><int>0</int></value>
                    </member>
                 <member>
                     <name>message</name>
                     <value><string>edhfED45@#f</string></value>
                 </member>
             </struct>
         </value>
  </param>
 </params>


</methodResponse>


Failure

<?xml version="1.0" encoding="utf-8"?>


<methodResponse>


 <params>
     <param>
         <value>
              <struct>
                 <member>
                     <name>resultCode</name>
                      <value><int>1</int></value>
                    </member>
                 <member>
                     <name>message</name>
                     <value><string>Resource with the given resource name does not exist.</string></value>
                 </member>
             </struct>
         </value>
  </param>
 </params>


</methodResponse>

pmp.password.update

This will update the password of a specified user account from the PMP rpository. After the update, PMP will do all the configured actions like notifying admins and auditing the operation.

URL: https://pmp-server:7070/xmlrpc

pmp.password.retrieve

This will retrieve the password of a specified user account from the PMP repository. After the retrieval PMP will do all the configured actions like notifying admins and auditing the operation.

URL: https://pmp-server:7070/xmlrpc

Request Parameters

Name Type Required Description

resourceName

String

YES

Unique name of the resource in PMP.

userAccount

String

YES

The account name under the resource whose password is to be retrieved.

reason

String

optional

Reason for the password retrieval.

newPassword

String

optional

The new password of the user account.

updateRemote

Boolean

YES

Set true if the password to be updated remotely.


Request Parameters

Name Description Values

resultCode

A number describing the result of the requested method call.

0 - Success
All other values - Failure with reason in the message parameter.

message

A text describing the reason for the result of the operation, based on the resultCode

"SUCCESS" on Success
on other failure cases

Example Request XML

<?xml version="1.0" encoding="utf-8"?>


<methodCall>
<methodName>pmp.password.update</methodName>
<params>
<param>
<value><string>pmp-server</string></value>
</param>
<param>
<value><string>administrator</string></value>
</param>
<param>
<value><boolean>true</boolean></value>
</param>
</params>
</methodCall>
Example Response XML

Success

<?xml version="1.0" encoding="utf-8"?>


<methodResponse>


 <params>
     <param>
         <value>
              <struct>
                 <member>
                     <name>resultCode</name>
                      <value><int>0</int></value>
                    </member>
                 <member>
                     <name>message</name>
                     <value><string>SUCCESS</string></value>
                 </member>
             </struct>
         </value>
  </param>
 </params>


</methodResponse> 

Failure

<?xml version="1.0" encoding="utf-8"?>


<methodResponse>


 <params>
     <param>
         <value>
              <struct>
                 <member>
                     <name>resultCode</name>
                      <value><int>1</int></value>
                    </member>
                 <member>
                     <name>message</name>
                     <value><string>Resource with the given resource name does not exist.</string></value>
                 </member>
             </struct>
         </value>
  </param>
 </params>


</methodResponse>

©2014, ZOHO Corp. All Rights Reserved.

Top