API Reference

Introduction

The Vivo Webservice API allows you to access information stored within the Vivo system.

The webservice is a RESTful service and all URLs follow a similar format:

https://api.vivoclass.com/Modulename.action?param1=value1[&param2=value2[&...]]
    

moduleName specifies a broad category for which a set of actions can be specified. action specifies a particular method within that category. For example, users.getSummary will retrieve data for users.

Requests may require parameters.The syntax is the same as for query strings in regular URLs and they can be supplied in any order.


Responses are given in XML and each follows a similar format. For example:

<vivo>
   <messages>
     <message>
       <type>SUCCESS</type>
       <code>303</code>

       <payload>
         <user_data>
           <users_id>1</users_id>
           <session_id>0f79856c7de555ecce3b9f1210af10d6306a0d1cd0d68690f35e0fbf6032eead</session_id>
        </user_data>

      </payload>
    </message>
   </messages>
 </vivo>
        


The most important elements within a response are: