Contents

  1. Changelog
  2. Formats
  3. API Methods
  4. Errors/Fault Codes

Documentation


i. Changelog

November 6, 2010

Beta release of the vivomiles API.


ii. Formats

The API currently supports the following response formats:

  • binary - Raw output for images and other data.
  • json - JavaScript Object Notation
  • xml - Extensible Markup Language
  • php - PHP Serialize
  • html - HyperText Markup Language
  • csv - Comma separated values

The response format is modified by appending the parameter &response_format=json to the end of the request. The default format is xml.

Example Json request

Request

https://api.vivoclass.com/Users.getSummary?session_id=&response_format=json

Response

{"message":"Parameters not found for authentication","code":0,"status":"failure"}

Support

Formats such as binary, HTML and CSV are limited to particular methods.

Format Description Methods
Binary Binary is only supported by items that output binary Users.getAvatar
HTML HTML output is supported by any method that outputs data in a one or two dimensional array Users.getSummary
Users.getLastTransactions
CSV CSV output is supported by any method that outputs data in a one or two dimensional array Users.getSummary
Users.getLastTransactions

iii. API Methods

Method Since Documentation
App.getLatestAppVersion 1.3 Gets the latest version of the app
App.getOldestStableAppVersion 1.3 Gets the old stable version of the app
Guardians.getProfile 2.0 Student's profile and avatar configuration
Guardians.getChildTransactions 2.1 Get reward list for child
Guardians.getChildren 2.1 Get all children this guardian is responsible for
Guardians.getPledges 2.1 Get all pledges made by a guardian to a child
Guardians.addPledge 2.1 Add a new pledge
Guardians.deletePledge 2.1 Delete pledge
Guardians.modifyPledge 2.1 Modify a pledge
Guardians.addTransactionComment 2.1 Add Transaction Comment
Guardians.getTransactionComments 2.1 Get Transaction Comments
Shop.getCategories 2.1 Returns all shop categories
Shop.getItems 2.1 Returns all items accessible in the shop to this user
Shop.getItem 2.1 Returns item by ID
Shop.rateItem 2.1 Allow for the rating of a shop Item
Shop.doPurchaseShopGood 2.1 Purchase shop good with given id
Shop.getShopOrderHistory Returns shop orders history
Shop.cancelOrder Cancels the status of the order if it is allowed. Does not throw error if the order had been cancelled prior to calling this method
Shop.getShopManager Get the name of the shop manager
Staff.jumpTo 2.0 Returns info about a lesson and the students in the lesson
Staff.getClassList 2.0 Returns info about a lesson and the students in the lesson
Staff.getHouseRewards 2.0 Returns info about an organisation's house
Staff.getApplicableAwardCategories 2.0 Returns info about the award categories the current logged in staff can use to reward a class list.
Staff.getApplicableExtraEarners 2.1 Returns info about the extra earners the current logged in staff can use to reward
Staff.rewardStudent 2.0 Rewards a student. The optional password parameter is not needed in case of rewards that does not need authorisation. However when transaction authorisation is needed the password is mandatory.
Staff.rewardStudents 2.1 Reward multiple students. The optional password parameter is not needed in case of rewards that does not need authorisation. However when transaction authorisation is needed the password is mandatory.
Staff.rewardClassList 2.0 Rewards all the students in the class list
Staff.getBudgetData 2.1 Returns budget information: weekly budget, awarded this week, % remaining
Staff.getLists 2.1 Returns all lists available to this staff member
Staff.getListStudents 2.1 Returns all lists available to this staff member
Staff.getTutorYearLists 2.2 Returns all tutor group lists and year group lists available to this staff member
Staff.getTutorYearListStudents 2.2 Returns the students in the specified tutor group list or year group list
Staff.getGroups 2.1 Returns all groups available to this staff member
Staff.getGroupDetails 2.1 Returns a group
Staff.isAuthorisationRequiredForRewards 2.2
Users.doLogin 1.0 Given a valid set of credentials, the doLogin method returns a session_id for use by other methods. The login credentials are the same as those that the user would use to access Vivo through the website.
Users.getMobileAppSummary 2.1 Gets a collection of user data which is required by the mobile app, once a user has logged in
Users.getSummary 1.0 The getSummary method requires a valid session_id and returns general information about the user. This method works for all types of users including USER, STAFF and ADMIN.
Users.search 1.0 Requires a valid session_id and the first 2 characters of the search query and returns a list of users matching the search term. This is a simple search and does not support Boolean operators such as AND, OR. The search searches the first and surname of all users of type USER in the organisation, but can only be used by users of type ADMIN or STAFF.
Users.searchForUser 1.0 Search for users within a organisation
Users.getLastTransactions 1.0 The getLastTransactions method requires a valid session_id and returns information about the last num_transactions that have occurred on this user’s account. These transactions do not include those generated when a user rewards or penalises another user - please see Users.getTransactionsIssued.
Users.getTransactionsIssued 1.0 The getTransactionsIssued method requires a valid session_id and returns information about transactions that this user has issued to other users. This does not include transactions that this user has instigated on their own account – see Users.getLastTransactions
Users.getAwardCategories 1.0 The getAwardCategories method requires a session_id and returns a list of reward categories that this user is allowed to reward or penalise against.
Users.doLogout 1.0 The doLogout method dissociates a user with a session_id
Users.doReward 1.0 The doReward method allows you to reward or penalise a user from the account represented by session_id. Please note: due to the nature of this method, there are a large number of validation checks that can return a number of error messages that should be handled correctly. The optional password parameter is not needed in case of rewards that does not need authorisation. However when transaction authorisation is needed the password is mandatory.
Users.getAvatar 1.0 Given a valid set of credentials the portrait method returns an image in the format specified of a head-and-shoulders view of the avatar. We recommend that this image is cached by the requesting application. Non-binary output formats will be base64 encoded.
Users.getVirtualLevels 2.0 Available Virtual levels and Vivos needed in that school
Users.ping 1.0 Allows an application to refresh a user's session during long periods of expected inactivity
Users.getUserTransactionsForDateRange 1.0 For the given date range, this method returns a list of user transactions.
Users.getRewardsTransactionsForDateRangeSummary 1.0 For the given date range, this method returns a list of the categories that a user can be awarded for and the quantity of awards made in that period.
Users.getUserTransactionsSummaryForDateRange 1.0 For the given date range, this method returns a list of the total transactions that a user can be awarded for and the quantity of awards made in that period.
Users.getTransaction 2.1 Select a transaction by the given transaction id
Users.getExtraEarners 2.1 Get a list of all extra earners available to this user
Users.getExtraEarner 2.1 Get an extra earners by its primary ID
Users.registerForPushNotifications 2.1 Register user for push notifications
Users.unregisterForPushNotifications 2.1 Unregister user from push notifications
Users.getScreenMessages 2.1 Get the current screen messages for the user
Users.updateProfile 2.1 Update user's profile details - makes call to Users_Manager to update both
Users.getSharedSecret 2.2 Generate shared secret key for the user
Users.updatePassword 2.2 Update user's password
Users.getUserSmsPreference 2.2 Get the User's current SMS updates preference setting
Users.updateUserSmsPreference 2.2 Updates User's SMS preference setting
Users.verifyPassword Checks the user's password. Throws exception if the password is wrong
Users.recalculateUserStatus 2.2 Recalculate the user's status. If the user has changed their password and provided an email address, update their status to a standard account. Only applicable for students.
Users.getStatistics 2.2 Returns user statistics (e.g., avg miles per day, avg miles per week).
Users.getEnabledModules Returns subset (with enabled modules codes) of codes passed by argument.
Users.getUserEmail Returns email address for the current user. Returns null if there is no email address associated with the user
Users.getUserMobile Returns mobile number for the current user. Returns null if there is no number associated with the user
Users.redeemCouponCode Redeem a voucher code
Users.uploadProfilePicture Upload user profile image

Method: App.getLatestAppVersion

Available since API version 1.3

Gets the latest version of the app

Parameters:

Name Required Type Default Description
No Parameters

Response Parameters:

Name Description
version The latest app version

Example Request (click to see example response):

https://api.vivoclass.com/App.getLatestAppVersion?

Error Codes:

This method does not return any errors

Method: App.getOldestStableAppVersion

Available since API version 1.3

Gets the old stable version of the app

Parameters:

Name Required Type Default Description
No Parameters

Response Parameters:

Name Description
version The oldest stable app version

Example Request (click to see example response):

https://api.vivoclass.com/App.getOldestStableAppVersion?

Error Codes:

This method does not return any errors

Method: Guardians.getProfile

Available since API version 2.0

Student's profile and avatar configuration

Parameters:

Name Required Type Default Description
session_id Required string A valid session_id representing a staff user

Example Request (click to see example response):


( ! ) Notice: Undefined property: stdClass::$user_data in /vivo/developers.vivomiles.com/application/models/Doc.php on line 400
Call Stack
#TimeMemoryFunctionLocation
10.0000240624{main}( ).../index.php:0
20.01671405760Zend_Application->run( ).../index.php:36
30.01671405880Zend_Application_Bootstrap_Bootstrap->run( ).../Application.php:366
40.01681406712Zend_Controller_Front->dispatch( ).../Bootstrap.php:97
50.01711486048Zend_Controller_Dispatcher_Standard->dispatch( ).../Front.php:954
60.15662536736Zend_Controller_Action->dispatch( ).../Standard.php:289
70.93524009000Zend_Controller_Action_HelperBroker->notifyPostDispatch( ).../Action.php:523
80.93524010048Zend_Controller_Action_Helper_ViewRenderer->postDispatch( ).../HelperBroker.php:277
90.93524010368Zend_Controller_Action_Helper_ViewRenderer->render( ).../ViewRenderer.php:957
100.93544011344Zend_Controller_Action_Helper_ViewRenderer->renderScript( ).../ViewRenderer.php:918
110.93544011376Zend_View_Abstract->render( ).../ViewRenderer.php:897
120.95484027960Zend_View->_run( ).../Abstract.php:880
130.95494028968include( '/vivo/developers.vivomiles.com/application/views/scripts/doc/method.phtml' ).../View.php:108
140.96744066200Model_Doc->buildParamsWebService( ).../method.phtml:341
150.96754071776Model_Doc->getSession( ).../Doc.php:468
160.96754072936Model_Doc->callWebService( ).../Doc.php:377
171.15744095984Model_Doc->setSessionId( ).../Doc.php:364

( ! ) Notice: Trying to get property of non-object in /vivo/developers.vivomiles.com/application/models/Doc.php on line 400
Call Stack
#TimeMemoryFunctionLocation
10.0000240624{main}( ).../index.php:0
20.01671405760Zend_Application->run( ).../index.php:36
30.01671405880Zend_Application_Bootstrap_Bootstrap->run( ).../Application.php:366
40.01681406712Zend_Controller_Front->dispatch( ).../Bootstrap.php:97
50.01711486048Zend_Controller_Dispatcher_Standard->dispatch( ).../Front.php:954
60.15662536736Zend_Controller_Action->dispatch( ).../Standard.php:289
70.93524009000Zend_Controller_Action_HelperBroker->notifyPostDispatch( ).../Action.php:523
80.93524010048Zend_Controller_Action_Helper_ViewRenderer->postDispatch( ).../HelperBroker.php:277
90.93524010368Zend_Controller_Action_Helper_ViewRenderer->render( ).../ViewRenderer.php:957
100.93544011344Zend_Controller_Action_Helper_ViewRenderer->renderScript( ).../ViewRenderer.php:918
110.93544011376Zend_View_Abstract->render( ).../ViewRenderer.php:897
120.95484027960Zend_View->_run( ).../Abstract.php:880
130.95494028968include( '/vivo/developers.vivomiles.com/application/views/scripts/doc/method.phtml' ).../View.php:108
140.96744066200Model_Doc->buildParamsWebService( ).../method.phtml:341
150.96754071776Model_Doc->getSession( ).../Doc.php:468
160.96754072936Model_Doc->callWebService( ).../Doc.php:377
171.15744095984Model_Doc->setSessionId( ).../Doc.php:364
https://api.vivoclass.com/Guardians.getProfile?

Error Codes:

9999

Method: Guardians.getChildTransactions

Available since API version 2.1

Get reward list for child

Parameters:

Name Required Type Default Description
session_id Required string A currently active and valid webservice session id
child_id Required int A user's id that is a child of currently logged in guardian
max Optional int 15 Maximum number of rewards to return
offset Optional int Offset of the returned list in all rewards

Response Parameters:

Name Description
transactions_id The transactions_id of the reward
users_id The id of the user
issuers_id The id of the issuers
issuers_organisations_id The id of the issuer's organisations
quantity The amount of Vivos given in the reward
transaction_date The date of the reward
reason_type The reason_type of the reward
reason_text The reason_text of the reward
award_category The award_category of the reward
reason_title The reason_title of the reward

Example Request (click to see example response):


( ! ) Notice: Undefined property: stdClass::$user_data in /vivo/developers.vivomiles.com/application/models/Doc.php on line 400
Call Stack
#TimeMemoryFunctionLocation
10.0000240624{main}( ).../index.php:0
20.01671405760Zend_Application->run( ).../index.php:36
30.01671405880Zend_Application_Bootstrap_Bootstrap->run( ).../Application.php:366
40.01681406712Zend_Controller_Front->dispatch( ).../Bootstrap.php:97
50.01711486048Zend_Controller_Dispatcher_Standard->dispatch( ).../Front.php:954
60.15662536736Zend_Controller_Action->dispatch( ).../Standard.php:289
70.93524009000Zend_Controller_Action_HelperBroker->notifyPostDispatch( ).../Action.php:523
80.93524010048Zend_Controller_Action_Helper_ViewRenderer->postDispatch( ).../HelperBroker.php:277
90.93524010368Zend_Controller_Action_Helper_ViewRenderer->render( ).../ViewRenderer.php:957
100.93544011344Zend_Controller_Action_Helper_ViewRenderer->renderScript( ).../ViewRenderer.php:918
110.93544011376Zend_View_Abstract->render( ).../ViewRenderer.php:897
120.95484027960Zend_View->_run( ).../Abstract.php:880
130.95494028968include( '/vivo/developers.vivomiles.com/application/views/scripts/doc/method.phtml' ).../View.php:108
141.15904081504Model_Doc->buildParamsWebService( ).../method.phtml:341
151.15914087392Model_Doc->getSession( ).../Doc.php:468
161.15914088552Model_Doc->callWebService( ).../Doc.php:377
171.35604123888Model_Doc->setSessionId( ).../Doc.php:364

( ! ) Notice: Trying to get property of non-object in /vivo/developers.vivomiles.com/application/models/Doc.php on line 400
Call Stack
#TimeMemoryFunctionLocation
10.0000240624{main}( ).../index.php:0
20.01671405760Zend_Application->run( ).../index.php:36
30.01671405880Zend_Application_Bootstrap_Bootstrap->run( ).../Application.php:366
40.01681406712Zend_Controller_Front->dispatch( ).../Bootstrap.php:97
50.01711486048Zend_Controller_Dispatcher_Standard->dispatch( ).../Front.php:954
60.15662536736Zend_Controller_Action->dispatch( ).../Standard.php:289
70.93524009000Zend_Controller_Action_HelperBroker->notifyPostDispatch( ).../Action.php:523
80.93524010048Zend_Controller_Action_Helper_ViewRenderer->postDispatch( ).../HelperBroker.php:277
90.93524010368Zend_Controller_Action_Helper_ViewRenderer->render( ).../ViewRenderer.php:957
100.93544011344Zend_Controller_Action_Helper_ViewRenderer->renderScript( ).../ViewRenderer.php:918
110.93544011376Zend_View_Abstract->render( ).../ViewRenderer.php:897
120.95484027960Zend_View->_run( ).../Abstract.php:880
130.95494028968include( '/vivo/developers.vivomiles.com/application/views/scripts/doc/method.phtml' ).../View.php:108
141.15904081504Model_Doc->buildParamsWebService( ).../method.phtml:341
151.15914087392Model_Doc->getSession( ).../Doc.php:468
161.15914088552Model_Doc->callWebService( ).../Doc.php:377
171.35604123888Model_Doc->setSessionId( ).../Doc.php:364
https://api.vivoclass.com/Guardians.getChildTransactions?child_id=13&max=15&offset=2

Error Codes:

9999, 3700

Method: Guardians.getChildren

Available since API version 2.1

Get all children this guardian is responsible for

Parameters:

Name Required Type Default Description
session_id Required string A currently active and valid webservice session id

Response Parameters:

Name Description
users_id The unique id that Vivo uses to identify the user
title The title or salutation to address the user
first_name The first or given name of the user. In school environments, this should not be shown to students if the user is a staff or admin user
last_name The last or surname of the user
organisation_name The name of the organisation that the user is associated with
vivos_current The current number of Vivos in this user’s account as of summary_date
vivos_total The total number of Vivos this user has been awarded as of summary_date
vivos_last_year The total number of Vivos that the user has been awarded last year. In school environments this is taken to be last academic year, otherwise, last calendar year.
date_last_rewarded The date and time that this user was last awarded Vivos
date_last_penalised The date and time that this user was last penalised Vivos
in_gold_club Whether or not this user is a member of the organisation’s Gold Club
allowed_to_reward Whether or not this user is allowed to reward users
allowed_to_penalise Whether or not this user is allowed to penalise users
year The name of the year this user is in
group The name of the group this user is a member (if applicable)
sex The sex of the user
user_type This user’s account type (USER|STAFF|ADMIN)
reward_budget_spent The number of Vivos this user has rewarded in reward_budget_period
reward_budget_allowance The maximum number of Vivos this user can reward in reward_budget_period
reward_budget_period The budget period for Reward_budget_allowance (WEEK|MONTH)
summary_date The date and time that this summary was generated
num_transactions The total number of transactions

Example Request (click to see example response):


( ! ) Notice: Undefined property: stdClass::$user_data in /vivo/developers.vivomiles.com/application/models/Doc.php on line 400
Call Stack
#TimeMemoryFunctionLocation
10.0000240624{main}( ).../index.php:0
20.01671405760Zend_Application->run( ).../index.php:36
30.01671405880Zend_Application_Bootstrap_Bootstrap->run( ).../Application.php:366
40.01681406712Zend_Controller_Front->dispatch( ).../Bootstrap.php:97
50.01711486048Zend_Controller_Dispatcher_Standard->dispatch( ).../Front.php:954
60.15662536736Zend_Controller_Action->dispatch( ).../Standard.php:289
70.93524009000Zend_Controller_Action_HelperBroker->notifyPostDispatch( ).../Action.php:523
80.93524010048Zend_Controller_Action_Helper_ViewRenderer->postDispatch( ).../HelperBroker.php:277
90.93524010368Zend_Controller_Action_Helper_ViewRenderer->render( ).../ViewRenderer.php:957
100.93544011344Zend_Controller_Action_Helper_ViewRenderer->renderScript( ).../ViewRenderer.php:918
110.93544011376Zend_View_Abstract->render( ).../ViewRenderer.php:897
120.95484027960Zend_View->_run( ).../Abstract.php:880
130.95494028968include( '/vivo/developers.vivomiles.com/application/views/scripts/doc/method.phtml' ).../View.php:108
141.35764098408Model_Doc->buildParamsWebService( ).../method.phtml:341
151.35774103984Model_Doc->getSession( ).../Doc.php:468
161.35774105144Model_Doc->callWebService( ).../Doc.php:377
171.56294146232Model_Doc->setSessionId( ).../Doc.php:364

( ! ) Notice: Trying to get property of non-object in /vivo/developers.vivomiles.com/application/models/Doc.php on line 400
Call Stack
#TimeMemoryFunctionLocation
10.0000240624{main}( ).../index.php:0
20.01671405760Zend_Application->run( ).../index.php:36
30.01671405880Zend_Application_Bootstrap_Bootstrap->run( ).../Application.php:366
40.01681406712Zend_Controller_Front->dispatch( ).../Bootstrap.php:97
50.01711486048Zend_Controller_Dispatcher_Standard->dispatch( ).../Front.php:954
60.15662536736Zend_Controller_Action->dispatch( ).../Standard.php:289
70.93524009000Zend_Controller_Action_HelperBroker->notifyPostDispatch( ).../Action.php:523
80.93524010048Zend_Controller_Action_Helper_ViewRenderer->postDispatch( ).../HelperBroker.php:277
90.93524010368Zend_Controller_Action_Helper_ViewRenderer->render( ).../ViewRenderer.php:957
100.93544011344Zend_Controller_Action_Helper_ViewRenderer->renderScript( ).../ViewRenderer.php:918
110.93544011376Zend_View_Abstract->render( ).../ViewRenderer.php:897
120.95484027960Zend_View->_run( ).../Abstract.php:880
130.95494028968include( '/vivo/developers.vivomiles.com/application/views/scripts/doc/method.phtml' ).../View.php:108
141.35764098408Model_Doc->buildParamsWebService( ).../method.phtml:341
151.35774103984Model_Doc->getSession( ).../Doc.php:468
161.35774105144Model_Doc->callWebService( ).../Doc.php:377
171.56294146232Model_Doc->setSessionId( ).../Doc.php:364
https://api.vivoclass.com/Guardians.getChildren?

Error Codes:

9999

Method: Guardians.getPledges

Available since API version 2.1

Get all pledges made by a guardian to a child

Parameters:

Name Required Type Default Description
session_id Required string A currently active and valid webservice session id
child_id Required int The primary ID of the student user

Response Parameters:

Name Description
pledges_id The internal id of the pledge returned
date_start The date the pledge begins
date_end The date the pledge ends
miles_goal The amount of vivos required to achieve the pledge
pledge_text The description of the pledge
achieved If the pledge has been achieved Y/N
progress Percentage of the pledge completed

Example Request (click to see example response):


( ! ) Notice: Undefined property: stdClass::$user_data in /vivo/developers.vivomiles.com/application/models/Doc.php on line 400
Call Stack
#TimeMemoryFunctionLocation
10.0000240624{main}( ).../index.php:0
20.01671405760Zend_Application->run( ).../index.php:36
30.01671405880Zend_Application_Bootstrap_Bootstrap->run( ).../Application.php:366
40.01681406712Zend_Controller_Front->dispatch( ).../Bootstrap.php:97
50.01711486048Zend_Controller_Dispatcher_Standard->dispatch( ).../Front.php:954
60.15662536736Zend_Controller_Action->dispatch( ).../Standard.php:289
70.93524009000Zend_Controller_Action_HelperBroker->notifyPostDispatch( ).../Action.php:523
80.93524010048Zend_Controller_Action_Helper_ViewRenderer->postDispatch( ).../HelperBroker.php:277
90.93524010368Zend_Controller_Action_Helper_ViewRenderer->render( ).../ViewRenderer.php:957
100.93544011344Zend_Controller_Action_Helper_ViewRenderer->renderScript( ).../ViewRenderer.php:918
110.93544011376Zend_View_Abstract->render( ).../ViewRenderer.php:897
120.95484027960Zend_View->_run( ).../Abstract.php:880
130.95494028968include( '/vivo/developers.vivomiles.com/application/views/scripts/doc/method.phtml' ).../View.php:108
141.56454114352Model_Doc->buildParamsWebService( ).../method.phtml:341
151.56464120032Model_Doc->getSession( ).../Doc.php:468
161.56464121192Model_Doc->callWebService( ).../Doc.php:377
171.76604152648Model_Doc->setSessionId( ).../Doc.php:364

( ! ) Notice: Trying to get property of non-object in /vivo/developers.vivomiles.com/application/models/Doc.php on line 400
Call Stack
#TimeMemoryFunctionLocation
10.0000240624{main}( ).../index.php:0
20.01671405760Zend_Application->run( ).../index.php:36
30.01671405880Zend_Application_Bootstrap_Bootstrap->run( ).../Application.php:366
40.01681406712Zend_Controller_Front->dispatch( ).../Bootstrap.php:97
50.01711486048Zend_Controller_Dispatcher_Standard->dispatch( ).../Front.php:954
60.15662536736Zend_Controller_Action->dispatch( ).../Standard.php:289
70.93524009000Zend_Controller_Action_HelperBroker->notifyPostDispatch( ).../Action.php:523
80.93524010048Zend_Controller_Action_Helper_ViewRenderer->postDispatch( ).../HelperBroker.php:277
90.93524010368Zend_Controller_Action_Helper_ViewRenderer->render( ).../ViewRenderer.php:957
100.93544011344Zend_Controller_Action_Helper_ViewRenderer->renderScript( ).../ViewRenderer.php:918
110.93544011376Zend_View_Abstract->render( ).../ViewRenderer.php:897
120.95484027960Zend_View->_run( ).../Abstract.php:880
130.95494028968include( '/vivo/developers.vivomiles.com/application/views/scripts/doc/method.phtml' ).../View.php:108
141.56454114352Model_Doc->buildParamsWebService( ).../method.phtml:341
151.56464120032Model_Doc->getSession( ).../Doc.php:468
161.56464121192Model_Doc->callWebService( ).../Doc.php:377
171.76604152648Model_Doc->setSessionId( ).../Doc.php:364
https://api.vivoclass.com/Guardians.getPledges?child_id=75

Error Codes:

9999, 3700

Method: Guardians.addPledge

Available since API version 2.1

Add a new pledge

Parameters:

Name Required Type Default Description
session_id Required string A currently active and valid webservice session id
child_id Required int The primary ID of the student user
vivos_goal Required int The amount of vivos required to achieve the pledge
start_date Required string The date the pledge starts
end_date Required string The date the pledge ends
pledge_description Required string The decription of the pledge

Response Parameters:

Name Description
result Success message

Example Request (click to see example response):


( ! ) Notice: Undefined property: stdClass::$user_data in /vivo/developers.vivomiles.com/application/models/Doc.php on line 400
Call Stack
#TimeMemoryFunctionLocation
10.0000240624{main}( ).../index.php:0
20.01671405760Zend_Application->run( ).../index.php:36
30.01671405880Zend_Application_Bootstrap_Bootstrap->run( ).../Application.php:366
40.01681406712Zend_Controller_Front->dispatch( ).../Bootstrap.php:97
50.01711486048Zend_Controller_Dispatcher_Standard->dispatch( ).../Front.php:954
60.15662536736Zend_Controller_Action->dispatch( ).../Standard.php:289
70.93524009000Zend_Controller_Action_HelperBroker->notifyPostDispatch( ).../Action.php:523
80.93524010048Zend_Controller_Action_Helper_ViewRenderer->postDispatch( ).../HelperBroker.php:277
90.93524010368Zend_Controller_Action_Helper_ViewRenderer->render( ).../ViewRenderer.php:957
100.93544011344Zend_Controller_Action_Helper_ViewRenderer->renderScript( ).../ViewRenderer.php:918
110.93544011376Zend_View_Abstract->render( ).../ViewRenderer.php:897
120.95484027960Zend_View->_run( ).../Abstract.php:880
130.95494028968include( '/vivo/developers.vivomiles.com/application/views/scripts/doc/method.phtml' ).../View.php:108
141.76774131720Model_Doc->buildParamsWebService( ).../method.phtml:341
151.76784137824Model_Doc->getSession( ).../Doc.php:468
161.76784138984Model_Doc->callWebService( ).../Doc.php:377
171.96204169688Model_Doc->setSessionId( ).../Doc.php:364

( ! ) Notice: Trying to get property of non-object in /vivo/developers.vivomiles.com/application/models/Doc.php on line 400
Call Stack
#TimeMemoryFunctionLocation
10.0000240624{main}( ).../index.php:0
20.01671405760Zend_Application->run( ).../index.php:36
30.01671405880Zend_Application_Bootstrap_Bootstrap->run( ).../Application.php:366
40.01681406712Zend_Controller_Front->dispatch( ).../Bootstrap.php:97
50.01711486048Zend_Controller_Dispatcher_Standard->dispatch( ).../Front.php:954
60.15662536736Zend_Controller_Action->dispatch( ).../Standard.php:289
70.93524009000Zend_Controller_Action_HelperBroker->notifyPostDispatch( ).../Action.php:523
80.93524010048Zend_Controller_Action_Helper_ViewRenderer->postDispatch( ).../HelperBroker.php:277
90.93524010368Zend_Controller_Action_Helper_ViewRenderer->render( ).../ViewRenderer.php:957
100.93544011344Zend_Controller_Action_Helper_ViewRenderer->renderScript( ).../ViewRenderer.php:918
110.93544011376Zend_View_Abstract->render( ).../ViewRenderer.php:897
120.95484027960Zend_View->_run( ).../Abstract.php:880
130.95494028968include( '/vivo/developers.vivomiles.com/application/views/scripts/doc/method.phtml' ).../View.php:108
141.76774131720Model_Doc->buildParamsWebService( ).../method.phtml:341
151.76784137824Model_Doc->getSession( ).../Doc.php:468
161.76784138984Model_Doc->callWebService( ).../Doc.php:377
171.96204169688Model_Doc->setSessionId( ).../Doc.php:364
https://api.vivoclass.com/Guardians.addPledge?child_id=65&vivos_goal=25&start_date=4b43b0ae&end_date=4b43b0ae&pledge_description=4b43b0ae

Error Codes:

9999, 3700, 3701

Method: Guardians.deletePledge

Available since API version 2.1

Delete pledge

Parameters:

Name Required Type Default Description
session_id Required string A currently active and valid webservice session id
pledge_id Required int The primary ID of the pledge

Response Parameters:

Name Description
result Success message

Example Request (click to see example response):


( ! ) Notice: Undefined property: stdClass::$user_data in /vivo/developers.vivomiles.com/application/models/Doc.php on line 400
Call Stack
#TimeMemoryFunctionLocation
10.0000240624{main}( ).../index.php:0
20.01671405760Zend_Application->run( ).../index.php:36
30.01671405880Zend_Application_Bootstrap_Bootstrap->run( ).../Application.php:366
40.01681406712Zend_Controller_Front->dispatch( ).../Bootstrap.php:97
50.01711486048Zend_Controller_Dispatcher_Standard->dispatch( ).../Front.php:954
60.15662536736Zend_Controller_Action->dispatch( ).../Standard.php:289
70.93524009000Zend_Controller_Action_HelperBroker->notifyPostDispatch( ).../Action.php:523
80.93524010048Zend_Controller_Action_Helper_ViewRenderer->postDispatch( ).../HelperBroker.php:277
90.93524010368Zend_Controller_Action_Helper_ViewRenderer->render( ).../ViewRenderer.php:957
100.93544011344Zend_Controller_Action_Helper_ViewRenderer->renderScript( ).../ViewRenderer.php:918
110.93544011376Zend_View_Abstract->render( ).../ViewRenderer.php:897
120.95484027960Zend_View->_run( ).../Abstract.php:880
130.95494028968include( '/vivo/developers.vivomiles.com/application/views/scripts/doc/method.phtml' ).../View.php:108
141.96364148456Model_Doc->buildParamsWebService( ).../method.phtml:341
151.96374154136Model_Doc->getSession( ).../Doc.php:468
161.96374155296Model_Doc->callWebService( ).../Doc.php:377
172.16744181576Model_Doc->setSessionId( ).../Doc.php:364

( ! ) Notice: Trying to get property of non-object in /vivo/developers.vivomiles.com/application/models/Doc.php on line 400
Call Stack
#TimeMemoryFunctionLocation
10.0000240624{main}( ).../index.php:0
20.01671405760Zend_Application->run( ).../index.php:36
30.01671405880Zend_Application_Bootstrap_Bootstrap->run( ).../Application.php:366
40.01681406712Zend_Controller_Front->dispatch( ).../Bootstrap.php:97
50.01711486048Zend_Controller_Dispatcher_Standard->dispatch( ).../Front.php:954
60.15662536736Zend_Controller_Action->dispatch( ).../Standard.php:289
70.93524009000Zend_Controller_Action_HelperBroker->notifyPostDispatch( ).../Action.php:523
80.93524010048Zend_Controller_Action_Helper_ViewRenderer->postDispatch( ).../HelperBroker.php:277
90.93524010368Zend_Controller_Action_Helper_ViewRenderer->render( ).../ViewRenderer.php:957
100.93544011344Zend_Controller_Action_Helper_ViewRenderer->renderScript( ).../ViewRenderer.php:918
110.93544011376Zend_View_Abstract->render( ).../ViewRenderer.php:897
120.95484027960Zend_View->_run( ).../Abstract.php:880
130.95494028968include( '/vivo/developers.vivomiles.com/application/views/scripts/doc/method.phtml' ).../View.php:108
141.96364148456Model_Doc->buildParamsWebService( ).../method.phtml:341
151.96374154136Model_Doc->getSession( ).../Doc.php:468
161.96374155296Model_Doc->callWebService( ).../Doc.php:377
172.16744181576Model_Doc->setSessionId( ).../Doc.php:364
https://api.vivoclass.com/Guardians.deletePledge?pledge_id=49

Error Codes:

9999, 3702

Method: Guardians.modifyPledge

Available since API version 2.1

Modify a pledge

Parameters:

Name Required Type Default Description
session_id Required string A currently active and valid webservice session id
pledges_id Required int The primary ID of the pledge
vivos_goal Required int The amount of vivos required to achieve the pledge
start_date Required string The date the pledge starts
end_date Required string The date the pledge ends
pledge_description Required string The decription of the pledge

Response Parameters:

Name Description
result Success message

Example Request (click to see example response):


( ! ) Notice: Undefined property: stdClass::$user_data in /vivo/developers.vivomiles.com/application/models/Doc.php on line 400
Call Stack
#TimeMemoryFunctionLocation
10.0000240624{main}( ).../index.php:0
20.01671405760Zend_Application->run( ).../index.php:36
30.01671405880Zend_Application_Bootstrap_Bootstrap->run( ).../Application.php:366
40.01681406712Zend_Controller_Front->dispatch( ).../Bootstrap.php:97
50.01711486048Zend_Controller_Dispatcher_Standard->dispatch( ).../Front.php:954
60.15662536736Zend_Controller_Action->dispatch( ).../Standard.php:289
70.93524009000Zend_Controller_Action_HelperBroker->notifyPostDispatch( ).../Action.php:523
80.93524010048Zend_Controller_Action_Helper_ViewRenderer->postDispatch( ).../HelperBroker.php:277
90.93524010368Zend_Controller_Action_Helper_ViewRenderer->render( ).../ViewRenderer.php:957
100.93544011344Zend_Controller_Action_Helper_ViewRenderer->renderScript( ).../ViewRenderer.php:918
110.93544011376Zend_View_Abstract->render( ).../ViewRenderer.php:897
120.95484027960Zend_View->_run( ).../Abstract.php:880
130.95494028968include( '/vivo/developers.vivomiles.com/application/views/scripts/doc/method.phtml' ).../View.php:108
142.16894163944Model_Doc->buildParamsWebService( ).../method.phtml:341
152.16894170048Model_Doc->getSession( ).../Doc.php:468
162.16894171208Model_Doc->callWebService( ).../Doc.php:377
172.37054202144Model_Doc->setSessionId( ).../Doc.php:364

( ! ) Notice: Trying to get property of non-object in /vivo/developers.vivomiles.com/application/models/Doc.php on line 400
Call Stack
#TimeMemoryFunctionLocation
10.0000240624{main}( ).../index.php:0
20.01671405760Zend_Application->run( ).../index.php:36
30.01671405880Zend_Application_Bootstrap_Bootstrap->run( ).../Application.php:366
40.01681406712Zend_Controller_Front->dispatch( ).../Bootstrap.php:97
50.01711486048Zend_Controller_Dispatcher_Standard->dispatch( ).../Front.php:954
60.15662536736Zend_Controller_Action->dispatch( ).../Standard.php:289
70.93524009000Zend_Controller_Action_HelperBroker->notifyPostDispatch( ).../Action.php:523
80.93524010048Zend_Controller_Action_Helper_ViewRenderer->postDispatch( ).../HelperBroker.php:277
90.93524010368Zend_Controller_Action_Helper_ViewRenderer->render( ).../ViewRenderer.php:957
100.93544011344Zend_Controller_Action_Helper_ViewRenderer->renderScript( ).../ViewRenderer.php:918
110.93544011376Zend_View_Abstract->render( ).../ViewRenderer.php:897
120.95484027960Zend_View->_run( ).../Abstract.php:880
130.95494028968include( '/vivo/developers.vivomiles.com/application/views/scripts/doc/method.phtml' ).../View.php:108
142.16894163944Model_Doc->buildParamsWebService( ).../method.phtml:341
152.16894170048Model_Doc->getSession( ).../Doc.php:468
162.16894171208Model_Doc->callWebService( ).../Doc.php:377
172.37054202144Model_Doc->setSessionId( ).../Doc.php:364
https://api.vivoclass.com/Guardians.modifyPledge?pledges_id=2&vivos_goal=27&start_date=4b43b0ae&end_date=4b43b0ae&pledge_description=4b43b0ae

Error Codes:

9999, 3701, 3702

Method: Guardians.addTransactionComment

Available since API version 2.1

Add Transaction Comment

Parameters:

Name Required Type Default Description
session_id Required string A currently active and valid webservice session id
transaction_id Required int The primary ID of the transaction
comment Required string The comment

Response Parameters:

Name Description
result Success message

Example Request (click to see example response):


( ! ) Notice: Undefined property: stdClass::$user_data in /vivo/developers.vivomiles.com/application/models/Doc.php on line 400
Call Stack
#TimeMemoryFunctionLocation
10.0000240624{main}( ).../index.php:0
20.01671405760Zend_Application->run( ).../index.php:36
30.01671405880Zend_Application_Bootstrap_Bootstrap->run( ).../Application.php:366
40.01681406712Zend_Controller_Front->dispatch( ).../Bootstrap.php:97
50.01711486048Zend_Controller_Dispatcher_Standard->dispatch( ).../Front.php:954
60.15662536736Zend_Controller_Action->dispatch( ).../Standard.php:289
70.93524009000Zend_Controller_Action_HelperBroker->notifyPostDispatch( ).../Action.php:523
80.93524010048Zend_Controller_Action_Helper_ViewRenderer->postDispatch( ).../HelperBroker.php:277
90.93524010368Zend_Controller_Action_Helper_ViewRenderer->render( ).../ViewRenderer.php:957
100.93544011344Zend_Controller_Action_Helper_ViewRenderer->renderScript( ).../ViewRenderer.php:918
110.93544011376Zend_View_Abstract->render( ).../ViewRenderer.php:897
120.95484027960Zend_View->_run( ).../Abstract.php:880
130.95494028968include( '/vivo/developers.vivomiles.com/application/views/scripts/doc/method.phtml' ).../View.php:108
142.37184181008Model_Doc->buildParamsWebService( ).../method.phtml:341
152.37194186800Model_Doc->getSession( ).../Doc.php:468
162.37204187960Model_Doc->callWebService( ).../Doc.php:377
172.57374215800Model_Doc->setSessionId( ).../Doc.php:364

( ! ) Notice: Trying to get property of non-object in /vivo/developers.vivomiles.com/application/models/Doc.php on line 400
Call Stack
#TimeMemoryFunctionLocation
10.0000240624{main}( ).../index.php:0
20.01671405760Zend_Application->run( ).../index.php:36
30.01671405880Zend_Application_Bootstrap_Bootstrap->run( ).../Application.php:366
40.01681406712Zend_Controller_Front->dispatch( ).../Bootstrap.php:97
50.01711486048Zend_Controller_Dispatcher_Standard->dispatch( ).../Front.php:954
60.15662536736Zend_Controller_Action->dispatch( ).../Standard.php:289
70.93524009000Zend_Controller_Action_HelperBroker->notifyPostDispatch( ).../Action.php:523
80.93524010048Zend_Controller_Action_Helper_ViewRenderer->postDispatch( ).../HelperBroker.php:277
90.93524010368Zend_Controller_Action_Helper_ViewRenderer->render( ).../ViewRenderer.php:957
100.93544011344Zend_Controller_Action_Helper_ViewRenderer->renderScript( ).../ViewRenderer.php:918
110.93544011376Zend_View_Abstract->render( ).../ViewRenderer.php:897
120.95484027960Zend_View->_run( ).../Abstract.php:880
130.95494028968include( '/vivo/developers.vivomiles.com/application/views/scripts/doc/method.phtml' ).../View.php:108
142.37184181008Model_Doc->buildParamsWebService( ).../method.phtml:341
152.37194186800Model_Doc->getSession( ).../Doc.php:468
162.37204187960Model_Doc->callWebService( ).../Doc.php:377
172.57374215800Model_Doc->setSessionId( ).../Doc.php:364
https://api.vivoclass.com/Guardians.addTransactionComment?transaction_id=78&comment=4b43b0ae

Error Codes:

9999, 3703, 3704

Method: Guardians.getTransactionComments

Available since API version 2.1

Get Transaction Comments

Parameters:

Name Required Type Default Description
session_id Required string A currently active and valid webservice session id
transaction_id Required int The primary ID of the transaction

Response Parameters:

Name Description
users_id The user Id of the person leaving the comment
fname The first name of the user leaving the comment
sname The surname of the user leaving the comment
comment The comment
date_created The date that the comment was created

Example Request (click to see example response):


( ! ) Notice: Undefined property: stdClass::$user_data in /vivo/developers.vivomiles.com/application/models/Doc.php on line 400
Call Stack
#TimeMemoryFunctionLocation
10.0000240624{main}( ).../index.php:0
20.01671405760Zend_Application->run( ).../index.php:36
30.01671405880Zend_Application_Bootstrap_Bootstrap->run( ).../Application.php:366
40.01681406712Zend_Controller_Front->dispatch( ).../Bootstrap.php:97
50.01711486048Zend_Controller_Dispatcher_Standard->dispatch( ).../Front.php:954
60.15662536736Zend_Controller_Action->dispatch( ).../Standard.php:289
70.93524009000Zend_Controller_Action_HelperBroker->notifyPostDispatch( ).../Action.php:523
80.93524010048Zend_Controller_Action_Helper_ViewRenderer->postDispatch( ).../HelperBroker.php:277
90.93524010368Zend_Controller_Action_Helper_ViewRenderer->render( ).../ViewRenderer.php:957
100.93544011344Zend_Controller_Action_Helper_ViewRenderer->renderScript( ).../ViewRenderer.php:918
110.93544011376Zend_View_Abstract->render( ).../ViewRenderer.php:897
120.95484027960Zend_View->_run( ).../Abstract.php:880
130.95494028968include( '/vivo/developers.vivomiles.com/application/views/scripts/doc/method.phtml' ).../View.php:108
142.57514197336Model_Doc->buildParamsWebService( ).../method.phtml:341
152.57524203040Model_Doc->getSession( ).../Doc.php:468
162.57524204200Model_Doc->callWebService( ).../Doc.php:377
172.77064233856Model_Doc->setSessionId( ).../Doc.php:364

( ! ) Notice: Trying to get property of non-object in /vivo/developers.vivomiles.com/application/models/Doc.php on line 400
Call Stack
#TimeMemoryFunctionLocation
10.0000240624{main}( ).../index.php:0
20.01671405760Zend_Application->run( ).../index.php:36
30.01671405880Zend_Application_Bootstrap_Bootstrap->run( ).../Application.php:366
40.01681406712Zend_Controller_Front->dispatch( ).../Bootstrap.php:97
50.01711486048Zend_Controller_Dispatcher_Standard->dispatch( ).../Front.php:954
60.15662536736Zend_Controller_Action->dispatch( ).../Standard.php:289
70.93524009000Zend_Controller_Action_HelperBroker->notifyPostDispatch( ).../Action.php:523
80.93524010048Zend_Controller_Action_Helper_ViewRenderer->postDispatch( ).../HelperBroker.php:277
90.93524010368Zend_Controller_Action_Helper_ViewRenderer->render( ).../ViewRenderer.php:957
100.93544011344Zend_Controller_Action_Helper_ViewRenderer->renderScript( ).../ViewRenderer.php:918
110.93544011376Zend_View_Abstract->render( ).../ViewRenderer.php:897
120.95484027960Zend_View->_run( ).../Abstract.php:880
130.95494028968include( '/vivo/developers.vivomiles.com/application/views/scripts/doc/method.phtml' ).../View.php:108
142.57514197336Model_Doc->buildParamsWebService( ).../method.phtml:341
152.57524203040Model_Doc->getSession( ).../Doc.php:468
162.57524204200Model_Doc->callWebService( ).../Doc.php:377
172.77064233856Model_Doc->setSessionId( ).../Doc.php:364
https://api.vivoclass.com/Guardians.getTransactionComments?transaction_id=63

Error Codes:

9999, 3703

Method: Shop.getCategories

Available since API version 2.1

Returns all shop categories

Parameters:

Name Required Type Default Description
session_id Required string A currently active and valid webservice session id

Response Parameters:

Name Description
name The name of the product
description The description of the product
quantity The quantity left in stock
rating_star The rating the product gets out of 5
rating_num The position this product comes out of all products & their ratings
supplier_org The supplier of the product
shop_goods_selected_id The ID specifically used for this organisation
organisations_id The organisation ID this product is to be displayed for
shop_goods_id The internal id of the product returned
price The current price of the product
date_added The date the product was added to the shop

Example Request (click to see example response):


( ! ) Notice: Undefined property: stdClass::$user_data in /vivo/developers.vivomiles.com/application/models/Doc.php on line 400
Call Stack
#TimeMemoryFunctionLocation
10.0000240624{main}( ).../index.php:0
20.01671405760Zend_Application->run( ).../index.php:36
30.01671405880Zend_Application_Bootstrap_Bootstrap->run( ).../Application.php:366
40.01681406712Zend_Controller_Front->dispatch( ).../Bootstrap.php:97
50.01711486048Zend_Controller_Dispatcher_Standard->dispatch( ).../Front.php:954
60.15662536736Zend_Controller_Action->dispatch( ).../Standard.php:289
70.93524009000Zend_Controller_Action_HelperBroker->notifyPostDispatch( ).../Action.php:523
80.93524010048Zend_Controller_Action_Helper_ViewRenderer->postDispatch( ).../HelperBroker.php:277
90.93524010368Zend_Controller_Action_Helper_ViewRenderer->render( ).../ViewRenderer.php:957
100.93544011344Zend_Controller_Action_Helper_ViewRenderer->renderScript( ).../ViewRenderer.php:918
110.93544011376Zend_View_Abstract->render( ).../ViewRenderer.php:897
120.95484027960Zend_View->_run( ).../Abstract.php:880
130.95494028968include( '/vivo/developers.vivomiles.com/application/views/scripts/doc/method.phtml' ).../View.php:108
142.77204213208Model_Doc->buildParamsWebService( ).../method.phtml:341
152.77214218784Model_Doc->getSession( ).../Doc.php:468
162.77214219944Model_Doc->callWebService( ).../Doc.php:377
172.96384252848Model_Doc->setSessionId( ).../Doc.php:364

( ! ) Notice: Trying to get property of non-object in /vivo/developers.vivomiles.com/application/models/Doc.php on line 400
Call Stack
#TimeMemoryFunctionLocation
10.0000240624{main}( ).../index.php:0
20.01671405760Zend_Application->run( ).../index.php:36
30.01671405880Zend_Application_Bootstrap_Bootstrap->run( ).../Application.php:366
40.01681406712Zend_Controller_Front->dispatch( ).../Bootstrap.php:97
50.01711486048Zend_Controller_Dispatcher_Standard->dispatch( ).../Front.php:954
60.15662536736Zend_Controller_Action->dispatch( ).../Standard.php:289
70.93524009000Zend_Controller_Action_HelperBroker->notifyPostDispatch( ).../Action.php:523
80.93524010048Zend_Controller_Action_Helper_ViewRenderer->postDispatch( ).../HelperBroker.php:277
90.93524010368Zend_Controller_Action_Helper_ViewRenderer->render( ).../ViewRenderer.php:957
100.93544011344Zend_Controller_Action_Helper_ViewRenderer->renderScript( ).../ViewRenderer.php:918
110.93544011376Zend_View_Abstract->render( ).../ViewRenderer.php:897
120.95484027960Zend_View->_run( ).../Abstract.php:880
130.95494028968include( '/vivo/developers.vivomiles.com/application/views/scripts/doc/method.phtml' ).../View.php:108
142.77204213208Model_Doc->buildParamsWebService( ).../method.phtml:341
152.77214218784Model_Doc->getSession( ).../Doc.php:468
162.77214219944Model_Doc->callWebService( ).../Doc.php:377
172.96384252848Model_Doc->setSessionId( ).../Doc.php:364
https://api.vivoclass.com/Shop.getCategories?

Error Codes:

3200, 3202, 3203, 3204, 3205, 3502, 3506

Method: Shop.getItems

Available since API version 2.1

Returns all items accessible in the shop to this user

Parameters:

Name Required Type Default Description
session_id Required string A currently active and valid webservice session id
display Optional int The amount of items to show per page
page Optional int The current page we are on
category_id Optional int The id of a category to display
tag Optional string The tag assigned to the product
image_size Optional Allows requesting of image of specific dimensions: small, medium or large

Response Parameters:

Name Description
name The name of the product
shop_category_name The category name of the product
description The description of the product
detailed_info The detailed info of the product
quantity The quantity left in stock
rating_star The rating the product gets out of 5
rating_num The position this product comes out of all products & their ratings
supplier_org The supplier of the product
shop_goods_selected_id The ID specifically used for this organisation
organisations_id The organisation ID this product is to be displayed for
shop_goods_id The internal id of the product returned
price The current price of the product
date_added The date the product was added to the shop
img Ideal size image URL
smallImg Small image URL
largeImg Large image URL

Example Request (click to see example response):


( ! ) Notice: Undefined property: stdClass::$user_data in /vivo/developers.vivomiles.com/application/models/Doc.php on line 400
Call Stack
#TimeMemoryFunctionLocation
10.0000240624{main}( ).../index.php:0
20.01671405760Zend_Application->run( ).../index.php:36
30.01671405880Zend_Application_Bootstrap_Bootstrap->run( ).../Application.php:366
40.01681406712Zend_Controller_Front->dispatch( ).../Bootstrap.php:97
50.01711486048Zend_Controller_Dispatcher_Standard->dispatch( ).../Front.php:954
60.15662536736Zend_Controller_Action->dispatch( ).../Standard.php:289
70.93524009000Zend_Controller_Action_HelperBroker->notifyPostDispatch( ).../Action.php:523
80.93524010048Zend_Controller_Action_Helper_ViewRenderer->postDispatch( ).../HelperBroker.php:277
90.93524010368Zend_Controller_Action_Helper_ViewRenderer->render( ).../ViewRenderer.php:957
100.93544011344Zend_Controller_Action_Helper_ViewRenderer->renderScript( ).../ViewRenderer.php:918
110.93544011376Zend_View_Abstract->render( ).../ViewRenderer.php:897
120.95484027960Zend_View->_run( ).../Abstract.php:880
130.95494028968include( '/vivo/developers.vivomiles.com/application/views/scripts/doc/method.phtml' ).../View.php:108
142.96524247064Model_Doc->buildParamsWebService( ).../method.phtml:341
152.96524253128Model_Doc->getSession( ).../Doc.php:468
162.96524254288Model_Doc->callWebService( ).../Doc.php:377
173.16164296488Model_Doc->setSessionId( ).../Doc.php:364

( ! ) Notice: Trying to get property of non-object in /vivo/developers.vivomiles.com/application/models/Doc.php on line 400
Call Stack
#TimeMemoryFunctionLocation
10.0000240624{main}( ).../index.php:0
20.01671405760Zend_Application->run( ).../index.php:36
30.01671405880Zend_Application_Bootstrap_Bootstrap->run( ).../Application.php:366
40.01681406712Zend_Controller_Front->dispatch( ).../Bootstrap.php:97
50.01711486048Zend_Controller_Dispatcher_Standard->dispatch( ).../Front.php:954
60.15662536736Zend_Controller_Action->dispatch( ).../Standard.php:289
70.93524009000Zend_Controller_Action_HelperBroker->notifyPostDispatch( ).../Action.php:523
80.93524010048Zend_Controller_Action_Helper_ViewRenderer->postDispatch( ).../HelperBroker.php:277
90.93524010368Zend_Controller_Action_Helper_ViewRenderer->render( ).../ViewRenderer.php:957
100.93544011344Zend_Controller_Action_Helper_ViewRenderer->renderScript( ).../ViewRenderer.php:918
110.93544011376Zend_View_Abstract->render( ).../ViewRenderer.php:897
120.95484027960Zend_View->_run( ).../Abstract.php:880
130.95494028968include( '/vivo/developers.vivomiles.com/application/views/scripts/doc/method.phtml' ).../View.php:108
142.96524247064Model_Doc->buildParamsWebService( ).../method.phtml:341
152.96524253128Model_Doc->getSession( ).../Doc.php:468
162.96524254288Model_Doc->callWebService( ).../Doc.php:377
173.16164296488Model_Doc->setSessionId( ).../Doc.php:364
https://api.vivoclass.com/Shop.getItems?display=64&page=58&category_id=81

Error Codes:

3200, 3202, 3203, 3204, 3205, 3505, 3506

Method: Shop.getItem

Available since API version 2.1

Returns item by ID

Parameters:

Name Required Type Default Description
session_id Required string A currently active and valid webservice session id
item_id Required int The ID of the item to select
imageSize Optional string Allows requesting of image of specific dimensions: small, medium or large

Response Parameters:

Name Description
name The name of the product
shop_category_name The category name of the product
description The description of the product
detailed_info The detailed info of the product
quantity The quantity left in stock
rating_star The rating the product gets out of 5
rating_num The position this product comes out of all products & their ratings
supplier_org The supplier of the product
shop_goods_selected_id The ID specifically used for this organisation
organisations_id The organisation ID this product is to be displayed for
shop_goods_id The internal id of the product returned
price The current price of the product
date_added The date the product was added to the shop
img Ideal size image URL
smallImg Small image URL
largeImg Large image URL

Example Request (click to see example response):


( ! ) Notice: Undefined property: stdClass::$user_data in /vivo/developers.vivomiles.com/application/models/Doc.php on line 400
Call Stack
#TimeMemoryFunctionLocation
10.0000240624{main}( ).../index.php:0
20.01671405760Zend_Application->run( ).../index.php:36
30.01671405880Zend_Application_Bootstrap_Bootstrap->run( ).../Application.php:366
40.01681406712Zend_Controller_Front->dispatch( ).../Bootstrap.php:97
50.01711486048Zend_Controller_Dispatcher_Standard->dispatch( ).../Front.php:954
60.15662536736Zend_Controller_Action->dispatch( ).../Standard.php:289
70.93524009000Zend_Controller_Action_HelperBroker->notifyPostDispatch( ).../Action.php:523
80.93524010048Zend_Controller_Action_Helper_ViewRenderer->postDispatch( ).../HelperBroker.php:277
90.93524010368Zend_Controller_Action_Helper_ViewRenderer->render( ).../ViewRenderer.php:957
100.93544011344Zend_Controller_Action_Helper_ViewRenderer->renderScript( ).../ViewRenderer.php:918
110.93544011376Zend_View_Abstract->render( ).../ViewRenderer.php:897
120.95484027960Zend_View->_run( ).../Abstract.php:880
130.95494028968include( '/vivo/developers.vivomiles.com/application/views/scripts/doc/method.phtml' ).../View.php:108
143.16304264016Model_Doc->buildParamsWebService( ).../method.phtml:341
153.16314269784Model_Doc->getSession( ).../Doc.php:468
163.16314270944Model_Doc->callWebService( ).../Doc.php:377
173.35654310248Model_Doc->setSessionId( ).../Doc.php:364

( ! ) Notice: Trying to get property of non-object in /vivo/developers.vivomiles.com/application/models/Doc.php on line 400
Call Stack
#TimeMemoryFunctionLocation
10.0000240624{main}( ).../index.php:0
20.01671405760Zend_Application->run( ).../index.php:36
30.01671405880Zend_Application_Bootstrap_Bootstrap->run( ).../Application.php:366
40.01681406712Zend_Controller_Front->dispatch( ).../Bootstrap.php:97
50.01711486048Zend_Controller_Dispatcher_Standard->dispatch( ).../Front.php:954
60.15662536736Zend_Controller_Action->dispatch( ).../Standard.php:289
70.93524009000Zend_Controller_Action_HelperBroker->notifyPostDispatch( ).../Action.php:523
80.93524010048Zend_Controller_Action_Helper_ViewRenderer->postDispatch( ).../HelperBroker.php:277
90.93524010368Zend_Controller_Action_Helper_ViewRenderer->render( ).../ViewRenderer.php:957
100.93544011344Zend_Controller_Action_Helper_ViewRenderer->renderScript( ).../ViewRenderer.php:918
110.93544011376Zend_View_Abstract->render( ).../ViewRenderer.php:897
120.95484027960Zend_View->_run( ).../Abstract.php:880
130.95494028968include( '/vivo/developers.vivomiles.com/application/views/scripts/doc/method.phtml' ).../View.php:108
143.16304264016Model_Doc->buildParamsWebService( ).../method.phtml:341
153.16314269784Model_Doc->getSession( ).../Doc.php:468
163.16314270944Model_Doc->callWebService( ).../Doc.php:377
173.35654310248Model_Doc->setSessionId( ).../Doc.php:364
https://api.vivoclass.com/Shop.getItem?item_id=35

Error Codes:

3200, 3202, 3203, 3204, 3205, 3500, 3505, 3506

Method: Shop.rateItem

Available since API version 2.1

Allow for the rating of a shop Item

Parameters:

Name Required Type Default Description
session_id Required string a currently active and valid webservice session id
shop_goods_id Required int ID of the shop item that we want to credit
star_rating Required int the numerical rating of the item in stars (1-5)

Response Parameters:

Name Description
rating the new rating of the the item

Example Request (click to see example response):


( ! ) Notice: Undefined property: stdClass::$user_data in /vivo/developers.vivomiles.com/application/models/Doc.php on line 400
Call Stack
#TimeMemoryFunctionLocation
10.0000240624{main}( ).../index.php:0
20.01671405760Zend_Application->run( ).../index.php:36
30.01671405880Zend_Application_Bootstrap_Bootstrap->run( ).../Application.php:366
40.01681406712Zend_Controller_Front->dispatch( ).../Bootstrap.php:97
50.01711486048Zend_Controller_Dispatcher_Standard->dispatch( ).../Front.php:954
60.15662536736Zend_Controller_Action->dispatch( ).../Standard.php:289
70.93524009000Zend_Controller_Action_HelperBroker->notifyPostDispatch( ).../Action.php:523
80.93524010048Zend_Controller_Action_Helper_ViewRenderer->postDispatch( ).../HelperBroker.php:277
90.93524010368Zend_Controller_Action_Helper_ViewRenderer->render( ).../ViewRenderer.php:957
100.93544011344Zend_Controller_Action_Helper_ViewRenderer->renderScript( ).../ViewRenderer.php:918
110.93544011376Zend_View_Abstract->render( ).../ViewRenderer.php:897
120.95484027960Zend_View->_run( ).../Abstract.php:880
130.95494028968include( '/vivo/developers.vivomiles.com/application/views/scripts/doc/method.phtml' ).../View.php:108
143.35804280936Model_Doc->buildParamsWebService( ).../method.phtml:341
153.35804286712Model_Doc->getSession( ).../Doc.php:468
163.35804287872Model_Doc->callWebService( ).../Doc.php:377
173.55544315016Model_Doc->setSessionId( ).../Doc.php:364

( ! ) Notice: Trying to get property of non-object in /vivo/developers.vivomiles.com/application/models/Doc.php on line 400
Call Stack
#TimeMemoryFunctionLocation
10.0000240624{main}( ).../index.php:0
20.01671405760Zend_Application->run( ).../index.php:36
30.01671405880Zend_Application_Bootstrap_Bootstrap->run( ).../Application.php:366
40.01681406712Zend_Controller_Front->dispatch( ).../Bootstrap.php:97
50.01711486048Zend_Controller_Dispatcher_Standard->dispatch( ).../Front.php:954
60.15662536736Zend_Controller_Action->dispatch( ).../Standard.php:289
70.93524009000Zend_Controller_Action_HelperBroker->notifyPostDispatch( ).../Action.php:523
80.93524010048Zend_Controller_Action_Helper_ViewRenderer->postDispatch( ).../HelperBroker.php:277
90.93524010368Zend_Controller_Action_Helper_ViewRenderer->render( ).../ViewRenderer.php:957
100.93544011344Zend_Controller_Action_Helper_ViewRenderer->renderScript( ).../ViewRenderer.php:918
110.93544011376Zend_View_Abstract->render( ).../ViewRenderer.php:897
120.95484027960Zend_View->_run( ).../Abstract.php:880
130.95494028968include( '/vivo/developers.vivomiles.com/application/views/scripts/doc/method.phtml' ).../View.php:108
143.35804280936Model_Doc->buildParamsWebService( ).../method.phtml:341
153.35804286712Model_Doc->getSession( ).../Doc.php:468
163.35804287872Model_Doc->callWebService( ).../Doc.php:377
173.55544315016Model_Doc->setSessionId( ).../Doc.php:364
https://api.vivoclass.com/Shop.rateItem?shop_goods_id=54&star_rating=4

Error Codes:

This method does not return any errors

Method: Shop.doPurchaseShopGood

Available since API version 2.1

Purchase shop good with given id

Parameters:

Name Required Type Default Description
session_id Required string A currently active and valid webservice session id
shop_goods_id Required int The id of the shop_goods_id to purchase
mobile Optional string User's mobile number
email Optional string User's email
password Optional string User's password. Optional only if organisation, user belongs to, allows purchasing without password confirmation

Response Parameters:

Name Description
status If no error occured this will contain success

Example Request (click to see example response):


( ! ) Notice: Undefined property: stdClass::$user_data in /vivo/developers.vivomiles.com/application/models/Doc.php on line 400
Call Stack
#TimeMemoryFunctionLocation
10.0000240624{main}( ).../index.php:0
20.01671405760Zend_Application->run( ).../index.php:36
30.01671405880Zend_Application_Bootstrap_Bootstrap->run( ).../Application.php:366
40.01681406712Zend_Controller_Front->dispatch( ).../Bootstrap.php:97
50.01711486048Zend_Controller_Dispatcher_Standard->dispatch( ).../Front.php:954
60.15662536736Zend_Controller_Action->dispatch( ).../Standard.php:289
70.93524009000Zend_Controller_Action_HelperBroker->notifyPostDispatch( ).../Action.php:523
80.93524010048Zend_Controller_Action_Helper_ViewRenderer->postDispatch( ).../HelperBroker.php:277
90.93524010368Zend_Controller_Action_Helper_ViewRenderer->render( ).../ViewRenderer.php:957
100.93544011344Zend_Controller_Action_Helper_ViewRenderer->renderScript( ).../ViewRenderer.php:918
110.93544011376Zend_View_Abstract->render( ).../ViewRenderer.php:897
120.95484027960Zend_View->_run( ).../Abstract.php:880
130.95494028968include( '/vivo/developers.vivomiles.com/application/views/scripts/doc/method.phtml' ).../View.php:108
143.55694293880Model_Doc->buildParamsWebService( ).../method.phtml:341
153.55704299864Model_Doc->getSession( ).../Doc.php:468
163.55704301024Model_Doc->callWebService( ).../Doc.php:377
173.75404332712Model_Doc->setSessionId( ).../Doc.php:364

( ! ) Notice: Trying to get property of non-object in /vivo/developers.vivomiles.com/application/models/Doc.php on line 400
Call Stack
#TimeMemoryFunctionLocation
10.0000240624{main}( ).../index.php:0
20.01671405760Zend_Application->run( ).../index.php:36
30.01671405880Zend_Application_Bootstrap_Bootstrap->run( ).../Application.php:366
40.01681406712Zend_Controller_Front->dispatch( ).../Bootstrap.php:97
50.01711486048Zend_Controller_Dispatcher_Standard->dispatch( ).../Front.php:954
60.15662536736Zend_Controller_Action->dispatch( ).../Standard.php:289
70.93524009000Zend_Controller_Action_HelperBroker->notifyPostDispatch( ).../Action.php:523
80.93524010048Zend_Controller_Action_Helper_ViewRenderer->postDispatch( ).../HelperBroker.php:277
90.93524010368Zend_Controller_Action_Helper_ViewRenderer->render( ).../ViewRenderer.php:957
100.93544011344Zend_Controller_Action_Helper_ViewRenderer->renderScript( ).../ViewRenderer.php:918
110.93544011376Zend_View_Abstract->render( ).../ViewRenderer.php:897
120.95484027960Zend_View->_run( ).../Abstract.php:880
130.95494028968include( '/vivo/developers.vivomiles.com/application/views/scripts/doc/method.phtml' ).../View.php:108
143.55694293880Model_Doc->buildParamsWebService( ).../method.phtml:341
153.55704299864Model_Doc->getSession( ).../Doc.php:468
163.55704301024Model_Doc->callWebService( ).../Doc.php:377
173.75404332712Model_Doc->setSessionId( ).../Doc.php:364
https://api.vivoclass.com/Shop.doPurchaseShopGood?shop_goods_id=0

Error Codes:

3200, 3202, 3203, 3204, 3205, 3500, 3501, 3502, 3503, 3504, 3505, 3506, 3507

Method: Shop.getShopOrderHistory

Available since API version

Returns shop orders history

Parameters:

Name Required Type Default Description
session_id Required string A currently active and valid webservice session id
imageSize Optional string Allows requesting of image of specific dimensions: small, medium or large

Response Parameters:

Name Description
orderId The Order id of the product
orderDate The orderDate of the product
productName The productName of the product
productPrice The productPrice of the product
orderStatus The orderStatus of the products
isVoucher Whether the item is a voucher
shopGoodsId The item id
img Ideal size image URL
smallImg Small image URL
largeImg Large image URL
newLookVoucherUrl optional NewLook voucher link if order for NewLook voucher

Example Request (click to see example response):


( ! ) Notice: Undefined property: stdClass::$user_data in /vivo/developers.vivomiles.com/application/models/Doc.php on line 400
Call Stack
#TimeMemoryFunctionLocation
10.0000240624{main}( ).../index.php:0
20.01671405760Zend_Application->run( ).../index.php:36
30.01671405880Zend_Application_Bootstrap_Bootstrap->run( ).../Application.php:366
40.01681406712Zend_Controller_Front->dispatch( ).../Bootstrap.php:97
50.01711486048Zend_Controller_Dispatcher_Standard->dispatch( ).../Front.php:954
60.15662536736Zend_Controller_Action->dispatch( ).../Standard.php:289
70.93524009000Zend_Controller_Action_HelperBroker->notifyPostDispatch( ).../Action.php:523
80.93524010048Zend_Controller_Action_Helper_ViewRenderer->postDispatch( ).../HelperBroker.php:277
90.93524010368Zend_Controller_Action_Helper_ViewRenderer->render( ).../ViewRenderer.php:957
100.93544011344Zend_Controller_Action_Helper_ViewRenderer->renderScript( ).../ViewRenderer.php:918
110.93544011376Zend_View_Abstract->render( ).../ViewRenderer.php:897
120.95484027960Zend_View->_run( ).../Abstract.php:880
130.95494028968include( '/vivo/developers.vivomiles.com/application/views/scripts/doc/method.phtml' ).../View.php:108
143.75554315608Model_Doc->buildParamsWebService( ).../method.phtml:341
153.75564321304Model_Doc->getSession( ).../Doc.php:468
163.75564322464Model_Doc->callWebService( ).../Doc.php:377
173.95724356864Model_Doc->setSessionId( ).../Doc.php:364

( ! ) Notice: Trying to get property of non-object in /vivo/developers.vivomiles.com/application/models/Doc.php on line 400
Call Stack
#TimeMemoryFunctionLocation
10.0000240624{main}( ).../index.php:0
20.01671405760Zend_Application->run( ).../index.php:36
30.01671405880Zend_Application_Bootstrap_Bootstrap->run( ).../Application.php:366
40.01681406712Zend_Controller_Front->dispatch( ).../Bootstrap.php:97
50.01711486048Zend_Controller_Dispatcher_Standard->dispatch( ).../Front.php:954
60.15662536736Zend_Controller_Action->dispatch( ).../Standard.php:289
70.93524009000Zend_Controller_Action_HelperBroker->notifyPostDispatch( ).../Action.php:523
80.93524010048Zend_Controller_Action_Helper_ViewRenderer->postDispatch( ).../HelperBroker.php:277
90.93524010368Zend_Controller_Action_Helper_ViewRenderer->render( ).../ViewRenderer.php:957
100.93544011344Zend_Controller_Action_Helper_ViewRenderer->renderScript( ).../ViewRenderer.php:918
110.93544011376Zend_View_Abstract->render( ).../ViewRenderer.php:897
120.95484027960Zend_View->_run( ).../Abstract.php:880
130.95494028968include( '/vivo/developers.vivomiles.com/application/views/scripts/doc/method.phtml' ).../View.php:108
143.75554315608Model_Doc->buildParamsWebService( ).../method.phtml:341
153.75564321304Model_Doc->getSession( ).../Doc.php:468
163.75564322464Model_Doc->callWebService( ).../Doc.php:377
173.95724356864Model_Doc->setSessionId( ).../Doc.php:364
https://api.vivoclass.com/Shop.getShopOrderHistory?

Error Codes:

3200, 3500, 3501, 3502, 3503, 3505

Method: Shop.cancelOrder

Available since API version

Cancels the status of the order if it is allowed. Does not throw error if the order had been cancelled prior to calling this method

Parameters:

Name Required Type Default Description
session_id Required string A currently active and valid webservice session id
order_id Required int The id of the order which will attempt to be cancelled

Response Parameters:

Name Description
status Returns success if the order's status is cancelled after the method ran

Example Request (click to see example response):


( ! ) Notice: Undefined property: stdClass::$user_data in /vivo/developers.vivomiles.com/application/models/Doc.php on line 400
Call Stack
#TimeMemoryFunctionLocation
10.0000240624{main}( ).../index.php:0
20.01671405760Zend_Application->run( ).../index.php:36
30.01671405880Zend_Application_Bootstrap_Bootstrap->run( ).../Application.php:366
40.01681406712Zend_Controller_Front->dispatch( ).../Bootstrap.php:97
50.01711486048Zend_Controller_Dispatcher_Standard->dispatch( ).../Front.php:954
60.15662536736Zend_Controller_Action->dispatch( ).../Standard.php:289
70.93524009000Zend_Controller_Action_HelperBroker->notifyPostDispatch( ).../Action.php:523
80.93524010048Zend_Controller_Action_Helper_ViewRenderer->postDispatch( ).../HelperBroker.php:277
90.93524010368Zend_Controller_Action_Helper_ViewRenderer->render( ).../ViewRenderer.php:957
100.93544011344Zend_Controller_Action_Helper_ViewRenderer->renderScript( ).../ViewRenderer.php:918
110.93544011376Zend_View_Abstract->render( ).../ViewRenderer.php:897
120.95484027960Zend_View->_run( ).../Abstract.php:880
130.95494028968include( '/vivo/developers.vivomiles.com/application/views/scripts/doc/method.phtml' ).../View.php:108
143.95874328984Model_Doc->buildParamsWebService( ).../method.phtml:341
153.95884334664Model_Doc->getSession( ).../Doc.php:468
163.95884335824Model_Doc->callWebService( ).../Doc.php:377
174.15294363408Model_Doc->setSessionId( ).../Doc.php:364

( ! ) Notice: Trying to get property of non-object in /vivo/developers.vivomiles.com/application/models/Doc.php on line 400
Call Stack
#TimeMemoryFunctionLocation
10.0000240624{main}( ).../index.php:0
20.01671405760Zend_Application->run( ).../index.php:36
30.01671405880Zend_Application_Bootstrap_Bootstrap->run( ).../Application.php:366
40.01681406712Zend_Controller_Front->dispatch( ).../Bootstrap.php:97
50.01711486048Zend_Controller_Dispatcher_Standard->dispatch( ).../Front.php:954
60.15662536736Zend_Controller_Action->dispatch( ).../Standard.php:289
70.93524009000Zend_Controller_Action_HelperBroker->notifyPostDispatch( ).../Action.php:523
80.93524010048Zend_Controller_Action_Helper_ViewRenderer->postDispatch( ).../HelperBroker.php:277
90.93524010368Zend_Controller_Action_Helper_ViewRenderer->render( ).../ViewRenderer.php:957
100.93544011344Zend_Controller_Action_Helper_ViewRenderer->renderScript( ).../ViewRenderer.php:918
110.93544011376Zend_View_Abstract->render( ).../ViewRenderer.php:897
120.95484027960Zend_View->_run( ).../Abstract.php:880
130.95494028968include( '/vivo/developers.vivomiles.com/application/views/scripts/doc/method.phtml' ).../View.php:108
143.95874328984Model_Doc->buildParamsWebService( ).../method.phtml:341
153.95884334664Model_Doc->getSession( ).../Doc.php:468
163.95884335824Model_Doc->callWebService( ).../Doc.php:377
174.15294363408Model_Doc->setSessionId( ).../Doc.php:364
https://api.vivoclass.com/Shop.cancelOrder?order_id=58

Error Codes:

3200, 3201, 3501, 3505, 3508, 3509

Method: Shop.getShopManager

Available since API version

Get the name of the shop manager

Parameters:

Name Required Type Default Description
session_id Required string A currently active and valid webservice session id

Response Parameters:

Name Description
name The shop managers name

Example Request (click to see example response):


( ! ) Notice: Undefined property: stdClass::$user_data in /vivo/developers.vivomiles.com/application/models/Doc.php on line 400
Call Stack
#TimeMemoryFunctionLocation
10.0000240624{main}( ).../index.php:0
20.01671405760Zend_Application->run( ).../index.php:36
30.01671405880Zend_Application_Bootstrap_Bootstrap->run( ).../Application.php:366
40.01681406712Zend_Controller_Front->dispatch( ).../Bootstrap.php:97
50.01711486048Zend_Controller_Dispatcher_Standard->dispatch( ).../Front.php:954
60.15662536736Zend_Controller_Action->dispatch( ).../Standard.php:289
70.93524009000Zend_Controller_Action_HelperBroker->notifyPostDispatch( ).../Action.php:523
80.93524010048Zend_Controller_Action_Helper_ViewRenderer->postDispatch( ).../HelperBroker.php:277
90.93524010368Zend_Controller_Action_Helper_ViewRenderer->render( ).../ViewRenderer.php:957
100.93544011344Zend_Controller_Action_Helper_ViewRenderer->renderScript( ).../ViewRenderer.php:918
110.93544011376Zend_View_Abstract->render( ).../ViewRenderer.php:897
120.95484027960Zend_View->_run( ).../Abstract.php:880
130.95494028968include( '/vivo/developers.vivomiles.com/application/views/scripts/doc/method.phtml' ).../View.php:108
144.15434345728Model_Doc->buildParamsWebService( ).../method.phtml:341
154.15444351304Model_Doc->getSession( ).../Doc.php:468
164.15444352464Model_Doc->callWebService( ).../Doc.php:377
174.35824378792Model_Doc->setSessionId( ).../Doc.php:364

( ! ) Notice: Trying to get property of non-object in /vivo/developers.vivomiles.com/application/models/Doc.php on line 400
Call Stack
#TimeMemoryFunctionLocation
10.0000240624{main}( ).../index.php:0
20.01671405760Zend_Application->run( ).../index.php:36
30.01671405880Zend_Application_Bootstrap_Bootstrap->run( ).../Application.php:366
40.01681406712Zend_Controller_Front->dispatch( ).../Bootstrap.php:97
50.01711486048Zend_Controller_Dispatcher_Standard->dispatch( ).../Front.php:954
60.15662536736Zend_Controller_Action->dispatch( ).../Standard.php:289
70.93524009000Zend_Controller_Action_HelperBroker->notifyPostDispatch( ).../Action.php:523
80.93524010048Zend_Controller_Action_Helper_ViewRenderer->postDispatch( ).../HelperBroker.php:277
90.93524010368Zend_Controller_Action_Helper_ViewRenderer->render( ).../ViewRenderer.php:957
100.93544011344Zend_Controller_Action_Helper_ViewRenderer->renderScript( ).../ViewRenderer.php:918
110.93544011376Zend_View_Abstract->render( ).../ViewRenderer.php:897
120.95484027960Zend_View->_run( ).../Abstract.php:880
130.95494028968include( '/vivo/developers.vivomiles.com/application/views/scripts/doc/method.phtml' ).../View.php:108
144.15434345728Model_Doc->buildParamsWebService( ).../method.phtml:341
154.15444351304Model_Doc->getSession( ).../Doc.php:468
164.15444352464Model_Doc->callWebService( ).../Doc.php:377
174.35824378792Model_Doc->setSessionId( ).../Doc.php:364
https://api.vivoclass.com/Shop.getShopManager?

Error Codes:

3200, 3201, 3505, 4100, 4101

Method: Staff.jumpTo

Available since API version 2.0

Returns info about a lesson and the students in the lesson

Parameters:

Name Required Type Default Description
session_id Required string A valid session_id representing a staff user
type Required string A valid resource_type representing jump mode
foreign_id Optional string A valid and unique external_id or primary_id representing the user in the remote system

Example Request (click to see example response):


( ! ) Notice: Undefined property: stdClass::$user_data in /vivo/developers.vivomiles.com/application/models/Doc.php on line 400
Call Stack
#TimeMemoryFunctionLocation
10.0000240624{main}( ).../index.php:0
20.01671405760Zend_Application->run( ).../index.php:36
30.01671405880Zend_Application_Bootstrap_Bootstrap->run( ).../Application.php:366
40.01681406712Zend_Controller_Front->dispatch( ).../Bootstrap.php:97
50.01711486048Zend_Controller_Dispatcher_Standard->dispatch( ).../Front.php:954
60.15662536736Zend_Controller_Action->dispatch( ).../Standard.php:289
70.93524009000Zend_Controller_Action_HelperBroker->notifyPostDispatch( ).../Action.php:523
80.93524010048Zend_Controller_Action_Helper_ViewRenderer->postDispatch( ).../HelperBroker.php:277
90.93524010368Zend_Controller_Action_Helper_ViewRenderer->render( ).../ViewRenderer.php:957
100.93544011344Zend_Controller_Action_Helper_ViewRenderer->renderScript( ).../ViewRenderer.php:918
110.93544011376Zend_View_Abstract->render( ).../ViewRenderer.php:897
120.95484027960Zend_View->_run( ).../Abstract.php:880
130.95494028968include( '/vivo/developers.vivomiles.com/application/views/scripts/doc/method.phtml' ).../View.php:108
144.35964363656Model_Doc->buildParamsWebService( ).../method.phtml:341
154.35974369424Model_Doc->getSession( ).../Doc.php:468
164.35974370584Model_Doc->callWebService( ).../Doc.php:377
174.55384397152Model_Doc->setSessionId( ).../Doc.php:364

( ! ) Notice: Trying to get property of non-object in /vivo/developers.vivomiles.com/application/models/Doc.php on line 400
Call Stack
#TimeMemoryFunctionLocation
10.0000240624{main}( ).../index.php:0
20.01671405760Zend_Application->run( ).../index.php:36
30.01671405880Zend_Application_Bootstrap_Bootstrap->run( ).../Application.php:366
40.01681406712Zend_Controller_Front->dispatch( ).../Bootstrap.php:97
50.01711486048Zend_Controller_Dispatcher_Standard->dispatch( ).../Front.php:954
60.15662536736Zend_Controller_Action->dispatch( ).../Standard.php:289
70.93524009000Zend_Controller_Action_HelperBroker->notifyPostDispatch( ).../Action.php:523
80.93524010048Zend_Controller_Action_Helper_ViewRenderer->postDispatch( ).../HelperBroker.php:277
90.93524010368Zend_Controller_Action_Helper_ViewRenderer->render( ).../ViewRenderer.php:957
100.93544011344Zend_Controller_Action_Helper_ViewRenderer->renderScript( ).../ViewRenderer.php:918
110.93544011376Zend_View_Abstract->render( ).../ViewRenderer.php:897
120.95484027960Zend_View->_run( ).../Abstract.php:880
130.95494028968include( '/vivo/developers.vivomiles.com/application/views/scripts/doc/method.phtml' ).../View.php:108
144.35964363656Model_Doc->buildParamsWebService( ).../method.phtml:341
154.35974369424Model_Doc->getSession( ).../Doc.php:468
164.35974370584Model_Doc->callWebService( ).../Doc.php:377
174.55384397152Model_Doc->setSessionId( ).../Doc.php:364
https://api.vivoclass.com/Staff.jumpTo?type=4b43b0ae

Error Codes:

This method does not return any errors

Method: Staff.getClassList

Available since API version 2.0

Returns info about a lesson and the students in the lesson

Parameters:

Name Required Type Default Description
session_id Required string A valid session_id representing a staff user
list_id Required int The Vivo list ID for one list owned by the logged staff user

Example Request (click to see example response):


( ! ) Notice: Undefined property: stdClass::$user_data in /vivo/developers.vivomiles.com/application/models/Doc.php on line 400
Call Stack
#TimeMemoryFunctionLocation
10.0000240624{main}( ).../index.php:0
20.01671405760Zend_Application->run( ).../index.php:36
30.01671405880Zend_Application_Bootstrap_Bootstrap->run( ).../Application.php:366
40.01681406712Zend_Controller_Front->dispatch( ).../Bootstrap.php:97
50.01711486048Zend_Controller_Dispatcher_Standard->dispatch( ).../Front.php:954
60.15662536736Zend_Controller_Action->dispatch( ).../Standard.php:289
70.93524009000Zend_Controller_Action_HelperBroker->notifyPostDispatch( ).../Action.php:523
80.93524010048Zend_Controller_Action_Helper_ViewRenderer->postDispatch( ).../HelperBroker.php:277
90.93524010368Zend_Controller_Action_Helper_ViewRenderer->render( ).../ViewRenderer.php:957
100.93544011344Zend_Controller_Action_Helper_ViewRenderer->renderScript( ).../ViewRenderer.php:918
110.93544011376Zend_View_Abstract->render( ).../ViewRenderer.php:897
120.95484027960Zend_View->_run( ).../Abstract.php:880
130.95494028968include( '/vivo/developers.vivomiles.com/application/views/scripts/doc/method.phtml' ).../View.php:108
144.55514378104Model_Doc->buildParamsWebService( ).../method.phtml:341
154.55524383776Model_Doc->getSession( ).../Doc.php:468
164.55524384936Model_Doc->callWebService( ).../Doc.php:377
174.75264410600Model_Doc->setSessionId( ).../Doc.php:364

( ! ) Notice: Trying to get property of non-object in /vivo/developers.vivomiles.com/application/models/Doc.php on line 400
Call Stack
#TimeMemoryFunctionLocation
10.0000240624{main}( ).../index.php:0
20.01671405760Zend_Application->run( ).../index.php:36
30.01671405880Zend_Application_Bootstrap_Bootstrap->run( ).../Application.php:366
40.01681406712Zend_Controller_Front->dispatch( ).../Bootstrap.php:97
50.01711486048Zend_Controller_Dispatcher_Standard->dispatch( ).../Front.php:954
60.15662536736Zend_Controller_Action->dispatch( ).../Standard.php:289
70.93524009000Zend_Controller_Action_HelperBroker->notifyPostDispatch( ).../Action.php:523
80.93524010048Zend_Controller_Action_Helper_ViewRenderer->postDispatch( ).../HelperBroker.php:277
90.93524010368Zend_Controller_Action_Helper_ViewRenderer->render( ).../ViewRenderer.php:957
100.93544011344Zend_Controller_Action_Helper_ViewRenderer->renderScript( ).../ViewRenderer.php:918
110.93544011376Zend_View_Abstract->render( ).../ViewRenderer.php:897
120.95484027960Zend_View->_run( ).../Abstract.php:880
130.95494028968include( '/vivo/developers.vivomiles.com/application/views/scripts/doc/method.phtml' ).../View.php:108
144.55514378104Model_Doc->buildParamsWebService( ).../method.phtml:341
154.55524383776Model_Doc->getSession( ).../Doc.php:468
164.55524384936Model_Doc->callWebService( ).../Doc.php:377
174.75264410600Model_Doc->setSessionId( ).../Doc.php:364
https://api.vivoclass.com/Staff.getClassList?list_id=11

Error Codes:

This method does not return any errors

Method: Staff.getHouseRewards

Available since API version 2.0

Returns info about an organisation's house

Parameters:

Name Required Type Default Description
session_id Required string A valid session_id representing a staff user
list_id Required int The Vivo list ID for one list owned by the logged staff user

Example Request (click to see example response):


( ! ) Notice: Undefined property: stdClass::$user_data in /vivo/developers.vivomiles.com/application/models/Doc.php on line 400
Call Stack
#TimeMemoryFunctionLocation
10.0000240624{main}( ).../index.php:0
20.01671405760Zend_Application->run( ).../index.php:36
30.01671405880Zend_Application_Bootstrap_Bootstrap->run( ).../Application.php:366
40.01681406712Zend_Controller_Front->dispatch( ).../Bootstrap.php:97
50.01711486048Zend_Controller_Dispatcher_Standard->dispatch( ).../Front.php:954
60.15662536736Zend_Controller_Action->dispatch( ).../Standard.php:289
70.93524009000Zend_Controller_Action_HelperBroker->notifyPostDispatch( ).../Action.php:523
80.93524010048Zend_Controller_Action_Helper_ViewRenderer->postDispatch( ).../HelperBroker.php:277
90.93524010368Zend_Controller_Action_Helper_ViewRenderer->render( ).../ViewRenderer.php:957
100.93544011344Zend_Controller_Action_Helper_ViewRenderer->renderScript( ).../ViewRenderer.php:918
110.93544011376Zend_View_Abstract->render( ).../ViewRenderer.php:897
120.95484027960Zend_View->_run( ).../Abstract.php:880
130.95494028968include( '/vivo/developers.vivomiles.com/application/views/scripts/doc/method.phtml' ).../View.php:108
144.75404394752Model_Doc->buildParamsWebService( ).../method.phtml:341
154.75414400424Model_Doc->getSession( ).../Doc.php:468
164.75414401584Model_Doc->callWebService( ).../Doc.php:377
174.94874426960Model_Doc->setSessionId( ).../Doc.php:364

( ! ) Notice: Trying to get property of non-object in /vivo/developers.vivomiles.com/application/models/Doc.php on line 400
Call Stack
#TimeMemoryFunctionLocation
10.0000240624{main}( ).../index.php:0
20.01671405760Zend_Application->run( ).../index.php:36
30.01671405880Zend_Application_Bootstrap_Bootstrap->run( ).../Application.php:366
40.01681406712Zend_Controller_Front->dispatch( ).../Bootstrap.php:97
50.01711486048Zend_Controller_Dispatcher_Standard->dispatch( ).../Front.php:954
60.15662536736Zend_Controller_Action->dispatch( ).../Standard.php:289
70.93524009000Zend_Controller_Action_HelperBroker->notifyPostDispatch( ).../Action.php:523
80.93524010048Zend_Controller_Action_Helper_ViewRenderer->postDispatch( ).../HelperBroker.php:277
90.93524010368Zend_Controller_Action_Helper_ViewRenderer->render( ).../ViewRenderer.php:957
100.93544011344Zend_Controller_Action_Helper_ViewRenderer->renderScript( ).../ViewRenderer.php:918
110.93544011376Zend_View_Abstract->render( ).../ViewRenderer.php:897
120.95484027960Zend_View->_run( ).../Abstract.php:880
130.95494028968include( '/vivo/developers.vivomiles.com/application/views/scripts/doc/method.phtml' ).../View.php:108
144.75404394752Model_Doc->buildParamsWebService( ).../method.phtml:341
154.75414400424Model_Doc->getSession( ).../Doc.php:468
164.75414401584Model_Doc->callWebService( ).../Doc.php:377
174.94874426960Model_Doc->setSessionId( ).../Doc.php:364
https://api.vivoclass.com/Staff.getHouseRewards?list_id=62

Error Codes:

This method does not return any errors

Method: Staff.getApplicableAwardCategories

Available since API version 2.0

Returns info about the award categories the current logged in staff can use to reward a class list.

Parameters:

Name Required Type Default Description
session_id Required string A valid session_id representing a staff user
max Optional int Maximum number of categories to return

Response Parameters:

Name Description
categories_id The id of the award category
default_miles The default amount of Vivos for this category
category Name of the category
guidelines Guideline for the category

Example Request (click to see example response):


( ! ) Notice: Undefined property: stdClass::$user_data in /vivo/developers.vivomiles.com/application/models/Doc.php on line 400
Call Stack
#TimeMemoryFunctionLocation
10.0000240624{main}( ).../index.php:0
20.01671405760Zend_Application->run( ).../index.php:36
30.01671405880Zend_Application_Bootstrap_Bootstrap->run( ).../Application.php:366
40.01681406712Zend_Controller_Front->dispatch( ).../Bootstrap.php:97
50.01711486048Zend_Controller_Dispatcher_Standard->dispatch( ).../Front.php:954
60.15662536736Zend_Controller_Action->dispatch( ).../Standard.php:289
70.93524009000Zend_Controller_Action_HelperBroker->notifyPostDispatch( ).../Action.php:523
80.93524010048Zend_Controller_Action_Helper_ViewRenderer->postDispatch( ).../HelperBroker.php:277
90.93524010368Zend_Controller_Action_Helper_ViewRenderer->render( ).../ViewRenderer.php:957
100.93544011344Zend_Controller_Action_Helper_ViewRenderer->renderScript( ).../ViewRenderer.php:918
110.93544011376Zend_View_Abstract->render( ).../ViewRenderer.php:897
120.95484027960Zend_View->_run( ).../Abstract.php:880
130.95494028968include( '/vivo/developers.vivomiles.com/application/views/scripts/doc/method.phtml' ).../View.php:108
144.95014410568Model_Doc->buildParamsWebService( ).../method.phtml:341
154.95024416272Model_Doc->getSession( ).../Doc.php:468
164.95024417432Model_Doc->callWebService( ).../Doc.php:377
175.14804446088Model_Doc->setSessionId( ).../Doc.php:364

( ! ) Notice: Trying to get property of non-object in /vivo/developers.vivomiles.com/application/models/Doc.php on line 400
Call Stack
#TimeMemoryFunctionLocation
10.0000240624{main}( ).../index.php:0
20.01671405760Zend_Application->run( ).../index.php:36
30.01671405880Zend_Application_Bootstrap_Bootstrap->run( ).../Application.php:366
40.01681406712Zend_Controller_Front->dispatch( ).../Bootstrap.php:97
50.01711486048Zend_Controller_Dispatcher_Standard->dispatch( ).../Front.php:954
60.15662536736Zend_Controller_Action->dispatch( ).../Standard.php:289
70.93524009000Zend_Controller_Action_HelperBroker->notifyPostDispatch( ).../Action.php:523
80.93524010048Zend_Controller_Action_Helper_ViewRenderer->postDispatch( ).../HelperBroker.php:277
90.93524010368Zend_Controller_Action_Helper_ViewRenderer->render( ).../ViewRenderer.php:957
100.93544011344Zend_Controller_Action_Helper_ViewRenderer->renderScript( ).../ViewRenderer.php:918
110.93544011376Zend_View_Abstract->render( ).../ViewRenderer.php:897
120.95484027960Zend_View->_run( ).../Abstract.php:880
130.95494028968include( '/vivo/developers.vivomiles.com/application/views/scripts/doc/method.phtml' ).../View.php:108
144.95014410568Model_Doc->buildParamsWebService( ).../method.phtml:341
154.95024416272Model_Doc->getSession( ).../Doc.php:468
164.95024417432Model_Doc->callWebService( ).../Doc.php:377
175.14804446088Model_Doc->setSessionId( ).../Doc.php:364
https://api.vivoclass.com/Staff.getApplicableAwardCategories?max=99

Error Codes:

9999

Method: Staff.getApplicableExtraEarners

Available since API version 2.1

Returns info about the extra earners the current logged in staff can use to reward

Parameters:

Name Required Type Default Description
session_id Required string A valid session_id representing a staff user
max Optional int Maximum number of extra earners to return

Response Parameters:

Name Description
default_miles The default amount of Vivos for this extra earner
category Name of the extra earner
guidelines Guideline to accomplish this extra earner
help_requests_id The id of the extra earner

Example Request (click to see example response):


( ! ) Notice: Undefined property: stdClass::$user_data in /vivo/developers.vivomiles.com/application/models/Doc.php on line 400
Call Stack
#TimeMemoryFunctionLocation
10.0000240624{main}( ).../index.php:0
20.01671405760Zend_Application->run( ).../index.php:36
30.01671405880Zend_Application_Bootstrap_Bootstrap->run( ).../Application.php:366
40.01681406712Zend_Controller_Front->dispatch( ).../Bootstrap.php:97
50.01711486048Zend_Controller_Dispatcher_Standard->dispatch( ).../Front.php:954
60.15662536736Zend_Controller_Action->dispatch( ).../Standard.php:289
70.93524009000Zend_Controller_Action_HelperBroker->notifyPostDispatch( ).../Action.php:523
80.93524010048Zend_Controller_Action_Helper_ViewRenderer->postDispatch( ).../HelperBroker.php:277
90.93524010368Zend_Controller_Action_Helper_ViewRenderer->render( ).../ViewRenderer.php:957
100.93544011344Zend_Controller_Action_Helper_ViewRenderer->renderScript( ).../ViewRenderer.php:918
110.93544011376Zend_View_Abstract->render( ).../ViewRenderer.php:897
120.95484027960Zend_View->_run( ).../Abstract.php:880
130.95494028968include( '/vivo/developers.vivomiles.com/application/views/scripts/doc/method.phtml' ).../View.php:108
145.14944427200Model_Doc->buildParamsWebService( ).../method.phtml:341
155.14954432896Model_Doc->getSession( ).../Doc.php:468
165.14954434056Model_Doc->callWebService( ).../Doc.php:377
175.34324462744Model_Doc->setSessionId( ).../Doc.php:364

( ! ) Notice: Trying to get property of non-object in /vivo/developers.vivomiles.com/application/models/Doc.php on line 400
Call Stack
#TimeMemoryFunctionLocation
10.0000240624{main}( ).../index.php:0
20.01671405760Zend_Application->run( ).../index.php:36
30.01671405880Zend_Application_Bootstrap_Bootstrap->run( ).../Application.php:366
40.01681406712Zend_Controller_Front->dispatch( ).../Bootstrap.php:97
50.01711486048Zend_Controller_Dispatcher_Standard->dispatch( ).../Front.php:954
60.15662536736Zend_Controller_Action->dispatch( ).../Standard.php:289
70.93524009000Zend_Controller_Action_HelperBroker->notifyPostDispatch( ).../Action.php:523
80.93524010048Zend_Controller_Action_Helper_ViewRenderer->postDispatch( ).../HelperBroker.php:277
90.93524010368Zend_Controller_Action_Helper_ViewRenderer->render( ).../ViewRenderer.php:957
100.93544011344Zend_Controller_Action_Helper_ViewRenderer->renderScript( ).../ViewRenderer.php:918
110.93544011376Zend_View_Abstract->render( ).../ViewRenderer.php:897
120.95484027960Zend_View->_run( ).../Abstract.php:880
130.95494028968include( '/vivo/developers.vivomiles.com/application/views/scripts/doc/method.phtml' ).../View.php:108
145.14944427200Model_Doc->buildParamsWebService( ).../method.phtml:341
155.14954432896Model_Doc->getSession( ).../Doc.php:468
165.14954434056Model_Doc->callWebService( ).../Doc.php:377
175.34324462744Model_Doc->setSessionId( ).../Doc.php:364
https://api.vivoclass.com/Staff.getApplicableExtraEarners?max=79

Error Codes:

This method does not return any errors

Method: Staff.rewardStudent

Available since API version 2.0

Rewards a student. The optional password parameter is not needed in case of rewards that does not need authorisation. However when transaction authorisation is needed the password is mandatory.

Parameters:

Name Required Type Default Description
session_id Required string A valid session_id representing the staff member logged in
users_id Required string Vivo ID for a student in the class list
amount Required float The amount of Vivos to reward each student
reason_title Required string The title of the reason for the reward
award_category Required string The name of the reward category
reason_text Required string The text used to justify the transaction
password Optional string Password of user used for reward authorisation if required

Response Parameters:

Name Description
student The updated details of the rewarded student

Example Request (click to see example response):


( ! ) Notice: Undefined property: stdClass::$user_data in /vivo/developers.vivomiles.com/application/models/Doc.php on line 400
Call Stack
#TimeMemoryFunctionLocation
10.0000240624{main}( ).../index.php:0
20.01671405760Zend_Application->run( ).../index.php:36
30.01671405880Zend_Application_Bootstrap_Bootstrap->run( ).../Application.php:366
40.01681406712Zend_Controller_Front->dispatch( ).../Bootstrap.php:97
50.01711486048Zend_Controller_Dispatcher_Standard->dispatch( ).../Front.php:954
60.15662536736Zend_Controller_Action->dispatch( ).../Standard.php:289
70.93524009000Zend_Controller_Action_HelperBroker->notifyPostDispatch( ).../Action.php:523
80.93524010048Zend_Controller_Action_Helper_ViewRenderer->postDispatch( ).../HelperBroker.php:277
90.93524010368Zend_Controller_Action_Helper_ViewRenderer->render( ).../ViewRenderer.php:957
100.93544011344Zend_Controller_Action_Helper_ViewRenderer->renderScript( ).../ViewRenderer.php:918
110.93544011376Zend_View_Abstract->render( ).../ViewRenderer.php:897
120.95484027960Zend_View->_run( ).../Abstract.php:880
130.95494028968include( '/vivo/developers.vivomiles.com/application/views/scripts/doc/method.phtml' ).../View.php:108
145.34464443288Model_Doc->buildParamsWebService( ).../method.phtml:341
155.34474449480Model_Doc->getSession( ).../Doc.php:468
165.34474450640Model_Doc->callWebService( ).../Doc.php:377
175.54024483040Model_Doc->setSessionId( ).../Doc.php:364

( ! ) Notice: Trying to get property of non-object in /vivo/developers.vivomiles.com/application/models/Doc.php on line 400
Call Stack
#TimeMemoryFunctionLocation
10.0000240624{main}( ).../index.php:0
20.01671405760Zend_Application->run( ).../index.php:36
30.01671405880Zend_Application_Bootstrap_Bootstrap->run( ).../Application.php:366
40.01681406712Zend_Controller_Front->dispatch( ).../Bootstrap.php:97
50.01711486048Zend_Controller_Dispatcher_Standard->dispatch( ).../Front.php:954
60.15662536736Zend_Controller_Action->dispatch( ).../Standard.php:289
70.93524009000Zend_Controller_Action_HelperBroker->notifyPostDispatch( ).../Action.php:523
80.93524010048Zend_Controller_Action_Helper_ViewRenderer->postDispatch( ).../HelperBroker.php:277
90.93524010368Zend_Controller_Action_Helper_ViewRenderer->render( ).../ViewRenderer.php:957
100.93544011344Zend_Controller_Action_Helper_ViewRenderer->renderScript( ).../ViewRenderer.php:918
110.93544011376Zend_View_Abstract->render( ).../ViewRenderer.php:897
120.95484027960Zend_View->_run( ).../Abstract.php:880
130.95494028968include( '/vivo/developers.vivomiles.com/application/views/scripts/doc/method.phtml' ).../View.php:108
145.34464443288Model_Doc->buildParamsWebService( ).../method.phtml:341
155.34474449480Model_Doc->getSession( ).../Doc.php:468
165.34474450640Model_Doc->callWebService( ).../Doc.php:377
175.54024483040Model_Doc->setSessionId( ).../Doc.php:364
https://api.vivoclass.com/Staff.rewardStudent?users_id=4b43b0ae&amount=63.94&reason_title=4b43b0ae&award_category=4b43b0ae&reason_text=4b43b0ae

Error Codes:

3402, 3403, 3404

Method: Staff.rewardStudents

Available since API version 2.1

Reward multiple students. The optional password parameter is not needed in case of rewards that does not need authorisation. However when transaction authorisation is needed the password is mandatory.

Parameters:

Name Required Type Default Description
session_id Required string A valid session_id representing the staff member logged in
user_ids Required array An array of user_ids to reward
amount Required float The amount of Vivos to reward each student
reason_title Required string The title of the reason for the reward
award_category Required string The name of the reward category
reason_text Required string The text used to justify the transaction
password Optional string Password of user used for reward authorisation if required

Response Parameters:

Name Description
result The success message

Example Request (click to see example response):


( ! ) Notice: Undefined property: stdClass::$user_data in /vivo/developers.vivomiles.com/application/models/Doc.php on line 400
Call Stack
#TimeMemoryFunctionLocation
10.0000240624{main}( ).../index.php:0
20.01671405760Zend_Application->run( ).../index.php:36
30.01671405880Zend_Application_Bootstrap_Bootstrap->run( ).../Application.php:366
40.01681406712Zend_Controller_Front->dispatch( ).../Bootstrap.php:97
50.01711486048Zend_Controller_Dispatcher_Standard->dispatch( ).../Front.php:954
60.15662536736Zend_Controller_Action->dispatch( ).../Standard.php:289
70.93524009000Zend_Controller_Action_HelperBroker->notifyPostDispatch( ).../Action.php:523
80.93524010048Zend_Controller_Action_Helper_ViewRenderer->postDispatch( ).../HelperBroker.php:277
90.93524010368Zend_Controller_Action_Helper_ViewRenderer->render( ).../ViewRenderer.php:957
100.93544011344Zend_Controller_Action_Helper_ViewRenderer->renderScript( ).../ViewRenderer.php:918
110.93544011376Zend_View_Abstract->render( ).../ViewRenderer.php:897
120.95484027960Zend_View->_run( ).../Abstract.php:880
130.95494028968include( '/vivo/developers.vivomiles.com/application/views/scripts/doc/method.phtml' ).../View.php:108
145.54204461200Model_Doc->buildParamsWebService( ).../method.phtml:341
155.54214467392Model_Doc->getSession( ).../Doc.php:468
165.54214468552Model_Doc->callWebService( ).../Doc.php:377
175.74104500752Model_Doc->setSessionId( ).../Doc.php:364

( ! ) Notice: Trying to get property of non-object in /vivo/developers.vivomiles.com/application/models/Doc.php on line 400
Call Stack
#TimeMemoryFunctionLocation
10.0000240624{main}( ).../index.php:0
20.01671405760Zend_Application->run( ).../index.php:36
30.01671405880Zend_Application_Bootstrap_Bootstrap->run( ).../Application.php:366
40.01681406712Zend_Controller_Front->dispatch( ).../Bootstrap.php:97
50.01711486048Zend_Controller_Dispatcher_Standard->dispatch( ).../Front.php:954
60.15662536736Zend_Controller_Action->dispatch( ).../Standard.php:289
70.93524009000Zend_Controller_Action_HelperBroker->notifyPostDispatch( ).../Action.php:523
80.93524010048Zend_Controller_Action_Helper_ViewRenderer->postDispatch( ).../HelperBroker.php:277
90.93524010368Zend_Controller_Action_Helper_ViewRenderer->render( ).../ViewRenderer.php:957
100.93544011344Zend_Controller_Action_Helper_ViewRenderer->renderScript( ).../ViewRenderer.php:918
110.93544011376Zend_View_Abstract->render( ).../ViewRenderer.php:897
120.95484027960Zend_View->_run( ).../Abstract.php:880
130.95494028968include( '/vivo/developers.vivomiles.com/application/views/scripts/doc/method.phtml' ).../View.php:108
145.54204461200Model_Doc->buildParamsWebService( ).../method.phtml:341
155.54214467392Model_Doc->getSession( ).../Doc.php:468
165.54214468552Model_Doc->callWebService( ).../Doc.php:377
175.74104500752Model_Doc->setSessionId( ).../Doc.php:364
https://api.vivoclass.com/Staff.rewardStudents?user_ids%5B0%5D=1&user_ids%5B1%5D=124178&amount=93.59&reason_title=4b43b0ae&award_category=4b43b0ae&reason_text=4b43b0ae

Error Codes:

3402, 3403, 3404

Method: Staff.rewardClassList

Available since API version 2.0

Rewards all the students in the class list

Parameters:

Name Required Type Default Description
session_id Required string A valid session_id representing a staff user
lists_id Required string Vivo ID for a class list (teacher lesson)

Example Request (click to see example response):


( ! ) Notice: Undefined property: stdClass::$user_data in /vivo/developers.vivomiles.com/application/models/Doc.php on line 400
Call Stack
#TimeMemoryFunctionLocation
10.0000240624{main}( ).../index.php:0
20.01671405760Zend_Application->run( ).../index.php:36
30.01671405880Zend_Application_Bootstrap_Bootstrap->run( ).../Application.php:366
40.01681406712Zend_Controller_Front->dispatch( ).../Bootstrap.php:97
50.01711486048Zend_Controller_Dispatcher_Standard->dispatch( ).../Front.php:954
60.15662536736Zend_Controller_Action->dispatch( ).../Standard.php:289
70.93524009000Zend_Controller_Action_HelperBroker->notifyPostDispatch( ).../Action.php:523
80.93524010048Zend_Controller_Action_Helper_ViewRenderer->postDispatch( ).../HelperBroker.php:277
90.93524010368Zend_Controller_Action_Helper_ViewRenderer->render( ).../ViewRenderer.php:957
100.93544011344Zend_Controller_Action_Helper_ViewRenderer->renderScript( ).../ViewRenderer.php:918
110.93544011376Zend_View_Abstract->render( ).../ViewRenderer.php:897
120.95484027960Zend_View->_run( ).../Abstract.php:880
130.95494028968include( '/vivo/developers.vivomiles.com/application/views/scripts/doc/method.phtml' ).../View.php:108
145.74284478040Model_Doc->buildParamsWebService( ).../method.phtml:341
155.74284483720Model_Doc->getSession( ).../Doc.php:468
165.74284484880Model_Doc->callWebService( ).../Doc.php:377
175.93764510480Model_Doc->setSessionId( ).../Doc.php:364

( ! ) Notice: Trying to get property of non-object in /vivo/developers.vivomiles.com/application/models/Doc.php on line 400
Call Stack
#TimeMemoryFunctionLocation
10.0000240624{main}( ).../index.php:0
20.01671405760Zend_Application->run( ).../index.php:36
30.01671405880Zend_Application_Bootstrap_Bootstrap->run( ).../Application.php:366
40.01681406712Zend_Controller_Front->dispatch( ).../Bootstrap.php:97
50.01711486048Zend_Controller_Dispatcher_Standard->dispatch( ).../Front.php:954
60.15662536736Zend_Controller_Action->dispatch( ).../Standard.php:289
70.93524009000Zend_Controller_Action_HelperBroker->notifyPostDispatch( ).../Action.php:523
80.93524010048Zend_Controller_Action_Helper_ViewRenderer->postDispatch( ).../HelperBroker.php:277
90.93524010368Zend_Controller_Action_Helper_ViewRenderer->render( ).../ViewRenderer.php:957
100.93544011344Zend_Controller_Action_Helper_ViewRenderer->renderScript( ).../ViewRenderer.php:918
110.93544011376Zend_View_Abstract->render( ).../ViewRenderer.php:897
120.95484027960Zend_View->_run( ).../Abstract.php:880
130.95494028968include( '/vivo/developers.vivomiles.com/application/views/scripts/doc/method.phtml' ).../View.php:108
145.74284478040Model_Doc->buildParamsWebService( ).../method.phtml:341
155.74284483720Model_Doc->getSession( ).../Doc.php:468
165.74284484880Model_Doc->callWebService( ).../Doc.php:377
175.93764510480Model_Doc->setSessionId( ).../Doc.php:364
https://api.vivoclass.com/Staff.rewardClassList?lists_id=4b43b0ae

Error Codes:

This method does not return any errors

Method: Staff.getBudgetData

Available since API version 2.1

Returns budget information: weekly budget, awarded this week, % remaining

Parameters:

Name Required Type Default Description
session_id Required string A currently active and valid webservice session id

Response Parameters:

Name Description
time_frame The time frame which budgets are calculated on: WEEK/MONTH/TOTAL
budget_remaining The % remaining budget in the time frame
budget The total budget for the time frame
awarded the total awarded so far in the timeframe

Example Request (click to see example response):


( ! ) Notice: Undefined property: stdClass::$user_data in /vivo/developers.vivomiles.com/application/models/Doc.php on line 400
Call Stack
#TimeMemoryFunctionLocation
10.0000240624{main}( ).../index.php:0
20.01671405760Zend_Application->run( ).../index.php:36
30.01671405880Zend_Application_Bootstrap_Bootstrap->run( ).../Application.php:366
40.01681406712Zend_Controller_Front->dispatch( ).../Bootstrap.php:97
50.01711486048Zend_Controller_Dispatcher_Standard->dispatch( ).../Front.php:954
60.15662536736Zend_Controller_Action->dispatch( ).../Standard.php:289
70.93524009000Zend_Controller_Action_HelperBroker->notifyPostDispatch( ).../Action.php:523
80.93524010048Zend_Controller_Action_Helper_ViewRenderer->postDispatch( ).../HelperBroker.php:277
90.93524010368Zend_Controller_Action_Helper_ViewRenderer->render( ).../ViewRenderer.php:957
100.93544011344Zend_Controller_Action_Helper_ViewRenderer->renderScript( ).../ViewRenderer.php:918
110.93544011376Zend_View_Abstract->render( ).../ViewRenderer.php:897
120.95484027960Zend_View->_run( ).../Abstract.php:880
130.95494028968include( '/vivo/developers.vivomiles.com/application/views/scripts/doc/method.phtml' ).../View.php:108
145.93924492744Model_Doc->buildParamsWebService( ).../method.phtml:341
155.93934498320Model_Doc->getSession( ).../Doc.php:468
165.93934499480Model_Doc->callWebService( ).../Doc.php:377
176.13574526992Model_Doc->setSessionId( ).../Doc.php:364

( ! ) Notice: Trying to get property of non-object in /vivo/developers.vivomiles.com/application/models/Doc.php on line 400
Call Stack
#TimeMemoryFunctionLocation
10.0000240624{main}( ).../index.php:0
20.01671405760Zend_Application->run( ).../index.php:36
30.01671405880Zend_Application_Bootstrap_Bootstrap->run( ).../Application.php:366
40.01681406712Zend_Controller_Front->dispatch( ).../Bootstrap.php:97
50.01711486048Zend_Controller_Dispatcher_Standard->dispatch( ).../Front.php:954
60.15662536736Zend_Controller_Action->dispatch( ).../Standard.php:289
70.93524009000Zend_Controller_Action_HelperBroker->notifyPostDispatch( ).../Action.php:523
80.93524010048Zend_Controller_Action_Helper_ViewRenderer->postDispatch( ).../HelperBroker.php:277
90.93524010368Zend_Controller_Action_Helper_ViewRenderer->render( ).../ViewRenderer.php:957
100.93544011344Zend_Controller_Action_Helper_ViewRenderer->renderScript( ).../ViewRenderer.php:918
110.93544011376Zend_View_Abstract->render( ).../ViewRenderer.php:897
120.95484027960Zend_View->_run( ).../Abstract.php:880
130.95494028968include( '/vivo/developers.vivomiles.com/application/views/scripts/doc/method.phtml' ).../View.php:108
145.93924492744Model_Doc->buildParamsWebService( ).../method.phtml:341
155.93934498320Model_Doc->getSession( ).../Doc.php:468
165.93934499480Model_Doc->callWebService( ).../Doc.php:377
176.13574526992Model_Doc->setSessionId( ).../Doc.php:364
https://api.vivoclass.com/Staff.getBudgetData?

Error Codes:

This method does not return any errors

Method: Staff.getLists

Available since API version 2.1

Returns all lists available to this staff member

Parameters:

Name Required Type Default Description
session_id Required string A currently active and valid webservice session id

Response Parameters:

Name Description
lists_id The internal id of the list returned
list The name of the list

Example Request (click to see example response):


( ! ) Notice: Undefined property: stdClass::$user_data in /vivo/developers.vivomiles.com/application/models/Doc.php on line 400
Call Stack
#TimeMemoryFunctionLocation
10.0000240624{main}( ).../index.php:0
20.01671405760Zend_Application->run( ).../index.php:36
30.01671405880Zend_Application_Bootstrap_Bootstrap->run( ).../Application.php:366
40.01681406712Zend_Controller_Front->dispatch( ).../Bootstrap.php:97
50.01711486048Zend_Controller_Dispatcher_Standard->dispatch( ).../Front.php:954
60.15662536736Zend_Controller_Action->dispatch( ).../Standard.php:289
70.93524009000Zend_Controller_Action_HelperBroker->notifyPostDispatch( ).../Action.php:523
80.93524010048Zend_Controller_Action_Helper_ViewRenderer->postDispatch( ).../HelperBroker.php:277
90.93524010368Zend_Controller_Action_Helper_ViewRenderer->render( ).../ViewRenderer.php:957
100.93544011344Zend_Controller_Action_Helper_ViewRenderer->renderScript( ).../ViewRenderer.php:918
110.93544011376Zend_View_Abstract->render( ).../ViewRenderer.php:897
120.95484027960Zend_View->_run( ).../Abstract.php:880
130.95494028968include( '/vivo/developers.vivomiles.com/application/views/scripts/doc/method.phtml' ).../View.php:108
146.13724509168Model_Doc->buildParamsWebService( ).../method.phtml:341
156.13724514736Model_Doc->getSession( ).../Doc.php:468
166.13724515896Model_Doc->callWebService( ).../Doc.php:377
176.33344541888Model_Doc->setSessionId( ).../Doc.php:364

( ! ) Notice: Trying to get property of non-object in /vivo/developers.vivomiles.com/application/models/Doc.php on line 400
Call Stack
#TimeMemoryFunctionLocation
10.0000240624{main}( ).../index.php:0
20.01671405760Zend_Application->run( ).../index.php:36
30.01671405880Zend_Application_Bootstrap_Bootstrap->run( ).../Application.php:366
40.01681406712Zend_Controller_Front->dispatch( ).../Bootstrap.php:97
50.01711486048Zend_Controller_Dispatcher_Standard->dispatch( ).../Front.php:954
60.15662536736Zend_Controller_Action->dispatch( ).../Standard.php:289
70.93524009000Zend_Controller_Action_HelperBroker->notifyPostDispatch( ).../Action.php:523
80.93524010048Zend_Controller_Action_Helper_ViewRenderer->postDispatch( ).../HelperBroker.php:277
90.93524010368Zend_Controller_Action_Helper_ViewRenderer->render( ).../ViewRenderer.php:957
100.93544011344Zend_Controller_Action_Helper_ViewRenderer->renderScript( ).../ViewRenderer.php:918
110.93544011376Zend_View_Abstract->render( ).../ViewRenderer.php:897
120.95484027960Zend_View->_run( ).../Abstract.php:880
130.95494028968include( '/vivo/developers.vivomiles.com/application/views/scripts/doc/method.phtml' ).../View.php:108
146.13724509168Model_Doc->buildParamsWebService( ).../method.phtml:341
156.13724514736Model_Doc->getSession( ).../Doc.php:468
166.13724515896Model_Doc->callWebService( ).../Doc.php:377
176.33344541888Model_Doc->setSessionId( ).../Doc.php:364
https://api.vivoclass.com/Staff.getLists?

Error Codes:

This method does not return any errors

Method: Staff.getListStudents

Available since API version 2.1

Returns all lists available to this staff member

Parameters:

Name Required Type Default Description
session_id Required string A currently active and valid webservice session id
lists_id Required int The internal id of the list

Response Parameters:

Name Description
time_frame The time frame which budgets are calculated on: WEEK/MONTH/TOTAL
budget_remaining The % remaining budget in the timeframe
budget The total budget for the time frame
awarded the total awarded so far in the timeframe

Example Request (click to see example response):


( ! ) Notice: Undefined property: stdClass::$user_data in /vivo/developers.vivomiles.com/application/models/Doc.php on line 400
Call Stack
#TimeMemoryFunctionLocation
10.0000240624{main}( ).../index.php:0
20.01671405760Zend_Application->run( ).../index.php:36
30.01671405880Zend_Application_Bootstrap_Bootstrap->run( ).../Application.php:366
40.01681406712Zend_Controller_Front->dispatch( ).../Bootstrap.php:97
50.01711486048Zend_Controller_Dispatcher_Standard->dispatch( ).../Front.php:954
60.15662536736Zend_Controller_Action->dispatch( ).../Standard.php:289
70.93524009000Zend_Controller_Action_HelperBroker->notifyPostDispatch( ).../Action.php:523
80.93524010048Zend_Controller_Action_Helper_ViewRenderer->postDispatch( ).../HelperBroker.php:277
90.93524010368Zend_Controller_Action_Helper_ViewRenderer->render( ).../ViewRenderer.php:957
100.93544011344Zend_Controller_Action_Helper_ViewRenderer->renderScript( ).../ViewRenderer.php:918
110.93544011376Zend_View_Abstract->render( ).../ViewRenderer.php:897
120.95484027960Zend_View->_run( ).../Abstract.php:880
130.95494028968include( '/vivo/developers.vivomiles.com/application/views/scripts/doc/method.phtml' ).../View.php:108
146.33484525584Model_Doc->buildParamsWebService( ).../method.phtml:341
156.33494531264Model_Doc->getSession( ).../Doc.php:468
166.33494532424Model_Doc->callWebService( ).../Doc.php:377
176.53424561216Model_Doc->setSessionId( ).../Doc.php:364

( ! ) Notice: Trying to get property of non-object in /vivo/developers.vivomiles.com/application/models/Doc.php on line 400
Call Stack
#TimeMemoryFunctionLocation
10.0000240624{main}( ).../index.php:0
20.01671405760Zend_Application->run( ).../index.php:36
30.01671405880Zend_Application_Bootstrap_Bootstrap->run( ).../Application.php:366
40.01681406712Zend_Controller_Front->dispatch( ).../Bootstrap.php:97
50.01711486048Zend_Controller_Dispatcher_Standard->dispatch( ).../Front.php:954
60.15662536736Zend_Controller_Action->dispatch( ).../Standard.php:289
70.93524009000Zend_Controller_Action_HelperBroker->notifyPostDispatch( ).../Action.php:523
80.93524010048Zend_Controller_Action_Helper_ViewRenderer->postDispatch( ).../HelperBroker.php:277
90.93524010368Zend_Controller_Action_Helper_ViewRenderer->render( ).../ViewRenderer.php:957
100.93544011344Zend_Controller_Action_Helper_ViewRenderer->renderScript( ).../ViewRenderer.php:918
110.93544011376Zend_View_Abstract->render( ).../ViewRenderer.php:897
120.95484027960Zend_View->_run( ).../Abstract.php:880
130.95494028968include( '/vivo/developers.vivomiles.com/application/views/scripts/doc/method.phtml' ).../View.php:108
146.33484525584Model_Doc->buildParamsWebService( ).../method.phtml:341
156.33494531264Model_Doc->getSession( ).../Doc.php:468
166.33494532424Model_Doc->callWebService( ).../Doc.php:377
176.53424561216Model_Doc->setSessionId( ).../Doc.php:364
https://api.vivoclass.com/Staff.getListStudents?lists_id=90

Error Codes:

3700, 3701

Method: Staff.getTutorYearLists

Available since API version 2.2

Returns all tutor group lists and year group lists available to this staff member

Parameters:

Name Required Type Default Description
session_id Required string A currently active and valid webservice session id

Response Parameters:

Name Description
id The id of the list
name The name of the list

Example Request (click to see example response):


( ! ) Notice: Undefined property: stdClass::$user_data in /vivo/developers.vivomiles.com/application/models/Doc.php on line 400
Call Stack
#TimeMemoryFunctionLocation
10.0000240624{main}( ).../index.php:0
20.01671405760Zend_Application->run( ).../index.php:36
30.01671405880Zend_Application_Bootstrap_Bootstrap->run( ).../Application.php:366
40.01681406712Zend_Controller_Front->dispatch( ).../Bootstrap.php:97
50.01711486048Zend_Controller_Dispatcher_Standard->dispatch( ).../Front.php:954
60.15662536736Zend_Controller_Action->dispatch( ).../Standard.php:289
70.93524009000Zend_Controller_Action_HelperBroker->notifyPostDispatch( ).../Action.php:523
80.93524010048Zend_Controller_Action_Helper_ViewRenderer->postDispatch( ).../HelperBroker.php:277
90.93524010368Zend_Controller_Action_Helper_ViewRenderer->render( ).../ViewRenderer.php:957
100.93544011344Zend_Controller_Action_Helper_ViewRenderer->renderScript( ).../ViewRenderer.php:918
110.93544011376Zend_View_Abstract->render( ).../ViewRenderer.php:897
120.95484027960Zend_View->_run( ).../Abstract.php:880
130.95494028968include( '/vivo/developers.vivomiles.com/application/views/scripts/doc/method.phtml' ).../View.php:108
146.53574542744Model_Doc->buildParamsWebService( ).../method.phtml:341
156.53584548328Model_Doc->getSession( ).../Doc.php:468
166.53584549488Model_Doc->callWebService( ).../Doc.php:377
176.73334576264Model_Doc->setSessionId( ).../Doc.php:364

( ! ) Notice: Trying to get property of non-object in /vivo/developers.vivomiles.com/application/models/Doc.php on line 400
Call Stack
#TimeMemoryFunctionLocation
10.0000240624{main}( ).../index.php:0
20.01671405760Zend_Application->run( ).../index.php:36
30.01671405880Zend_Application_Bootstrap_Bootstrap->run( ).../Application.php:366
40.01681406712Zend_Controller_Front->dispatch( ).../Bootstrap.php:97
50.01711486048Zend_Controller_Dispatcher_Standard->dispatch( ).../Front.php:954
60.15662536736Zend_Controller_Action->dispatch( ).../Standard.php:289
70.93524009000Zend_Controller_Action_HelperBroker->notifyPostDispatch( ).../Action.php:523
80.93524010048Zend_Controller_Action_Helper_ViewRenderer->postDispatch( ).../HelperBroker.php:277
90.93524010368Zend_Controller_Action_Helper_ViewRenderer->render( ).../ViewRenderer.php:957
100.93544011344Zend_Controller_Action_Helper_ViewRenderer->renderScript( ).../ViewRenderer.php:918
110.93544011376Zend_View_Abstract->render( ).../ViewRenderer.php:897
120.95484027960Zend_View->_run( ).../Abstract.php:880
130.95494028968include( '/vivo/developers.vivomiles.com/application/views/scripts/doc/method.phtml' ).../View.php:108
146.53574542744Model_Doc->buildParamsWebService( ).../method.phtml:341
156.53584548328Model_Doc->getSession( ).../Doc.php:468
166.53584549488Model_Doc->callWebService( ).../Doc.php:377
176.73334576264Model_Doc->setSessionId( ).../Doc.php:364
https://api.vivoclass.com/Staff.getTutorYearLists?

Error Codes:

3201, 3208, 9999

Method: Staff.getTutorYearListStudents

Available since API version 2.2

Returns the students in the specified tutor group list or year group list

Parameters:

Name Required Type Default Description
session_id Required string A currently active and valid webservice session id
list_id Required int The id of the list

Response Parameters:

Name Description
users_id The id of the student
fname The first name of the student
sname The last name of the student

Example Request (click to see example response):


( ! ) Notice: Undefined property: stdClass::$user_data in /vivo/developers.vivomiles.com/application/models/Doc.php on line 400
Call Stack
#TimeMemoryFunctionLocation
10.0000240624{main}( ).../index.php:0
20.01671405760Zend_Application->run( ).../index.php:36
30.01671405880Zend_Application_Bootstrap_Bootstrap->run( ).../Application.php:366
40.01681406712Zend_Controller_Front->dispatch( ).../Bootstrap.php:97
50.01711486048Zend_Controller_Dispatcher_Standard->dispatch( ).../Front.php:954
60.15662536736Zend_Controller_Action->dispatch( ).../Standard.php:289
70.93524009000Zend_Controller_Action_HelperBroker->notifyPostDispatch( ).../Action.php:523
80.93524010048Zend_Controller_Action_Helper_ViewRenderer->postDispatch( ).../HelperBroker.php:277
90.93524010368Zend_Controller_Action_Helper_ViewRenderer->render( ).../ViewRenderer.php:957
100.93544011344Zend_Controller_Action_Helper_ViewRenderer->renderScript( ).../ViewRenderer.php:918
110.93544011376Zend_View_Abstract->render( ).../ViewRenderer.php:897
120.95484027960Zend_View->_run( ).../Abstract.php:880
130.95494028968include( '/vivo/developers.vivomiles.com/application/views/scripts/doc/method.phtml' ).../View.php:108
146.73494542944Model_Doc->buildParamsWebService( ).../method.phtml:341
156.73494548640Model_Doc->getSession( ).../Doc.php:468
166.73494549800Model_Doc->callWebService( ).../Doc.php:377
176.96104578392Model_Doc->setSessionId( ).../Doc.php:364

( ! ) Notice: Trying to get property of non-object in /vivo/developers.vivomiles.com/application/models/Doc.php on line 400
Call Stack
#TimeMemoryFunctionLocation
10.0000240624{main}( ).../index.php:0
20.01671405760Zend_Application->run( ).../index.php:36
30.01671405880Zend_Application_Bootstrap_Bootstrap->run( ).../Application.php:366
40.01681406712Zend_Controller_Front->dispatch( ).../Bootstrap.php:97
50.01711486048Zend_Controller_Dispatcher_Standard->dispatch( ).../Front.php:954
60.15662536736Zend_Controller_Action->dispatch( ).../Standard.php:289
70.93524009000Zend_Controller_Action_HelperBroker->notifyPostDispatch( ).../Action.php:523
80.93524010048Zend_Controller_Action_Helper_ViewRenderer->postDispatch( ).../HelperBroker.php:277
90.93524010368Zend_Controller_Action_Helper_ViewRenderer->render( ).../ViewRenderer.php:957
100.93544011344Zend_Controller_Action_Helper_ViewRenderer->renderScript( ).../ViewRenderer.php:918
110.93544011376Zend_View_Abstract->render( ).../ViewRenderer.php:897
120.95484027960Zend_View->_run( ).../Abstract.php:880
130.95494028968include( '/vivo/developers.vivomiles.com/application/views/scripts/doc/method.phtml' ).../View.php:108
146.73494542944Model_Doc->buildParamsWebService( ).../method.phtml:341
156.73494548640Model_Doc->getSession( ).../Doc.php:468
166.73494549800Model_Doc->callWebService( ).../Doc.php:377
176.96104578392Model_Doc->setSessionId( ).../Doc.php:364
https://api.vivoclass.com/Staff.getTutorYearListStudents?list_id=9

Error Codes:

3201, 3208, 3600, 3601, 9999

Method: Staff.getGroups

Available since API version 2.1

Returns all groups available to this staff member

Parameters:

Name Required Type Default Description
session_id Required string A currently active and valid webservice session id

Response Parameters:

Name Description
groups_id The internal id of the group returned
name The name of teh group

Example Request (click to see example response):


( ! ) Notice: Undefined property: stdClass::$user_data in /vivo/developers.vivomiles.com/application/models/Doc.php on line 400
Call Stack
#TimeMemoryFunctionLocation
10.0000240624{main}( ).../index.php:0
20.01671405760Zend_Application->run( ).../index.php:36
30.01671405880Zend_Application_Bootstrap_Bootstrap->run( ).../Application.php:366
40.01681406712Zend_Controller_Front->dispatch( ).../Bootstrap.php:97
50.01711486048Zend_Controller_Dispatcher_Standard->dispatch( ).../Front.php:954
60.15662536736Zend_Controller_Action->dispatch( ).../Standard.php:289
70.93524009000Zend_Controller_Action_HelperBroker->notifyPostDispatch( ).../Action.php:523
80.93524010048Zend_Controller_Action_Helper_ViewRenderer->postDispatch( ).../HelperBroker.php:277
90.93524010368Zend_Controller_Action_Helper_ViewRenderer->render( ).../ViewRenderer.php:957
100.93544011344Zend_Controller_Action_Helper_ViewRenderer->renderScript( ).../ViewRenderer.php:918
110.93544011376Zend_View_Abstract->render( ).../ViewRenderer.php:897
120.95484027960Zend_View->_run( ).../Abstract.php:880
130.95494028968include( '/vivo/developers.vivomiles.com/application/views/scripts/doc/method.phtml' ).../View.php:108
146.96244560176Model_Doc->buildParamsWebService( ).../method.phtml:341
156.96254565744Model_Doc->getSession( ).../Doc.php:468
166.96254566904Model_Doc->callWebService( ).../Doc.php:377
177.15604593072Model_Doc->setSessionId( ).../Doc.php:364

( ! ) Notice: Trying to get property of non-object in /vivo/developers.vivomiles.com/application/models/Doc.php on line 400
Call Stack
#TimeMemoryFunctionLocation
10.0000240624{main}( ).../index.php:0
20.01671405760Zend_Application->run( ).../index.php:36
30.01671405880Zend_Application_Bootstrap_Bootstrap->run( ).../Application.php:366
40.01681406712Zend_Controller_Front->dispatch( ).../Bootstrap.php:97
50.01711486048Zend_Controller_Dispatcher_Standard->dispatch( ).../Front.php:954
60.15662536736Zend_Controller_Action->dispatch( ).../Standard.php:289
70.93524009000Zend_Controller_Action_HelperBroker->notifyPostDispatch( ).../Action.php:523
80.93524010048Zend_Controller_Action_Helper_ViewRenderer->postDispatch( ).../HelperBroker.php:277
90.93524010368Zend_Controller_Action_Helper_ViewRenderer->render( ).../ViewRenderer.php:957
100.93544011344Zend_Controller_Action_Helper_ViewRenderer->renderScript( ).../ViewRenderer.php:918
110.93544011376Zend_View_Abstract->render( ).../ViewRenderer.php:897
120.95484027960Zend_View->_run( ).../Abstract.php:880
130.95494028968include( '/vivo/developers.vivomiles.com/application/views/scripts/doc/method.phtml' ).../View.php:108
146.96244560176Model_Doc->buildParamsWebService( ).../method.phtml:341
156.96254565744Model_Doc->getSession( ).../Doc.php:468
166.96254566904Model_Doc->callWebService( ).../Doc.php:377
177.15604593072Model_Doc->setSessionId( ).../Doc.php:364
https://api.vivoclass.com/Staff.getGroups?

Error Codes:

This method does not return any errors

Method: Staff.getGroupDetails

Available since API version 2.1

Returns a group

Parameters:

Name Required Type Default Description
session_id Required string A currently active and valid webservice session id
groups_id Required int The internal id of the group to return

Response Parameters:

Name Description
name The name of the group
users A list of users in the group

Example Request (click to see example response):


( ! ) Notice: Undefined property: stdClass::$user_data in /vivo/developers.vivomiles.com/application/models/Doc.php on line 400
Call Stack
#TimeMemoryFunctionLocation
10.0000240624{main}( ).../index.php:0
20.01671405760Zend_Application->run( ).../index.php:36
30.01671405880Zend_Application_Bootstrap_Bootstrap->run( ).../Application.php:366
40.01681406712Zend_Controller_Front->dispatch( ).../Bootstrap.php:97
50.01711486048Zend_Controller_Dispatcher_Standard->dispatch( ).../Front.php:954
60.15662536736Zend_Controller_Action->dispatch( ).../Standard.php:289
70.93524009000Zend_Controller_Action_HelperBroker->notifyPostDispatch( ).../Action.php:523
80.93524010048Zend_Controller_Action_Helper_ViewRenderer->postDispatch( ).../HelperBroker.php:277
90.93524010368Zend_Controller_Action_Helper_ViewRenderer->render( ).../ViewRenderer.php:957
100.93544011344Zend_Controller_Action_Helper_ViewRenderer->renderScript( ).../ViewRenderer.php:918
110.93544011376Zend_View_Abstract->render( ).../ViewRenderer.php:897
120.95484027960Zend_View->_run( ).../Abstract.php:880
130.95494028968include( '/vivo/developers.vivomiles.com/application/views/scripts/doc/method.phtml' ).../View.php:108
147.15744574968Model_Doc->buildParamsWebService( ).../method.phtml:341
157.15744580648Model_Doc->getSession( ).../Doc.php:468
167.15744581808Model_Doc->callWebService( ).../Doc.php:377
177.35244608672Model_Doc->setSessionId( ).../Doc.php:364

( ! ) Notice: Trying to get property of non-object in /vivo/developers.vivomiles.com/application/models/Doc.php on line 400
Call Stack
#TimeMemoryFunctionLocation
10.0000240624{main}( ).../index.php:0
20.01671405760Zend_Application->run( ).../index.php:36
30.01671405880Zend_Application_Bootstrap_Bootstrap->run( ).../Application.php:366
40.01681406712Zend_Controller_Front->dispatch( ).../Bootstrap.php:97
50.01711486048Zend_Controller_Dispatcher_Standard->dispatch( ).../Front.php:954
60.15662536736Zend_Controller_Action->dispatch( ).../Standard.php:289
70.93524009000Zend_Controller_Action_HelperBroker->notifyPostDispatch( ).../Action.php:523
80.93524010048Zend_Controller_Action_Helper_ViewRenderer->postDispatch( ).../HelperBroker.php:277
90.93524010368Zend_Controller_Action_Helper_ViewRenderer->render( ).../ViewRenderer.php:957
100.93544011344Zend_Controller_Action_Helper_ViewRenderer->renderScript( ).../ViewRenderer.php:918
110.93544011376Zend_View_Abstract->render( ).../ViewRenderer.php:897
120.95484027960Zend_View->_run( ).../Abstract.php:880
130.95494028968include( '/vivo/developers.vivomiles.com/application/views/scripts/doc/method.phtml' ).../View.php:108
147.15744574968Model_Doc->buildParamsWebService( ).../method.phtml:341
157.15744580648Model_Doc->getSession( ).../Doc.php:468
167.15744581808Model_Doc->callWebService( ).../Doc.php:377
177.35244608672Model_Doc->setSessionId( ).../Doc.php:364
https://api.vivoclass.com/Staff.getGroupDetails?groups_id=46

Error Codes:

This method does not return any errors

Method: Staff.isAuthorisationRequiredForRewards

Available since API version 2.2

Parameters:

Name Required Type Default Description
session_id Required string A currently active and valid webservice session id

Response Parameters:

Name Description
int required 0 = not required, 1 = required

Example Request (click to see example response):


( ! ) Notice: Undefined property: stdClass::$user_data in /vivo/developers.vivomiles.com/application/models/Doc.php on line 400
Call Stack
#TimeMemoryFunctionLocation
10.0000240624{main}( ).../index.php:0
20.01671405760Zend_Application->run( ).../index.php:36
30.01671405880Zend_Application_Bootstrap_Bootstrap->run( ).../Application.php:366
40.01681406712Zend_Controller_Front->dispatch( ).../Bootstrap.php:97
50.01711486048Zend_Controller_Dispatcher_Standard->dispatch( ).../Front.php:954
60.15662536736Zend_Controller_Action->dispatch( ).../Standard.php:289
70.93524009000Zend_Controller_Action_HelperBroker->notifyPostDispatch( ).../Action.php:523
80.93524010048Zend_Controller_Action_Helper_ViewRenderer->postDispatch( ).../HelperBroker.php:277
90.93524010368Zend_Controller_Action_Helper_ViewRenderer->render( ).../ViewRenderer.php:957
100.93544011344Zend_Controller_Action_Helper_ViewRenderer->renderScript( ).../ViewRenderer.php:918
110.93544011376Zend_View_Abstract->render( ).../ViewRenderer.php:897
120.95484027960Zend_View->_run( ).../Abstract.php:880
130.95494028968include( '/vivo/developers.vivomiles.com/application/views/scripts/doc/method.phtml' ).../View.php:108
147.35384591312Model_Doc->buildParamsWebService( ).../method.phtml:341
157.35384596928Model_Doc->getSession( ).../Doc.php:468
167.35384598088Model_Doc->callWebService( ).../Doc.php:377
177.54914623320Model_Doc->setSessionId( ).../Doc.php:364

( ! ) Notice: Trying to get property of non-object in /vivo/developers.vivomiles.com/application/models/Doc.php on line 400
Call Stack
#TimeMemoryFunctionLocation
10.0000240624{main}( ).../index.php:0
20.01671405760Zend_Application->run( ).../index.php:36
30.01671405880Zend_Application_Bootstrap_Bootstrap->run( ).../Application.php:366
40.01681406712Zend_Controller_Front->dispatch( ).../Bootstrap.php:97
50.01711486048Zend_Controller_Dispatcher_Standard->dispatch( ).../Front.php:954
60.15662536736Zend_Controller_Action->dispatch( ).../Standard.php:289
70.93524009000Zend_Controller_Action_HelperBroker->notifyPostDispatch( ).../Action.php:523
80.93524010048Zend_Controller_Action_Helper_ViewRenderer->postDispatch( ).../HelperBroker.php:277
90.93524010368Zend_Controller_Action_Helper_ViewRenderer->render( ).../ViewRenderer.php:957
100.93544011344Zend_Controller_Action_Helper_ViewRenderer->renderScript( ).../ViewRenderer.php:918
110.93544011376Zend_View_Abstract->render( ).../ViewRenderer.php:897
120.95484027960Zend_View->_run( ).../Abstract.php:880
130.95494028968include( '/vivo/developers.vivomiles.com/application/views/scripts/doc/method.phtml' ).../View.php:108
147.35384591312Model_Doc->buildParamsWebService( ).../method.phtml:341
157.35384596928Model_Doc->getSession( ).../Doc.php:468
167.35384598088Model_Doc->callWebService( ).../Doc.php:377
177.54914623320Model_Doc->setSessionId( ).../Doc.php:364
https://api.vivoclass.com/Staff.isAuthorisationRequiredForRewards?

Error Codes:

This method does not return any errors

Method: Users.doLogin

Available since API version 1.0

Given a valid set of credentials, the doLogin method returns a session_id for use by other methods. The login credentials are the same as those that the user would use to access Vivo through the website.

Parameters:

Name Required Type Default Description
username Required string The username of the user for whom a session_id is required
password Required string The password corresponding to the username
domain Required string The identifier of the organisation that the username is associated with

Response Parameters:

Name Description
session_id The session_id string that needs to be passed to other API methods

Example Request (click to see example response):

https://api.vivoclass.com/Users.doLogin?username=student1&password=vivomiles1&domain=vivoacademy

Error Codes:

3202, 3203, 3204, 3205

Code Samples:

  package {
   //Import the objects we'll be using for this example
   import flash.display.Sprite;
   import flash.events.Event;
   import flash.net.URLLoader;
   import flash.net.URLRequest;
   import flash.text.TextField;

   //Begin our main class
   public class main extends Sprite
   {

     //Declare 2 properties to be used a bit later
     private var text:TextField;
     private var urlLoader:URLLoader;

     public function main()
     {

       //Set up our text field, so we can see the output on the screen
       this.text = new TextField();
       this.text.width = 400;

       //Add the text field to our stage
       this.addChild(this.text);

       //Set up our request
       var urlRequest:URLRequest = new URLRequest('https://api.vivoclass.com/Users.doLogin?username=example_user&password=pass&domain=example_domain')

       //Create a new loader
       this.urlLoader = new URLLoader();

       //Set an event. This will be triggered when our request has been completely loaded
       this.urlLoader.addEventListener(Event.COMPLETE, this.loaded);

       //Load our request
       this.urlLoader.load(urlRequest);
     }

     //Set up our function, which will be called when the request is loaded
     private function loaded(e:Event):void
     {
       //Load our XML
       var xml:XML = new XML(this.urlLoader.data);

       //Add the data to the text field
       this.text.appendText('Type: ' + xml.descendants('type') + '\n');
       this.text.appendText('Code: ' + xml.descendants('code') + '\n');
       this.text.appendText('Users Id: ' + xml.descendants('users_id') + '\n');
       this.text.appendText('Session Id: ' + xml.descendants('session_id'));
     }

   }
 }
                    

Method: Users.getMobileAppSummary

Available since API version 2.1

Gets a collection of user data which is required by the mobile app, once a user has logged in

Parameters:

Name Required Type Default Description
session_id Required string A valid session_id representing a user

Response Parameters:

Name Description
gender The gender of the user
user_type The type of user e.g. USER, STAFF, GUARDIAN
organisations_id The ID of the school for this user
user_id The ID of this user
staff_type The type of staff e.g. STAFF, LEAD, ADMIN, for users who are not staff, this will be null
year The year the student is in, this will be null for users who are not students
school_type The type of school e.g.PRU, SEN, COLLEGE, SCHOOL_SECONDARY

Example Request (click to see example response):


( ! ) Notice: Undefined property: stdClass::$user_data in /vivo/developers.vivomiles.com/application/models/Doc.php on line 400
Call Stack
#TimeMemoryFunctionLocation
10.0000240624{main}( ).../index.php:0
20.01671405760Zend_Application->run( ).../index.php:36
30.01671405880Zend_Application_Bootstrap_Bootstrap->run( ).../Application.php:366
40.01681406712Zend_Controller_Front->dispatch( ).../Bootstrap.php:97
50.01711486048Zend_Controller_Dispatcher_Standard->dispatch( ).../Front.php:954
60.15662536736Zend_Controller_Action->dispatch( ).../Standard.php:289
70.93524009000Zend_Controller_Action_HelperBroker->notifyPostDispatch( ).../Action.php:523
80.93524010048Zend_Controller_Action_Helper_ViewRenderer->postDispatch( ).../HelperBroker.php:277
90.93524010368Zend_Controller_Action_Helper_ViewRenderer->render( ).../ViewRenderer.php:957
100.93544011344Zend_Controller_Action_Helper_ViewRenderer->renderScript( ).../ViewRenderer.php:918
110.93544011376Zend_View_Abstract->render( ).../ViewRenderer.php:897
120.95484027960Zend_View->_run( ).../Abstract.php:880
130.95494028968include( '/vivo/developers.vivomiles.com/application/views/scripts/doc/method.phtml' ).../View.php:108
147.56604629232Model_Doc->buildParamsWebService( ).../method.phtml:341
157.56604634824Model_Doc->getSession( ).../Doc.php:468
167.56604635984Model_Doc->callWebService( ).../Doc.php:377
177.79184665688Model_Doc->setSessionId( ).../Doc.php:364

( ! ) Notice: Trying to get property of non-object in /vivo/developers.vivomiles.com/application/models/Doc.php on line 400
Call Stack
#TimeMemoryFunctionLocation
10.0000240624{main}( ).../index.php:0
20.01671405760Zend_Application->run( ).../index.php:36
30.01671405880Zend_Application_Bootstrap_Bootstrap->run( ).../Application.php:366
40.01681406712Zend_Controller_Front->dispatch( ).../Bootstrap.php:97
50.01711486048Zend_Controller_Dispatcher_Standard->dispatch( ).../Front.php:954
60.15662536736Zend_Controller_Action->dispatch( ).../Standard.php:289
70.93524009000Zend_Controller_Action_HelperBroker->notifyPostDispatch( ).../Action.php:523
80.93524010048Zend_Controller_Action_Helper_ViewRenderer->postDispatch( ).../HelperBroker.php:277
90.93524010368Zend_Controller_Action_Helper_ViewRenderer->render( ).../ViewRenderer.php:957
100.93544011344Zend_Controller_Action_Helper_ViewRenderer->renderScript( ).../ViewRenderer.php:918
110.93544011376Zend_View_Abstract->render( ).../ViewRenderer.php:897
120.95484027960Zend_View->_run( ).../Abstract.php:880
130.95494028968include( '/vivo/developers.vivomiles.com/application/views/scripts/doc/method.phtml' ).../View.php:108
147.56604629232Model_Doc->buildParamsWebService( ).../method.phtml:341
157.56604634824Model_Doc->getSession( ).../Doc.php:468
167.56604635984Model_Doc->callWebService( ).../Doc.php:377
177.79184665688Model_Doc->setSessionId( ).../Doc.php:364
https://api.vivoclass.com/Users.getMobileAppSummary?

Error Codes:

This method does not return any errors

Method: Users.getSummary

Available since API version 1.0

The getSummary method requires a valid session_id and returns general information about the user. This method works for all types of users including USER, STAFF and ADMIN.

Parameters:

Name Required Type Default Description
session_id Required string A valid session_id representing a user

Response Parameters:

Name Description
users_id The unique id that Vivo uses to identify the user
title The title or salutation to address the user
first_name The first or given name of the user. In school environments, this should not be shown to students if the user is a staff or admin user
last_name The last or surname of the user
organisation_name The name of the organisation that the user is associated with
vivos_current The current number of Vivos in this user’s account as of summary_date
vivos_total The total number of Vivos this user has been awarded as of summary_date
vivos_last_year The total number of Vivos that the user has been awarded last year. In school environments this is taken to be last academic year, otherwise, last calendar year.
date_last_rewarded The date and time that this user was last awarded Vivos
date_last_penalised The date and time that this user was last penalised Vivos
in_gold_club Whether or not this user is a member of the organisation’s Gold Club
allowed_to_reward Whether or not this user is allowed to reward users
allowed_to_penalise Whether or not this user is allowed to penalise users
year The name of the year this user is in
group The name of the group this user is in (if applicable)
sex The sex of the user
user_type This user’s account type (USER|STAFF|ADMIN)
reward_budget_spent The number of Vivos this user has rewarded in reward_budget_period
reward_budget_allowance The maximum number of Vivos this user can reward in reward_budget_period
reward_budget_period The budget period for Reward_budget_allowance (WEEK|MONTH)
summary_date The date and time that this summary was generated
num_transactions The total number of transactions
is_password_required_on_purchase Should a password be entered before the purchase of goods

Example Request (click to see example response):


( ! ) Notice: Undefined property: stdClass::$user_data in /vivo/developers.vivomiles.com/application/models/Doc.php on line 400
Call Stack
#TimeMemoryFunctionLocation
10.0000240624{main}( ).../index.php:0
20.01671405760Zend_Application->run( ).../index.php:36
30.01671405880Zend_Application_Bootstrap_Bootstrap->run( ).../Application.php:366
40.01681406712Zend_Controller_Front->dispatch( ).../Bootstrap.php:97
50.01711486048Zend_Controller_Dispatcher_Standard->dispatch( ).../Front.php:954
60.15662536736Zend_Controller_Action->dispatch( ).../Standard.php:289
70.93524009000Zend_Controller_Action_HelperBroker->notifyPostDispatch( ).../Action.php:523
80.93524010048Zend_Controller_Action_Helper_ViewRenderer->postDispatch( ).../HelperBroker.php:277
90.93524010368Zend_Controller_Action_Helper_ViewRenderer->render( ).../ViewRenderer.php:957
100.93544011344Zend_Controller_Action_Helper_ViewRenderer->renderScript( ).../ViewRenderer.php:918
110.93544011376Zend_View_Abstract->render( ).../ViewRenderer.php:897
120.95484027960Zend_View->_run( ).../Abstract.php:880
130.95494028968include( '/vivo/developers.vivomiles.com/application/views/scripts/doc/method.phtml' ).../View.php:108
147.79364643960Model_Doc->buildParamsWebService( ).../method.phtml:341
157.79374649536Model_Doc->getSession( ).../Doc.php:468
167.79374650696Model_Doc->callWebService( ).../Doc.php:377
178.01084692664Model_Doc->setSessionId( ).../Doc.php:364

( ! ) Notice: Trying to get property of non-object in /vivo/developers.vivomiles.com/application/models/Doc.php on line 400
Call Stack
#TimeMemoryFunctionLocation
10.0000240624{main}( ).../index.php:0
20.01671405760Zend_Application->run( ).../index.php:36
30.01671405880Zend_Application_Bootstrap_Bootstrap->run( ).../Application.php:366
40.01681406712Zend_Controller_Front->dispatch( ).../Bootstrap.php:97
50.01711486048Zend_Controller_Dispatcher_Standard->dispatch( ).../Front.php:954
60.15662536736Zend_Controller_Action->dispatch( ).../Standard.php:289
70.93524009000Zend_Controller_Action_HelperBroker->notifyPostDispatch( ).../Action.php:523
80.93524010048Zend_Controller_Action_Helper_ViewRenderer->postDispatch( ).../HelperBroker.php:277
90.93524010368Zend_Controller_Action_Helper_ViewRenderer->render( ).../ViewRenderer.php:957
100.93544011344Zend_Controller_Action_Helper_ViewRenderer->renderScript( ).../ViewRenderer.php:918
110.93544011376Zend_View_Abstract->render( ).../ViewRenderer.php:897
120.95484027960Zend_View->_run( ).../Abstract.php:880
130.95494028968include( '/vivo/developers.vivomiles.com/application/views/scripts/doc/method.phtml' ).../View.php:108
147.79364643960Model_Doc->buildParamsWebService( ).../method.phtml:341
157.79374649536Model_Doc->getSession( ).../Doc.php:468
167.79374650696Model_Doc->callWebService( ).../Doc.php:377
178.01084692664Model_Doc->setSessionId( ).../Doc.php:364
https://api.vivoclass.com/Users.getSummary?

Error Codes:

3200, 3201

Available since API version 1.0

Requires a valid session_id and the first 2 characters of the search query and returns a list of users matching the search term. This is a simple search and does not support Boolean operators such as AND, OR. The search searches the first and surname of all users of type USER in the organisation, but can only be used by users of type ADMIN or STAFF.

Parameters:

Name Required Type Default Description
session_id Required string A valid session_id representing a user
search Required string A search term to find a user

Response Parameters:

Name Description
users_id The Vivo ID of the user
first_name The first or given name of the user
last_name The last or surname of the user
formatted_name The organisation’s preferred way of formatting this user’s name
group The name of the group this user is a member (if applicable)
year The name of the year this user is a member
UPN The user UPN
current_vivos The user current vivos
total_vivos The user total vivos

Example Request (click to see example response):


( ! ) Notice: Undefined property: stdClass::$user_data in /vivo/developers.vivomiles.com/application/models/Doc.php on line 400
Call Stack
#TimeMemoryFunctionLocation
10.0000240624{main}( ).../index.php:0
20.01671405760Zend_Application->run( ).../index.php:36
30.01671405880Zend_Application_Bootstrap_Bootstrap->run( ).../Application.php:366
40.01681406712Zend_Controller_Front->dispatch( ).../Bootstrap.php:97
50.01711486048Zend_Controller_Dispatcher_Standard->dispatch( ).../Front.php:954
60.15662536736Zend_Controller_Action->dispatch( ).../Standard.php:289
70.93524009000Zend_Controller_Action_HelperBroker->notifyPostDispatch( ).../Action.php:523
80.93524010048Zend_Controller_Action_Helper_ViewRenderer->postDispatch( ).../HelperBroker.php:277
90.93524010368Zend_Controller_Action_Helper_ViewRenderer->render( ).../ViewRenderer.php:957
100.93544011344Zend_Controller_Action_Helper_ViewRenderer->renderScript( ).../ViewRenderer.php:918
110.93544011376Zend_View_Abstract->render( ).../ViewRenderer.php:897
120.95484027960Zend_View->_run( ).../Abstract.php:880
130.95494028968include( '/vivo/developers.vivomiles.com/application/views/scripts/doc/method.phtml' ).../View.php:108
148.01234677512Model_Doc->buildParamsWebService( ).../method.phtml:341
158.01244683040Model_Doc->getSession( ).../Doc.php:468
168.01244684200Model_Doc->callWebService( ).../Doc.php:377
178.21784716608Model_Doc->setSessionId( ).../Doc.php:364

( ! ) Notice: Trying to get property of non-object in /vivo/developers.vivomiles.com/application/models/Doc.php on line 400
Call Stack
#TimeMemoryFunctionLocation
10.0000240624{main}( ).../index.php:0
20.01671405760Zend_Application->run( ).../index.php:36
30.01671405880Zend_Application_Bootstrap_Bootstrap->run( ).../Application.php:366
40.01681406712Zend_Controller_Front->dispatch( ).../Bootstrap.php:97
50.01711486048Zend_Controller_Dispatcher_Standard->dispatch( ).../Front.php:954
60.15662536736Zend_Controller_Action->dispatch( ).../Standard.php:289
70.93524009000Zend_Controller_Action_HelperBroker->notifyPostDispatch( ).../Action.php:523
80.93524010048Zend_Controller_Action_Helper_ViewRenderer->postDispatch( ).../HelperBroker.php:277
90.93524010368Zend_Controller_Action_Helper_ViewRenderer->render( ).../ViewRenderer.php:957
100.93544011344Zend_Controller_Action_Helper_ViewRenderer->renderScript( ).../ViewRenderer.php:918
110.93544011376Zend_View_Abstract->render( ).../ViewRenderer.php:897
120.95484027960Zend_View->_run( ).../Abstract.php:880
130.95494028968include( '/vivo/developers.vivomiles.com/application/views/scripts/doc/method.phtml' ).../View.php:108
148.01234677512Model_Doc->buildParamsWebService( ).../method.phtml:341
158.01244683040Model_Doc->getSession( ).../Doc.php:468
168.01244684200Model_Doc->callWebService( ).../Doc.php:377
178.21784716608Model_Doc->setSessionId( ).../Doc.php:364
https://api.vivoclass.com/Users.search?name=and&search=4b43b0ae

Error Codes:

This method does not return any errors

Method: Users.searchForUser

Available since API version 1.0

Search for users within a organisation

Parameters:

Name Required Type Default Description
session_id Required string A valid session_id representing a user
organisations_id Required int The organisation that the user belongs to
search Required string A search term to find a user

Response Parameters:

Name Description
users_id The Vivo ID of the user
first_name The first or given name of the user
last_name The last or surname of the user
formatted_name The organisation’s preferred way of formatting this user’s name
group The name of the group this user is a member (if applicable)
year The name of the year this user is a member
UPN The user UPN
current_vivos The user current vivos
total_vivos The user total vivos

Example Request (click to see example response):


( ! ) Notice: Undefined property: stdClass::$user_data in /vivo/developers.vivomiles.com/application/models/Doc.php on line 400
Call Stack
#TimeMemoryFunctionLocation
10.0000240624{main}( ).../index.php:0
20.01671405760Zend_Application->run( ).../index.php:36
30.01671405880Zend_Application_Bootstrap_Bootstrap->run( ).../Application.php:366
40.01681406712Zend_Controller_Front->dispatch( ).../Bootstrap.php:97
50.01711486048Zend_Controller_Dispatcher_Standard->dispatch( ).../Front.php:954
60.15662536736Zend_Controller_Action->dispatch( ).../Standard.php:289
70.93524009000Zend_Controller_Action_HelperBroker->notifyPostDispatch( ).../Action.php:523
80.93524010048Zend_Controller_Action_Helper_ViewRenderer->postDispatch( ).../HelperBroker.php:277
90.93524010368Zend_Controller_Action_Helper_ViewRenderer->render( ).../ViewRenderer.php:957
100.93544011344Zend_Controller_Action_Helper_ViewRenderer->renderScript( ).../ViewRenderer.php:918
110.93544011376Zend_View_Abstract->render( ).../ViewRenderer.php:897
120.95484027960Zend_View->_run( ).../Abstract.php:880
130.95494028968include( '/vivo/developers.vivomiles.com/application/views/scripts/doc/method.phtml' ).../View.php:108
148.21924693392Model_Doc->buildParamsWebService( ).../method.phtml:341
158.21934699176Model_Doc->getSession( ).../Doc.php:468
168.21934700336Model_Doc->callWebService( ).../Doc.php:377
178.41344732736Model_Doc->setSessionId( ).../Doc.php:364

( ! ) Notice: Trying to get property of non-object in /vivo/developers.vivomiles.com/application/models/Doc.php on line 400
Call Stack
#TimeMemoryFunctionLocation
10.0000240624{main}( ).../index.php:0
20.01671405760Zend_Application->run( ).../index.php:36
30.01671405880Zend_Application_Bootstrap_Bootstrap->run( ).../Application.php:366
40.01681406712Zend_Controller_Front->dispatch( ).../Bootstrap.php:97
50.01711486048Zend_Controller_Dispatcher_Standard->dispatch( ).../Front.php:954
60.15662536736Zend_Controller_Action->dispatch( ).../Standard.php:289
70.93524009000Zend_Controller_Action_HelperBroker->notifyPostDispatch( ).../Action.php:523
80.93524010048Zend_Controller_Action_Helper_ViewRenderer->postDispatch( ).../HelperBroker.php:277
90.93524010368Zend_Controller_Action_Helper_ViewRenderer->render( ).../ViewRenderer.php:957
100.93544011344Zend_Controller_Action_Helper_ViewRenderer->renderScript( ).../ViewRenderer.php:918
110.93544011376Zend_View_Abstract->render( ).../ViewRenderer.php:897
120.95484027960Zend_View->_run( ).../Abstract.php:880
130.95494028968include( '/vivo/developers.vivomiles.com/application/views/scripts/doc/method.phtml' ).../View.php:108
148.21924693392Model_Doc->buildParamsWebService( ).../method.phtml:341
158.21934699176Model_Doc->getSession( ).../Doc.php:468
168.21934700336Model_Doc->callWebService( ).../Doc.php:377
178.41344732736Model_Doc->setSessionId( ).../Doc.php:364
https://api.vivoclass.com/Users.searchForUser?organisations_id=9&search=4b43b0ae

Error Codes:

This method does not return any errors

Method: Users.getLastTransactions

Available since API version 1.0

The getLastTransactions method requires a valid session_id and returns information about the last num_transactions that have occurred on this user’s account. These transactions do not include those generated when a user rewards or penalises another user - please see Users.getTransactionsIssued.

Parameters:

Name Required Type Default Description
session_id Required string A valid session_id representing a user
num_transactions Optional int 5 The number of transactions for which data should be returned
offset Optional int The offset of the rows for paging
reason_type Optional string NULL parameter to filter transactions by reason type

Response Parameters:

Name Description
transactions_id This is a Vivo generated globally unique ID of this transaction
transaction_date The date and time this transaction occurred (see dates)
reason_type The type of transaction
category The category of the transaction (set by organisation)
title The title of the transaction
description Additional optional information about the transaction
vivos_quantity The number of Vivos involved in the transaction
issuers_name If transaction did not originate from the user, this will contain the name of the user who instigated the transaction.

Example Request (click to see example response):


( ! ) Notice: Undefined property: stdClass::$user_data in /vivo/developers.vivomiles.com/application/models/Doc.php on line 400
Call Stack
#TimeMemoryFunctionLocation
10.0000240624{main}( ).../index.php:0
20.01671405760Zend_Application->run( ).../index.php:36
30.01671405880Zend_Application_Bootstrap_Bootstrap->run( ).../Application.php:366
40.01681406712Zend_Controller_Front->dispatch( ).../Bootstrap.php:97
50.01711486048Zend_Controller_Dispatcher_Standard->dispatch( ).../Front.php:954
60.15662536736Zend_Controller_Action->dispatch( ).../Standard.php:289
70.93524009000Zend_Controller_Action_HelperBroker->notifyPostDispatch( ).../Action.php:523
80.93524010048Zend_Controller_Action_Helper_ViewRenderer->postDispatch( ).../HelperBroker.php:277
90.93524010368Zend_Controller_Action_Helper_ViewRenderer->render( ).../ViewRenderer.php:957
100.93544011344Zend_Controller_Action_Helper_ViewRenderer->renderScript( ).../ViewRenderer.php:918
110.93544011376Zend_View_Abstract->render( ).../ViewRenderer.php:897
120.95484027960Zend_View->_run( ).../Abstract.php:880
130.95494028968include( '/vivo/developers.vivomiles.com/application/views/scripts/doc/method.phtml' ).../View.php:108
148.42184723424Model_Doc->buildParamsWebService( ).../method.phtml:341
158.42194729328Model_Doc->getSession( ).../Doc.php:468
168.42194730488Model_Doc->callWebService( ).../Doc.php:377
178.61824765048Model_Doc->setSessionId( ).../Doc.php:364

( ! ) Notice: Trying to get property of non-object in /vivo/developers.vivomiles.com/application/models/Doc.php on line 400
Call Stack
#TimeMemoryFunctionLocation
10.0000240624{main}( ).../index.php:0
20.01671405760Zend_Application->run( ).../index.php:36
30.01671405880Zend_Application_Bootstrap_Bootstrap->run( ).../Application.php:366
40.01681406712Zend_Controller_Front->dispatch( ).../Bootstrap.php:97
50.01711486048Zend_Controller_Dispatcher_Standard->dispatch( ).../Front.php:954
60.15662536736Zend_Controller_Action->dispatch( ).../Standard.php:289
70.93524009000Zend_Controller_Action_HelperBroker->notifyPostDispatch( ).../Action.php:523
80.93524010048Zend_Controller_Action_Helper_ViewRenderer->postDispatch( ).../HelperBroker.php:277
90.93524010368Zend_Controller_Action_Helper_ViewRenderer->render( ).../ViewRenderer.php:957
100.93544011344Zend_Controller_Action_Helper_ViewRenderer->renderScript( ).../ViewRenderer.php:918
110.93544011376Zend_View_Abstract->render( ).../ViewRenderer.php:897
120.95484027960Zend_View->_run( ).../Abstract.php:880
130.95494028968include( '/vivo/developers.vivomiles.com/application/views/scripts/doc/method.phtml' ).../View.php:108
148.42184723424Model_Doc->buildParamsWebService( ).../method.phtml:341
158.42194729328Model_Doc->getSession( ).../Doc.php:468
168.42194730488Model_Doc->callWebService( ).../Doc.php:377
178.61824765048Model_Doc->setSessionId( ).../Doc.php:364
https://api.vivoclass.com/Users.getLastTransactions?num_transactions=23&offset=62

Error Codes:

3200

Code Samples:

  package {
   //Import the objects we'll be using for this example
   import flash.display.Sprite;
   import flash.events.Event;
   import flash.net.URLLoader;
   import flash.net.URLRequest;
   import flash.text.TextField;
   import flash.xml.XMLNode;

   //Begin our main class
   public class main extends Sprite
   {

     //Declare 2 properties to be used a bit later
     private var text:TextField;
     private var urlLoader:URLLoader;

     public function main()
     {

       //Set up our text field, so we can see the output on the screen
       this.text = new TextField();
       this.text.width = 400;

       //Add the text field to our stage
       this.addChild(this.text);

       //Set up our request
       var urlRequest:URLRequest = new URLRequest('https://api.vivoclass.com/Users.getLastTransactions?num_transactions=2&session_id=.....')

       //Create a new loader
       this.urlLoader = new URLLoader();

       //Set an event. This will be triggered when our request has been completely loaded
       this.urlLoader.addEventListener(Event.COMPLETE, this.loaded);

       //Load our request
       this.urlLoader.load(urlRequest);
     }

     //Set up our function, which will be called when the request is loaded
     private function loaded(e:Event):void
     {
       //Load our XML
       var xml:XML = new XML(this.urlLoader.data);

       //For each transaction, output the data
       for(var i:int = 0; i < xml.descendants('transaction').length(); i++){
         var data:XML = (xml.descendants('transaction')[i] as XML);

         this.text.appendText('Transaction Id: ' + data.descendants('transactions_id') + '\n');
         this.text.appendText('Quantity: ' + data.descendants('quantity') + '\n');
         this.text.appendText('Date: ' + data.descendants('date') + '\n');
         this.text.appendText('Reason: ' + data.descendants('reason') + '\n\n');
       }
     }

   }
 }
                    

Method: Users.getTransactionsIssued

Available since API version 1.0

The getTransactionsIssued method requires a valid session_id and returns information about transactions that this user has issued to other users. This does not include transactions that this user has instigated on their own account – see Users.getLastTransactions

Parameters:

Name Required Type Default Description
session_id Required string A valid session_id representing a user
num_transactions Optional int 5 The number of transactions for which data should be returned
offset Optional int The offset of the rows for paging

Response Parameters:

Name Description
transactions_id This is a Vivo generated globally unique ID of this transaction
transaction_date The date and time this transaction occurred (see dates)
reason_type The type of transaction (REWARD|PENALTY)
category The category of the transaction (set by organisation)
title The title of the transaction
description Additional optional information about the transaction
vivos_quantity The number Vivos being rewarded or penalised
users_id The Vivo ID of the user being rewarded or penalised
first_name The first or given name of the user being rewarded or penalised
last_name The last or surname of the user being rewarded or penalised
formatted_name The organisation’s preferred way of formatting this user’s name

Example Request (click to see example response):


( ! ) Notice: Undefined property: stdClass::$user_data in /vivo/developers.vivomiles.com/application/models/Doc.php on line 400
Call Stack
#TimeMemoryFunctionLocation
10.0000240624{main}( ).../index.php:0
20.01671405760Zend_Application->run( ).../index.php:36
30.01671405880Zend_Application_Bootstrap_Bootstrap->run( ).../Application.php:366
40.01681406712Zend_Controller_Front->dispatch( ).../Bootstrap.php:97
50.01711486048Zend_Controller_Dispatcher_Standard->dispatch( ).../Front.php:954
60.15662536736Zend_Controller_Action->dispatch( ).../Standard.php:289
70.93524009000Zend_Controller_Action_HelperBroker->notifyPostDispatch( ).../Action.php:523
80.93524010048Zend_Controller_Action_Helper_ViewRenderer->postDispatch( ).../HelperBroker.php:277
90.93524010368Zend_Controller_Action_Helper_ViewRenderer->render( ).../ViewRenderer.php:957
100.93544011344Zend_Controller_Action_Helper_ViewRenderer->renderScript( ).../ViewRenderer.php:918
110.93544011376Zend_View_Abstract->render( ).../ViewRenderer.php:897
120.95484027960Zend_View->_run( ).../Abstract.php:880
130.95494028968include( '/vivo/developers.vivomiles.com/application/views/scripts/doc/method.phtml' ).../View.php:108
148.62014770768Model_Doc->buildParamsWebService( ).../method.phtml:341
158.62024776568Model_Doc->getSession( ).../Doc.php:468
168.62024777728Model_Doc->callWebService( ).../Doc.php:377
178.82354812680Model_Doc->setSessionId( ).../Doc.php:364

( ! ) Notice: Trying to get property of non-object in /vivo/developers.vivomiles.com/application/models/Doc.php on line 400
Call Stack
#TimeMemoryFunctionLocation
10.0000240624{main}( ).../index.php:0
20.01671405760Zend_Application->run( ).../index.php:36
30.01671405880Zend_Application_Bootstrap_Bootstrap->run( ).../Application.php:366
40.01681406712Zend_Controller_Front->dispatch( ).../Bootstrap.php:97
50.01711486048Zend_Controller_Dispatcher_Standard->dispatch( ).../Front.php:954
60.15662536736Zend_Controller_Action->dispatch( ).../Standard.php:289
70.93524009000Zend_Controller_Action_HelperBroker->notifyPostDispatch( ).../Action.php:523
80.93524010048Zend_Controller_Action_Helper_ViewRenderer->postDispatch( ).../HelperBroker.php:277
90.93524010368Zend_Controller_Action_Helper_ViewRenderer->render( ).../ViewRenderer.php:957
100.93544011344Zend_Controller_Action_Helper_ViewRenderer->renderScript( ).../ViewRenderer.php:918
110.93544011376Zend_View_Abstract->render( ).../ViewRenderer.php:897
120.95484027960Zend_View->_run( ).../Abstract.php:880
130.95494028968include( '/vivo/developers.vivomiles.com/application/views/scripts/doc/method.phtml' ).../View.php:108
148.62014770768Model_Doc->buildParamsWebService( ).../method.phtml:341
158.62024776568Model_Doc->getSession( ).../Doc.php:468
168.62024777728Model_Doc->callWebService( ).../Doc.php:377
178.82354812680Model_Doc->setSessionId( ).../Doc.php:364
https://api.vivoclass.com/Users.getTransactionsIssued?num_transactions=12&offset=98

Error Codes:

This method does not return any errors

Method: Users.getAwardCategories

Available since API version 1.0

The getAwardCategories method requires a session_id and returns a list of reward categories that this user is allowed to reward or penalise against.

Parameters:

Name Required Type Default Description
session_id Required string A valid session_id representing a user

Response Parameters:

Name Description
default_vivos The number of Vivos that the organisation has set as a default for this category of transaction
category The title of this category
guidelines Optional additional text describing the category
default_vivos_allow_overide Whether or not the default number of Vivos can be overridden for this category of reward or penalty

Example Request (click to see example response):


( ! ) Notice: Undefined property: stdClass::$user_data in /vivo/developers.vivomiles.com/application/models/Doc.php on line 400
Call Stack
#TimeMemoryFunctionLocation
10.0000240624{main}( ).../index.php:0
20.01671405760Zend_Application->run( ).../index.php:36
30.01671405880Zend_Application_Bootstrap_Bootstrap->run( ).../Application.php:366
40.01681406712Zend_Controller_Front->dispatch( ).../Bootstrap.php:97
50.01711486048Zend_Controller_Dispatcher_Standard->dispatch( ).../Front.php:954
60.15662536736Zend_Controller_Action->dispatch( ).../Standard.php:289
70.93524009000Zend_Controller_Action_HelperBroker->notifyPostDispatch( ).../Action.php:523
80.93524010048Zend_Controller_Action_Helper_ViewRenderer->postDispatch( ).../HelperBroker.php:277
90.93524010368Zend_Controller_Action_Helper_ViewRenderer->render( ).../ViewRenderer.php:957
100.93544011344Zend_Controller_Action_Helper_ViewRenderer->renderScript( ).../ViewRenderer.php:918
110.93544011376Zend_View_Abstract->render( ).../ViewRenderer.php:897
120.95484027960Zend_View->_run( ).../Abstract.php:880
130.95494028968include( '/vivo/developers.vivomiles.com/application/views/scripts/doc/method.phtml' ).../View.php:108
148.82494786776Model_Doc->buildParamsWebService( ).../method.phtml:341
158.82504792368Model_Doc->getSession( ).../Doc.php:468
168.82504793528Model_Doc->callWebService( ).../Doc.php:377
179.01864821080Model_Doc->setSessionId( ).../Doc.php:364

( ! ) Notice: Trying to get property of non-object in /vivo/developers.vivomiles.com/application/models/Doc.php on line 400
Call Stack
#TimeMemoryFunctionLocation
10.0000240624{main}( ).../index.php:0
20.01671405760Zend_Application->run( ).../index.php:36
30.01671405880Zend_Application_Bootstrap_Bootstrap->run( ).../Application.php:366
40.01681406712Zend_Controller_Front->dispatch( ).../Bootstrap.php:97
50.01711486048Zend_Controller_Dispatcher_Standard->dispatch( ).../Front.php:954
60.15662536736Zend_Controller_Action->dispatch( ).../Standard.php:289
70.93524009000Zend_Controller_Action_HelperBroker->notifyPostDispatch( ).../Action.php:523
80.93524010048Zend_Controller_Action_Helper_ViewRenderer->postDispatch( ).../HelperBroker.php:277
90.93524010368Zend_Controller_Action_Helper_ViewRenderer->render( ).../ViewRenderer.php:957
100.93544011344Zend_Controller_Action_Helper_ViewRenderer->renderScript( ).../ViewRenderer.php:918
110.93544011376Zend_View_Abstract->render( ).../ViewRenderer.php:897
120.95484027960Zend_View->_run( ).../Abstract.php:880
130.95494028968include( '/vivo/developers.vivomiles.com/application/views/scripts/doc/method.phtml' ).../View.php:108
148.82494786776Model_Doc->buildParamsWebService( ).../method.phtml:341
158.82504792368Model_Doc->getSession( ).../Doc.php:468
168.82504793528Model_Doc->callWebService( ).../Doc.php:377
179.01864821080Model_Doc->setSessionId( ).../Doc.php:364
https://api.vivoclass.com/Users.getAwardCategories?

Error Codes:

This method does not return any errors

Method: Users.doLogout

Available since API version 1.0

The doLogout method dissociates a user with a session_id

Parameters:

Name Required Type Default Description
session_id Required string A valid session_id representing a user

Example Request (click to see example response):


( ! ) Notice: Undefined property: stdClass::$user_data in /vivo/developers.vivomiles.com/application/models/Doc.php on line 400
Call Stack
#TimeMemoryFunctionLocation
10.0000240624{main}( ).../index.php:0
20.01671405760Zend_Application->run( ).../index.php:36
30.01671405880Zend_Application_Bootstrap_Bootstrap->run( ).../Application.php:366
40.01681406712Zend_Controller_Front->dispatch( ).../Bootstrap.php:97
50.01711486048Zend_Controller_Dispatcher_Standard->dispatch( ).../Front.php:954
60.15662536736Zend_Controller_Action->dispatch( ).../Standard.php:289
70.93524009000Zend_Controller_Action_HelperBroker->notifyPostDispatch( ).../Action.php:523
80.93524010048Zend_Controller_Action_Helper_ViewRenderer->postDispatch( ).../HelperBroker.php:277
90.93524010368Zend_Controller_Action_Helper_ViewRenderer->render( ).../ViewRenderer.php:957
100.93544011344Zend_Controller_Action_Helper_ViewRenderer->renderScript( ).../ViewRenderer.php:918
110.93544011376Zend_View_Abstract->render( ).../ViewRenderer.php:897
120.95484027960Zend_View->_run( ).../Abstract.php:880
130.95494028968include( '/vivo/developers.vivomiles.com/application/views/scripts/doc/method.phtml' ).../View.php:108
149.03624800272Model_Doc->buildParamsWebService( ).../method.phtml:341
159.03634805840Model_Doc->getSession( ).../Doc.php:468
169.03634807000Model_Doc->callWebService( ).../Doc.php:377
179.23364831984Model_Doc->setSessionId( ).../Doc.php:364

( ! ) Notice: Trying to get property of non-object in /vivo/developers.vivomiles.com/application/models/Doc.php on line 400
Call Stack
#TimeMemoryFunctionLocation
10.0000240624{main}( ).../index.php:0
20.01671405760Zend_Application->run( ).../index.php:36
30.01671405880Zend_Application_Bootstrap_Bootstrap->run( ).../Application.php:366
40.01681406712Zend_Controller_Front->dispatch( ).../Bootstrap.php:97
50.01711486048Zend_Controller_Dispatcher_Standard->dispatch( ).../Front.php:954
60.15662536736Zend_Controller_Action->dispatch( ).../Standard.php:289
70.93524009000Zend_Controller_Action_HelperBroker->notifyPostDispatch( ).../Action.php:523
80.93524010048Zend_Controller_Action_Helper_ViewRenderer->postDispatch( ).../HelperBroker.php:277
90.93524010368Zend_Controller_Action_Helper_ViewRenderer->render( ).../ViewRenderer.php:957
100.93544011344Zend_Controller_Action_Helper_ViewRenderer->renderScript( ).../ViewRenderer.php:918
110.93544011376Zend_View_Abstract->render( ).../ViewRenderer.php:897
120.95484027960Zend_View->_run( ).../Abstract.php:880
130.95494028968include( '/vivo/developers.vivomiles.com/application/views/scripts/doc/method.phtml' ).../View.php:108
149.03624800272Model_Doc->buildParamsWebService( ).../method.phtml:341
159.03634805840Model_Doc->getSession( ).../Doc.php:468
169.03634807000Model_Doc->callWebService( ).../Doc.php:377
179.23364831984Model_Doc->setSessionId( ).../Doc.php:364
https://api.vivoclass.com/Users.doLogout?

Error Codes:

3200, 3201

Code Samples:

  package {
   //Import the objects we'll be using for this example
   import flash.display.Sprite;
   import flash.events.Event;
   import flash.net.URLLoader;
   import flash.net.URLRequest;
   import flash.text.TextField;
   import flash.xml.XMLNode;

   //Begin our main class
   public class main extends Sprite
   {

     //Declare 2 properties to be used a bit later
     private var text:TextField;
     private var urlLoader:URLLoader;

     public function main()
     {

       //Set up our text field, so we can see the output on the screen
       this.text = new TextField();
       this.text.width = 400;

       //Add the text field to our stage
       this.addChild(this.text);

       //Set up our request
       var urlRequest:URLRequest = new URLRequest('https://api.vivoclass.com/Users.doLogout?session_id=......')

       //Create a new loader
       this.urlLoader = new URLLoader();

       //Set an event. This will be triggered when our request has been completely loaded
       this.urlLoader.addEventListener(Event.COMPLETE, this.loaded);

       //Load our request
       this.urlLoader.load(urlRequest);
     }

     //Set up our function, which will be called when the request is loaded
     private function loaded(e:Event):void
     {
       //Load our XML
       var xml:XML = new XML(this.urlLoader.data);

       //Add the data to the text field
       this.text.appendText('Type: ' + xml.descendants('type') + '\n');
       this.text.appendText('Code: ' + xml.descendants('code') + '\n');
       this.text.appendText('Users Id: ' + xml.descendants('users_id') + '\n');
       this.text.appendText('Info: ' + xml.descendants('text') + '\n');
     }

   }
 }
                    

Method: Users.doReward

Available since API version 1.0

The doReward method allows you to reward or penalise a user from the account represented by session_id. Please note: due to the nature of this method, there are a large number of validation checks that can return a number of error messages that should be handled correctly. The optional password parameter is not needed in case of rewards that does not need authorisation. However when transaction authorisation is needed the password is mandatory.

Parameters:

Name Required Type Default Description
session_id Required string The session_id of the user currently logged in
users_id Required string The Vivo ID of the user to be rewarded or penalised
vivos_quantity Required int The number of Vivos to reward or penalise the user. Positive integer to reward a user and negative to penalise.
category Required string Category of the reward
title Optional string Optional title of the transaction
description Optional string Optional additional details of the transaction
password Optional string Password of user used for reward authorisation if required

Example Request (click to see example response):


( ! ) Notice: Undefined property: stdClass::$user_data in /vivo/developers.vivomiles.com/application/models/Doc.php on line 400
Call Stack
#TimeMemoryFunctionLocation
10.0000240624{main}( ).../index.php:0
20.01671405760Zend_Application->run( ).../index.php:36
30.01671405880Zend_Application_Bootstrap_Bootstrap->run( ).../Application.php:366
40.01681406712Zend_Controller_Front->dispatch( ).../Bootstrap.php:97
50.01711486048Zend_Controller_Dispatcher_Standard->dispatch( ).../Front.php:954
60.15662536736Zend_Controller_Action->dispatch( ).../Standard.php:289
70.93524009000Zend_Controller_Action_HelperBroker->notifyPostDispatch( ).../Action.php:523
80.93524010048Zend_Controller_Action_Helper_ViewRenderer->postDispatch( ).../HelperBroker.php:277
90.93524010368Zend_Controller_Action_Helper_ViewRenderer->render( ).../ViewRenderer.php:957
100.93544011344Zend_Controller_Action_Helper_ViewRenderer->renderScript( ).../ViewRenderer.php:918
110.93544011376Zend_View_Abstract->render( ).../ViewRenderer.php:897
120.95484027960Zend_View->_run( ).../Abstract.php:880
130.95494028968include( '/vivo/developers.vivomiles.com/application/views/scripts/doc/method.phtml' ).../View.php:108
149.23524820880Model_Doc->buildParamsWebService( ).../method.phtml:341
159.23524826928Model_Doc->getSession( ).../Doc.php:468
169.23524828088Model_Doc->callWebService( ).../Doc.php:377
179.42964860824Model_Doc->setSessionId( ).../Doc.php:364

( ! ) Notice: Trying to get property of non-object in /vivo/developers.vivomiles.com/application/models/Doc.php on line 400
Call Stack
#TimeMemoryFunctionLocation
10.0000240624{main}( ).../index.php:0
20.01671405760Zend_Application->run( ).../index.php:36
30.01671405880Zend_Application_Bootstrap_Bootstrap->run( ).../Application.php:366
40.01681406712Zend_Controller_Front->dispatch( ).../Bootstrap.php:97
50.01711486048Zend_Controller_Dispatcher_Standard->dispatch( ).../Front.php:954
60.15662536736Zend_Controller_Action->dispatch( ).../Standard.php:289
70.93524009000Zend_Controller_Action_HelperBroker->notifyPostDispatch( ).../Action.php:523
80.93524010048Zend_Controller_Action_Helper_ViewRenderer->postDispatch( ).../HelperBroker.php:277
90.93524010368Zend_Controller_Action_Helper_ViewRenderer->render( ).../ViewRenderer.php:957
100.93544011344Zend_Controller_Action_Helper_ViewRenderer->renderScript( ).../ViewRenderer.php:918
110.93544011376Zend_View_Abstract->render( ).../ViewRenderer.php:897
120.95484027960Zend_View->_run( ).../Abstract.php:880
130.95494028968include( '/vivo/developers.vivomiles.com/application/views/scripts/doc/method.phtml' ).../View.php:108
149.23524820880Model_Doc->buildParamsWebService( ).../method.phtml:341
159.23524826928Model_Doc->getSession( ).../Doc.php:468
169.23524828088Model_Doc->callWebService( ).../Doc.php:377
179.42964860824Model_Doc->setSessionId( ).../Doc.php:364
https://api.vivoclass.com/Users.doReward?users_id=Q821225197009&vivos=1&category=REWARD&title=The+title+of+the+reward&description=+The+description+of+the+reward&vivos_quantity=27

Error Codes:

3207, 3209, 3210, 3120, 3121, 3402, 3403, 3404

Method: Users.getAvatar

Available since API version 1.0

Given a valid set of credentials the portrait method returns an image in the format specified of a head-and-shoulders view of the avatar. We recommend that this image is cached by the requesting application. Non-binary output formats will be base64 encoded.

Parameters:

Name Required Type Default Description
session_id Required string A valid session_id representing a user
width Optional int 106 The width of the image that is required in pixels
height Optional int 123 The height of the image that is required in pixels
file_format Optional string PNG The format of the image. Accepted values are: PNG, JPG, EPS, GIF, PSD, PDF, or SVG (defaults to PNG)
orientation Optional string HEAD_AND_SHOULDERS The orientation of the image, accepted values are HEAD_AND_SHOULDERS and FULL_BODY
background Optional bool false If a value is supplied for background the avatar will appear on a scenic background if the user has enabled one

Example Request (click to see example response):


( ! ) Notice: Undefined property: stdClass::$user_data in /vivo/developers.vivomiles.com/application/models/Doc.php on line 400
Call Stack
#TimeMemoryFunctionLocation
10.0000240624{main}( ).../index.php:0
20.01671405760Zend_Application->run( ).../index.php:36
30.01671405880Zend_Application_Bootstrap_Bootstrap->run( ).../Application.php:366
40.01681406712Zend_Controller_Front->dispatch( ).../Bootstrap.php:97
50.01711486048Zend_Controller_Dispatcher_Standard->dispatch( ).../Front.php:954
60.15662536736Zend_Controller_Action->dispatch( ).../Standard.php:289
70.93524009000Zend_Controller_Action_HelperBroker->notifyPostDispatch( ).../Action.php:523
80.93524010048Zend_Controller_Action_Helper_ViewRenderer->postDispatch( ).../HelperBroker.php:277
90.93524010368Zend_Controller_Action_Helper_ViewRenderer->render( ).../ViewRenderer.php:957
100.93544011344Zend_Controller_Action_Helper_ViewRenderer->renderScript( ).../ViewRenderer.php:918
110.93544011376Zend_View_Abstract->render( ).../ViewRenderer.php:897
120.95484027960Zend_View->_run( ).../Abstract.php:880
130.95494028968include( '/vivo/developers.vivomiles.com/application/views/scripts/doc/method.phtml' ).../View.php:108
149.43104839712Model_Doc->buildParamsWebService( ).../method.phtml:341
159.43114845784Model_Doc->getSession( ).../Doc.php:468
169.43114846944Model_Doc->callWebService( ).../Doc.php:377
179.63144877400Model_Doc->setSessionId( ).../Doc.php:364

( ! ) Notice: Trying to get property of non-object in /vivo/developers.vivomiles.com/application/models/Doc.php on line 400
Call Stack
#TimeMemoryFunctionLocation
10.0000240624{main}( ).../index.php:0
20.01671405760Zend_Application->run( ).../index.php:36
30.01671405880Zend_Application_Bootstrap_Bootstrap->run( ).../Application.php:366
40.01681406712Zend_Controller_Front->dispatch( ).../Bootstrap.php:97
50.01711486048Zend_Controller_Dispatcher_Standard->dispatch( ).../Front.php:954
60.15662536736Zend_Controller_Action->dispatch( ).../Standard.php:289
70.93524009000Zend_Controller_Action_HelperBroker->notifyPostDispatch( ).../Action.php:523
80.93524010048Zend_Controller_Action_Helper_ViewRenderer->postDispatch( ).../HelperBroker.php:277
90.93524010368Zend_Controller_Action_Helper_ViewRenderer->render( ).../ViewRenderer.php:957
100.93544011344Zend_Controller_Action_Helper_ViewRenderer->renderScript( ).../ViewRenderer.php:918
110.93544011376Zend_View_Abstract->render( ).../ViewRenderer.php:897
120.95484027960Zend_View->_run( ).../Abstract.php:880
130.95494028968include( '/vivo/developers.vivomiles.com/application/views/scripts/doc/method.phtml' ).../View.php:108
149.43104839712Model_Doc->buildParamsWebService( ).../method.phtml:341
159.43114845784Model_Doc->getSession( ).../Doc.php:468
169.43114846944Model_Doc->callWebService( ).../Doc.php:377
179.63144877400Model_Doc->setSessionId( ).../Doc.php:364
https://api.vivoclass.com/Users.getAvatar?width=38&height=47

Error Codes:

This method does not return any errors

Method: Users.getVirtualLevels

Available since API version 2.0

Available Virtual levels and Vivos needed in that school

Parameters:

Name Required Type Default Description
session_id Required string A valid session_id representing a staff user

Example Request (click to see example response):


( ! ) Notice: Undefined property: stdClass::$user_data in /vivo/developers.vivomiles.com/application/models/Doc.php on line 400
Call Stack
#TimeMemoryFunctionLocation
10.0000240624{main}( ).../index.php:0
20.01671405760Zend_Application->run( ).../index.php:36
30.01671405880Zend_Application_Bootstrap_Bootstrap->run( ).../Application.php:366
40.01681406712Zend_Controller_Front->dispatch( ).../Bootstrap.php:97
50.01711486048Zend_Controller_Dispatcher_Standard->dispatch( ).../Front.php:954
60.15662536736Zend_Controller_Action->dispatch( ).../Standard.php:289
70.93524009000Zend_Controller_Action_HelperBroker->notifyPostDispatch( ).../Action.php:523
80.93524010048Zend_Controller_Action_Helper_ViewRenderer->postDispatch( ).../HelperBroker.php:277
90.93524010368Zend_Controller_Action_Helper_ViewRenderer->render( ).../ViewRenderer.php:957
100.93544011344Zend_Controller_Action_Helper_ViewRenderer->renderScript( ).../ViewRenderer.php:918
110.93544011376Zend_View_Abstract->render( ).../ViewRenderer.php:897
120.95484027960Zend_View->_run( ).../Abstract.php:880
130.95494028968include( '/vivo/developers.vivomiles.com/application/views/scripts/doc/method.phtml' ).../View.php:108
149.63304853032Model_Doc->buildParamsWebService( ).../method.phtml:341
159.63304858616Model_Doc->getSession( ).../Doc.php:468
169.63304859776Model_Doc->callWebService( ).../Doc.php:377
179.83054884440Model_Doc->setSessionId( ).../Doc.php:364

( ! ) Notice: Trying to get property of non-object in /vivo/developers.vivomiles.com/application/models/Doc.php on line 400
Call Stack
#TimeMemoryFunctionLocation
10.0000240624{main}( ).../index.php:0
20.01671405760Zend_Application->run( ).../index.php:36
30.01671405880Zend_Application_Bootstrap_Bootstrap->run( ).../Application.php:366
40.01681406712Zend_Controller_Front->dispatch( ).../Bootstrap.php:97
50.01711486048Zend_Controller_Dispatcher_Standard->dispatch( ).../Front.php:954
60.15662536736Zend_Controller_Action->dispatch( ).../Standard.php:289
70.93524009000Zend_Controller_Action_HelperBroker->notifyPostDispatch( ).../Action.php:523
80.93524010048Zend_Controller_Action_Helper_ViewRenderer->postDispatch( ).../HelperBroker.php:277
90.93524010368Zend_Controller_Action_Helper_ViewRenderer->render( ).../ViewRenderer.php:957
100.93544011344Zend_Controller_Action_Helper_ViewRenderer->renderScript( ).../ViewRenderer.php:918
110.93544011376Zend_View_Abstract->render( ).../ViewRenderer.php:897
120.95484027960Zend_View->_run( ).../Abstract.php:880
130.95494028968include( '/vivo/developers.vivomiles.com/application/views/scripts/doc/method.phtml' ).../View.php:108
149.63304853032Model_Doc->buildParamsWebService( ).../method.phtml:341
159.63304858616Model_Doc->getSession( ).../Doc.php:468
169.63304859776Model_Doc->callWebService( ).../Doc.php:377
179.83054884440Model_Doc->setSessionId( ).../Doc.php:364
https://api.vivoclass.com/Users.getVirtualLevels?

Error Codes:

This method does not return any errors

Method: Users.ping

Available since API version 1.0

Allows an application to refresh a user's session during long periods of expected inactivity

Parameters:

Name Required Type Default Description
session_id Required string A currently active and valid webservice session id

Response Parameters:

Name Description
session_id The session_id string that needs to be passed to other API methods
user_type The utype string that identifies the type of account in use

Example Request (click to see example response):


( ! ) Notice: Undefined property: stdClass::$user_data in /vivo/developers.vivomiles.com/application/models/Doc.php on line 400
Call Stack
#TimeMemoryFunctionLocation
10.0000240624{main}( ).../index.php:0
20.01671405760Zend_Application->run( ).../index.php:36
30.01671405880Zend_Application_Bootstrap_Bootstrap->run( ).../Application.php:366
40.01681406712Zend_Controller_Front->dispatch( ).../Bootstrap.php:97
50.01711486048Zend_Controller_Dispatcher_Standard->dispatch( ).../Front.php:954
60.15662536736Zend_Controller_Action->dispatch( ).../Standard.php:289
70.93524009000Zend_Controller_Action_HelperBroker->notifyPostDispatch( ).../Action.php:523
80.93524010048Zend_Controller_Action_Helper_ViewRenderer->postDispatch( ).../HelperBroker.php:277
90.93524010368Zend_Controller_Action_Helper_ViewRenderer->render( ).../ViewRenderer.php:957
100.93544011344Zend_Controller_Action_Helper_ViewRenderer->renderScript( ).../ViewRenderer.php:918
110.93544011376Zend_View_Abstract->render( ).../ViewRenderer.php:897
120.95484027960Zend_View->_run( ).../Abstract.php:880
130.95494028968include( '/vivo/developers.vivomiles.com/application/views/scripts/doc/method.phtml' ).../View.php:108
149.83204868960Model_Doc->buildParamsWebService( ).../method.phtml:341
159.83214874528Model_Doc->getSession( ).../Doc.php:468
169.83214875688Model_Doc->callWebService( ).../Doc.php:377
1710.02604901688Model_Doc->setSessionId( ).../Doc.php:364

( ! ) Notice: Trying to get property of non-object in /vivo/developers.vivomiles.com/application/models/Doc.php on line 400
Call Stack
#TimeMemoryFunctionLocation
10.0000240624{main}( ).../index.php:0
20.01671405760Zend_Application->run( ).../index.php:36
30.01671405880Zend_Application_Bootstrap_Bootstrap->run( ).../Application.php:366
40.01681406712Zend_Controller_Front->dispatch( ).../Bootstrap.php:97
50.01711486048Zend_Controller_Dispatcher_Standard->dispatch( ).../Front.php:954
60.15662536736Zend_Controller_Action->dispatch( ).../Standard.php:289
70.93524009000Zend_Controller_Action_HelperBroker->notifyPostDispatch( ).../Action.php:523
80.93524010048Zend_Controller_Action_Helper_ViewRenderer->postDispatch( ).../HelperBroker.php:277
90.93524010368Zend_Controller_Action_Helper_ViewRenderer->render( ).../ViewRenderer.php:957
100.93544011344Zend_Controller_Action_Helper_ViewRenderer->renderScript( ).../ViewRenderer.php:918
110.93544011376Zend_View_Abstract->render( ).../ViewRenderer.php:897
120.95484027960Zend_View->_run( ).../Abstract.php:880
130.95494028968include( '/vivo/developers.vivomiles.com/application/views/scripts/doc/method.phtml' ).../View.php:108
149.83204868960Model_Doc->buildParamsWebService( ).../method.phtml:341
159.83214874528Model_Doc->getSession( ).../Doc.php:468
169.83214875688Model_Doc->callWebService( ).../Doc.php:377
1710.02604901688Model_Doc->setSessionId( ).../Doc.php:364
https://api.vivoclass.com/Users.ping?

Error Codes:

This method does not return any errors

Method: Users.getUserTransactionsForDateRange

Available since API version 1.0

For the given date range, this method returns a list of user transactions.

Parameters:

Name Required Type Default Description
session_id Required string A valid web service session_id
date_from Required string The start date of the period being examined
date_to Required string The end date of the period being examined
num_transactions Optional int 10 The number of transactions for which data should be returned
offset Optional int The offset of the rows for paging

Response Parameters:

Name Description
transactions_id This is a Vivo generated globally unique ID of this transaction
transaction_date The date and time this transaction occurred (see dates)
reason_type The type of transaction (REWARD|PENALTY)
category The category of the transaction (set by organisation)
title The title of the transaction
description Additional optional information about the transaction
vivos_quantity The number Vivos being rewarded or penalised
users_id The Vivo ID of the user being rewarded or penalised
first_name The first or given name of the user being rewarded or penalised
last_name The last or surname of the user being rewarded or penalised
formatted_name The organisation’s preferred way of formatting this user’s name

Example Request (click to see example response):


( ! ) Notice: Undefined property: stdClass::$user_data in /vivo/developers.vivomiles.com/application/models/Doc.php on line 400
Call Stack
#TimeMemoryFunctionLocation
10.0000240624{main}( ).../index.php:0
20.01671405760Zend_Application->run( ).../index.php:36
30.01671405880Zend_Application_Bootstrap_Bootstrap->run( ).../Application.php:366
40.01681406712Zend_Controller_Front->dispatch( ).../Bootstrap.php:97
50.01711486048Zend_Controller_Dispatcher_Standard->dispatch( ).../Front.php:954
60.15662536736Zend_Controller_Action->dispatch( ).../Standard.php:289
70.93524009000Zend_Controller_Action_HelperBroker->notifyPostDispatch( ).../Action.php:523
80.93524010048Zend_Controller_Action_Helper_ViewRenderer->postDispatch( ).../HelperBroker.php:277
90.93524010368Zend_Controller_Action_Helper_ViewRenderer->render( ).../ViewRenderer.php:957
100.93544011344Zend_Controller_Action_Helper_ViewRenderer->renderScript( ).../ViewRenderer.php:918
110.93544011376Zend_View_Abstract->render( ).../ViewRenderer.php:897
120.95484027960Zend_View->_run( ).../Abstract.php:880
130.95494028968include( '/vivo/developers.vivomiles.com/application/views/scripts/doc/method.phtml' ).../View.php:108
1410.02744885168Model_Doc->buildParamsWebService( ).../method.phtml:341
1510.02754891184Model_Doc->getSession( ).../Doc.php:468
1610.02754892344Model_Doc->callWebService( ).../Doc.php:377
1710.22654929400Model_Doc->setSessionId( ).../Doc.php:364

( ! ) Notice: Trying to get property of non-object in /vivo/developers.vivomiles.com/application/models/Doc.php on line 400
Call Stack
#TimeMemoryFunctionLocation
10.0000240624{main}( ).../index.php:0
20.01671405760Zend_Application->run( ).../index.php:36
30.01671405880Zend_Application_Bootstrap_Bootstrap->run( ).../Application.php:366
40.01681406712Zend_Controller_Front->dispatch( ).../Bootstrap.php:97
50.01711486048Zend_Controller_Dispatcher_Standard->dispatch( ).../Front.php:954
60.15662536736Zend_Controller_Action->dispatch( ).../Standard.php:289
70.93524009000Zend_Controller_Action_HelperBroker->notifyPostDispatch( ).../Action.php:523
80.93524010048Zend_Controller_Action_Helper_ViewRenderer->postDispatch( ).../HelperBroker.php:277
90.93524010368Zend_Controller_Action_Helper_ViewRenderer->render( ).../ViewRenderer.php:957
100.93544011344Zend_Controller_Action_Helper_ViewRenderer->renderScript( ).../ViewRenderer.php:918
110.93544011376Zend_View_Abstract->render( ).../ViewRenderer.php:897
120.95484027960Zend_View->_run( ).../Abstract.php:880
130.95494028968include( '/vivo/developers.vivomiles.com/application/views/scripts/doc/method.phtml' ).../View.php:108
1410.02744885168Model_Doc->buildParamsWebService( ).../method.phtml:341
1510.02754891184Model_Doc->getSession( ).../Doc.php:468
1610.02754892344Model_Doc->callWebService( ).../Doc.php:377
1710.22654929400Model_Doc->setSessionId( ).../Doc.php:364
https://api.vivoclass.com/Users.getUserTransactionsForDateRange?date_from=4b43b0ae&date_to=4b43b0ae&num_transactions=30&offset=65

Error Codes:

3211

Method: Users.getRewardsTransactionsForDateRangeSummary

Available since API version 1.0

For the given date range, this method returns a list of the categories that a user can be awarded for and the quantity of awards made in that period.

Parameters:

Name Required Type Default Description
date_from Required string The start date of the period being examined
date_to Required string The end date of the period being examined
session_id Required string A valid web service session_id

Response Parameters:

Name Description
rewards_categories_id The internal id of the category returned
category The name of the category
num_transactions The quantity of awards for this category for this period.

Example Request (click to see example response):


( ! ) Notice: Undefined property: stdClass::$user_data in /vivo/developers.vivomiles.com/application/models/Doc.php on line 400
Call Stack
#TimeMemoryFunctionLocation
10.0000240624{main}( ).../index.php:0
20.01671405760Zend_Application->run( ).../index.php:36
30.01671405880Zend_Application_Bootstrap_Bootstrap->run( ).../Application.php:366
40.01681406712Zend_Controller_Front->dispatch( ).../Bootstrap.php:97
50.01711486048Zend_Controller_Dispatcher_Standard->dispatch( ).../Front.php:954
60.15662536736Zend_Controller_Action->dispatch( ).../Standard.php:289
70.93524009000Zend_Controller_Action_HelperBroker->notifyPostDispatch( ).../Action.php:523
80.93524010048Zend_Controller_Action_Helper_ViewRenderer->postDispatch( ).../HelperBroker.php:277
90.93524010368Zend_Controller_Action_Helper_ViewRenderer->render( ).../ViewRenderer.php:957
100.93544011344Zend_Controller_Action_Helper_ViewRenderer->renderScript( ).../ViewRenderer.php:918
110.93544011376Zend_View_Abstract->render( ).../ViewRenderer.php:897
120.95484027960Zend_View->_run( ).../Abstract.php:880
130.95494028968include( '/vivo/developers.vivomiles.com/application/views/scripts/doc/method.phtml' ).../View.php:108
1410.22854902304Model_Doc->buildParamsWebService( ).../method.phtml:341
1510.22864908576Model_Doc->getSession( ).../Doc.php:468
1610.22864909736Model_Doc->callWebService( ).../Doc.php:377
1710.42694939136Model_Doc->setSessionId( ).../Doc.php:364

( ! ) Notice: Trying to get property of non-object in /vivo/developers.vivomiles.com/application/models/Doc.php on line 400
Call Stack
#TimeMemoryFunctionLocation
10.0000240624{main}( ).../index.php:0
20.01671405760Zend_Application->run( ).../index.php:36
30.01671405880Zend_Application_Bootstrap_Bootstrap->run( ).../Application.php:366
40.01681406712Zend_Controller_Front->dispatch( ).../Bootstrap.php:97
50.01711486048Zend_Controller_Dispatcher_Standard->dispatch( ).../Front.php:954
60.15662536736Zend_Controller_Action->dispatch( ).../Standard.php:289
70.93524009000Zend_Controller_Action_HelperBroker->notifyPostDispatch( ).../Action.php:523
80.93524010048Zend_Controller_Action_Helper_ViewRenderer->postDispatch( ).../HelperBroker.php:277
90.93524010368Zend_Controller_Action_Helper_ViewRenderer->render( ).../ViewRenderer.php:957
100.93544011344Zend_Controller_Action_Helper_ViewRenderer->renderScript( ).../ViewRenderer.php:918
110.93544011376Zend_View_Abstract->render( ).../ViewRenderer.php:897
120.95484027960Zend_View->_run( ).../Abstract.php:880
130.95494028968include( '/vivo/developers.vivomiles.com/application/views/scripts/doc/method.phtml' ).../View.php:108
1410.22854902304Model_Doc->buildParamsWebService( ).../method.phtml:341
1510.22864908576Model_Doc->getSession( ).../Doc.php:468
1610.22864909736Model_Doc->callWebService( ).../Doc.php:377
1710.42694939136Model_Doc->setSessionId( ).../Doc.php:364
https://api.vivoclass.com/Users.getRewardsTransactionsForDateRangeSummary?date_from=4b43b0ae&date_to=4b43b0ae

Error Codes:

3211

Method: Users.getUserTransactionsSummaryForDateRange

Available since API version 1.0

For the given date range, this method returns a list of the total transactions that a user can be awarded for and the quantity of awards made in that period.

Parameters:

Name Required Type Default Description
date_from Required string The start date of the period being examined
date_to Required string The end date of the period being examined
session_id Required string A valid web service session_id
search Optional A search term to find a user

Response Parameters:

Name Description
users_id The internal id of the user returned
date_from The start date of the period being returned
date_to The end date of the period being returned
vivos The quantity of transactions for for this period.

Example Request (click to see example response):


( ! ) Notice: Undefined property: stdClass::$user_data in /vivo/developers.vivomiles.com/application/models/Doc.php on line 400
Call Stack
#TimeMemoryFunctionLocation
10.0000240624{main}( ).../index.php:0
20.01671405760Zend_Application->run( ).../index.php:36
30.01671405880Zend_Application_Bootstrap_Bootstrap->run( ).../Application.php:366
40.01681406712Zend_Controller_Front->dispatch( ).../Bootstrap.php:97
50.01711486048Zend_Controller_Dispatcher_Standard->dispatch( ).../Front.php:954
60.15662536736Zend_Controller_Action->dispatch( ).../Standard.php:289
70.93524009000Zend_Controller_Action_HelperBroker->notifyPostDispatch( ).../Action.php:523
80.93524010048Zend_Controller_Action_Helper_ViewRenderer->postDispatch( ).../HelperBroker.php:277
90.93524010368Zend_Controller_Action_Helper_ViewRenderer->render( ).../ViewRenderer.php:957
100.93544011344Zend_Controller_Action_Helper_ViewRenderer->renderScript( ).../ViewRenderer.php:918
110.93544011376Zend_View_Abstract->render( ).../ViewRenderer.php:897
120.95484027960Zend_View->_run( ).../Abstract.php:880
130.95494028968include( '/vivo/developers.vivomiles.com/application/views/scripts/doc/method.phtml' ).../View.php:108
1410.42824918784Model_Doc->buildParamsWebService( ).../method.phtml:341
1510.42844925144Model_Doc->getSession( ).../Doc.php:468
1610.42844926304Model_Doc->callWebService( ).../Doc.php:377
1710.62544957440Model_Doc->setSessionId( ).../Doc.php:364

( ! ) Notice: Trying to get property of non-object in /vivo/developers.vivomiles.com/application/models/Doc.php on line 400
Call Stack
#TimeMemoryFunctionLocation
10.0000240624{main}( ).../index.php:0
20.01671405760Zend_Application->run( ).../index.php:36
30.01671405880Zend_Application_Bootstrap_Bootstrap->run( ).../Application.php:366
40.01681406712Zend_Controller_Front->dispatch( ).../Bootstrap.php:97
50.01711486048Zend_Controller_Dispatcher_Standard->dispatch( ).../Front.php:954
60.15662536736Zend_Controller_Action->dispatch( ).../Standard.php:289
70.93524009000Zend_Controller_Action_HelperBroker->notifyPostDispatch( ).../Action.php:523
80.93524010048Zend_Controller_Action_Helper_ViewRenderer->postDispatch( ).../HelperBroker.php:277
90.93524010368Zend_Controller_Action_Helper_ViewRenderer->render( ).../ViewRenderer.php:957
100.93544011344Zend_Controller_Action_Helper_ViewRenderer->renderScript( ).../ViewRenderer.php:918
110.93544011376Zend_View_Abstract->render( ).../ViewRenderer.php:897
120.95484027960Zend_View->_run( ).../Abstract.php:880
130.95494028968include( '/vivo/developers.vivomiles.com/application/views/scripts/doc/method.phtml' ).../View.php:108
1410.42824918784Model_Doc->buildParamsWebService( ).../method.phtml:341
1510.42844925144Model_Doc->getSession( ).../Doc.php:468
1610.42844926304Model_Doc->callWebService( ).../Doc.php:377
1710.62544957440Model_Doc->setSessionId( ).../Doc.php:364
https://api.vivoclass.com/Users.getUserTransactionsSummaryForDateRange?date_from=4b43b0ae&date_to=4b43b0ae

Error Codes:

3211, 9999

Method: Users.getTransaction

Available since API version 2.1

Select a transaction by the given transaction id

Parameters:

Name Required Type Default Description
session_id Required string A currently active and valid webservice session id
transactions_id Required int The id of the transaction to select

Response Parameters:

Name Description
transactions_id The internal id of the transaction returned
users_id The user id of the student being rewarded
issuers_id The user id of the staff member who issued the reward
issuers_organisation_id The organisation id of the staff member who issued the reward
quantity The amount rewarded as part of this transaction
transaction_date The date and time the transaction occured
reason_type The key for the type of reard this was
reason_text The reason the staff member provided for giving the reward
award_category The reward category for this transaction
is_cancelled If the transaction has been cancelled

Example Request (click to see example response):


( ! ) Notice: Undefined property: stdClass::$user_data in /vivo/developers.vivomiles.com/application/models/Doc.php on line 400
Call Stack
#TimeMemoryFunctionLocation
10.0000240624{main}( ).../index.php:0
20.01671405760Zend_Application->run( ).../index.php:36
30.01671405880Zend_Application_Bootstrap_Bootstrap->run( ).../Application.php:366
40.01681406712Zend_Controller_Front->dispatch( ).../Bootstrap.php:97
50.01711486048Zend_Controller_Dispatcher_Standard->dispatch( ).../Front.php:954
60.15662536736Zend_Controller_Action->dispatch( ).../Standard.php:289
70.93524009000Zend_Controller_Action_HelperBroker->notifyPostDispatch( ).../Action.php:523
80.93524010048Zend_Controller_Action_Helper_ViewRenderer->postDispatch( ).../HelperBroker.php:277
90.93524010368Zend_Controller_Action_Helper_ViewRenderer->render( ).../ViewRenderer.php:957
100.93544011344Zend_Controller_Action_Helper_ViewRenderer->renderScript( ).../ViewRenderer.php:918
110.93544011376Zend_View_Abstract->render( ).../ViewRenderer.php:897
120.95484027960Zend_View->_run( ).../Abstract.php:880
130.95494028968include( '/vivo/developers.vivomiles.com/application/views/scripts/doc/method.phtml' ).../View.php:108
1410.62694935640Model_Doc->buildParamsWebService( ).../method.phtml:341
1510.62694941320Model_Doc->getSession( ).../Doc.php:468
1610.62694942480Model_Doc->callWebService( ).../Doc.php:377
1710.82554975240Model_Doc->setSessionId( ).../Doc.php:364

( ! ) Notice: Trying to get property of non-object in /vivo/developers.vivomiles.com/application/models/Doc.php on line 400
Call Stack
#TimeMemoryFunctionLocation
10.0000240624{main}( ).../index.php:0
20.01671405760Zend_Application->run( ).../index.php:36
30.01671405880Zend_Application_Bootstrap_Bootstrap->run( ).../Application.php:366
40.01681406712Zend_Controller_Front->dispatch( ).../Bootstrap.php:97
50.01711486048Zend_Controller_Dispatcher_Standard->dispatch( ).../Front.php:954
60.15662536736Zend_Controller_Action->dispatch( ).../Standard.php:289
70.93524009000Zend_Controller_Action_HelperBroker->notifyPostDispatch( ).../Action.php:523
80.93524010048Zend_Controller_Action_Helper_ViewRenderer->postDispatch( ).../HelperBroker.php:277
90.93524010368Zend_Controller_Action_Helper_ViewRenderer->render( ).../ViewRenderer.php:957
100.93544011344Zend_Controller_Action_Helper_ViewRenderer->renderScript( ).../ViewRenderer.php:918
110.93544011376Zend_View_Abstract->render( ).../ViewRenderer.php:897
120.95484027960Zend_View->_run( ).../Abstract.php:880
130.95494028968include( '/vivo/developers.vivomiles.com/application/views/scripts/doc/method.phtml' ).../View.php:108
1410.62694935640Model_Doc->buildParamsWebService( ).../method.phtml:341
1510.62694941320Model_Doc->getSession( ).../Doc.php:468
1610.62694942480Model_Doc->callWebService( ).../Doc.php:377
1710.82554975240Model_Doc->setSessionId( ).../Doc.php:364
https://api.vivoclass.com/Users.getTransaction?transactions_id=24

Error Codes:

This method does not return any errors

Method: Users.getExtraEarners

Available since API version 2.1

Get a list of all extra earners available to this user

Parameters:

Name Required Type Default Description
session_id Required string A currently active and valid webservice session id

Response Parameters:

Name Description
help_requests_id The internal id of the extra earner returned
title The title of the extra earner
miles Description of the reward amount
description The description of the extra earner
instructions The instructions of the extra earner
utitle The issuers title
sname The issuers surname

Example Request (click to see example response):


( ! ) Notice: Undefined property: stdClass::$user_data in /vivo/developers.vivomiles.com/application/models/Doc.php on line 400
Call Stack
#TimeMemoryFunctionLocation
10.0000240624{main}( ).../index.php:0
20.01671405760Zend_Application->run( ).../index.php:36
30.01671405880Zend_Application_Bootstrap_Bootstrap->run( ).../Application.php:366
40.01681406712Zend_Controller_Front->dispatch( ).../Bootstrap.php:97
50.01711486048Zend_Controller_Dispatcher_Standard->dispatch( ).../Front.php:954
60.15662536736Zend_Controller_Action->dispatch( ).../Standard.php:289
70.93524009000Zend_Controller_Action_HelperBroker->notifyPostDispatch( ).../Action.php:523
80.93524010048Zend_Controller_Action_Helper_ViewRenderer->postDispatch( ).../HelperBroker.php:277
90.93524010368Zend_Controller_Action_Helper_ViewRenderer->render( ).../ViewRenderer.php:957
100.93544011344Zend_Controller_Action_Helper_ViewRenderer->renderScript( ).../ViewRenderer.php:918
110.93544011376Zend_View_Abstract->render( ).../ViewRenderer.php:897
120.95484027960Zend_View->_run( ).../Abstract.php:880
130.95494028968include( '/vivo/developers.vivomiles.com/application/views/scripts/doc/method.phtml' ).../View.php:108
1410.82704951136Model_Doc->buildParamsWebService( ).../method.phtml:341
1510.82714956712Model_Doc->getSession( ).../Doc.php:468
1610.82714957872Model_Doc->callWebService( ).../Doc.php:377
1711.02554987408Model_Doc->setSessionId( ).../Doc.php:364

( ! ) Notice: Trying to get property of non-object in /vivo/developers.vivomiles.com/application/models/Doc.php on line 400
Call Stack
#TimeMemoryFunctionLocation
10.0000240624{main}( ).../index.php:0
20.01671405760Zend_Application->run( ).../index.php:36
30.01671405880Zend_Application_Bootstrap_Bootstrap->run( ).../Application.php:366
40.01681406712Zend_Controller_Front->dispatch( ).../Bootstrap.php:97
50.01711486048Zend_Controller_Dispatcher_Standard->dispatch( ).../Front.php:954
60.15662536736Zend_Controller_Action->dispatch( ).../Standard.php:289
70.93524009000Zend_Controller_Action_HelperBroker->notifyPostDispatch( ).../Action.php:523
80.93524010048Zend_Controller_Action_Helper_ViewRenderer->postDispatch( ).../HelperBroker.php:277
90.93524010368Zend_Controller_Action_Helper_ViewRenderer->render( ).../ViewRenderer.php:957
100.93544011344Zend_Controller_Action_Helper_ViewRenderer->renderScript( ).../ViewRenderer.php:918
110.93544011376Zend_View_Abstract->render( ).../ViewRenderer.php:897
120.95484027960Zend_View->_run( ).../Abstract.php:880
130.95494028968include( '/vivo/developers.vivomiles.com/application/views/scripts/doc/method.phtml' ).../View.php:108
1410.82704951136Model_Doc->buildParamsWebService( ).../method.phtml:341
1510.82714956712Model_Doc->getSession( ).../Doc.php:468
1610.82714957872Model_Doc->callWebService( ).../Doc.php:377
1711.02554987408Model_Doc->setSessionId( ).../Doc.php:364
https://api.vivoclass.com/Users.getExtraEarners?

Error Codes:

This method does not return any errors

Method: Users.getExtraEarner

Available since API version 2.1

Get an extra earners by its primary ID

Parameters:

Name Required Type Default Description
session_id Required string A currently active and valid webservice session id
help_requests_id Required int The id of the extra_earner to select

Response Parameters:

Name Description
help_requests_id The internal id of the extra earner returned
request_date The date the extra earner was created
title The title of the extra earner
miles Description of the reward amount
description The description of the extra earner
instructions The instructions of the extra earner
utitle The issuers title
sname The issuers surname

Example Request (click to see example response):


( ! ) Notice: Undefined property: stdClass::$user_data in /vivo/developers.vivomiles.com/application/models/Doc.php on line 400
Call Stack
#TimeMemoryFunctionLocation
10.0000240624{main}( ).../index.php:0
20.01671405760Zend_Application->run( ).../index.php:36
30.01671405880Zend_Application_Bootstrap_Bootstrap->run( ).../Application.php:366
40.01681406712Zend_Controller_Front->dispatch( ).../Bootstrap.php:97
50.01711486048Zend_Controller_Dispatcher_Standard->dispatch( ).../Front.php:954
60.15662536736Zend_Controller_Action->dispatch( ).../Standard.php:289
70.93524009000Zend_Controller_Action_HelperBroker->notifyPostDispatch( ).../Action.php:523
80.93524010048Zend_Controller_Action_Helper_ViewRenderer->postDispatch( ).../HelperBroker.php:277
90.93524010368Zend_Controller_Action_Helper_ViewRenderer->render( ).../ViewRenderer.php:957
100.93544011344Zend_Controller_Action_Helper_ViewRenderer->renderScript( ).../ViewRenderer.php:918
110.93544011376Zend_View_Abstract->render( ).../ViewRenderer.php:897
120.95484027960Zend_View->_run( ).../Abstract.php:880
130.95494028968include( '/vivo/developers.vivomiles.com/application/views/scripts/doc/method.phtml' ).../View.php:108
1411.02684967536Model_Doc->buildParamsWebService( ).../method.phtml:341
1511.02694973224Model_Doc->getSession( ).../Doc.php:468
1611.02694974384Model_Doc->callWebService( ).../Doc.php:377
1711.22575006080Model_Doc->setSessionId( ).../Doc.php:364

( ! ) Notice: Trying to get property of non-object in /vivo/developers.vivomiles.com/application/models/Doc.php on line 400
Call Stack
#TimeMemoryFunctionLocation
10.0000240624{main}( ).../index.php:0
20.01671405760Zend_Application->run( ).../index.php:36
30.01671405880Zend_Application_Bootstrap_Bootstrap->run( ).../Application.php:366
40.01681406712Zend_Controller_Front->dispatch( ).../Bootstrap.php:97
50.01711486048Zend_Controller_Dispatcher_Standard->dispatch( ).../Front.php:954
60.15662536736Zend_Controller_Action->dispatch( ).../Standard.php:289
70.93524009000Zend_Controller_Action_HelperBroker->notifyPostDispatch( ).../Action.php:523
80.93524010048Zend_Controller_Action_Helper_ViewRenderer->postDispatch( ).../HelperBroker.php:277
90.93524010368Zend_Controller_Action_Helper_ViewRenderer->render( ).../ViewRenderer.php:957
100.93544011344Zend_Controller_Action_Helper_ViewRenderer->renderScript( ).../ViewRenderer.php:918
110.93544011376Zend_View_Abstract->render( ).../ViewRenderer.php:897
120.95484027960Zend_View->_run( ).../Abstract.php:880
130.95494028968include( '/vivo/developers.vivomiles.com/application/views/scripts/doc/method.phtml' ).../View.php:108
1411.02684967536Model_Doc->buildParamsWebService( ).../method.phtml:341
1511.02694973224Model_Doc->getSession( ).../Doc.php:468
1611.02694974384Model_Doc->callWebService( ).../Doc.php:377
1711.22575006080Model_Doc->setSessionId( ).../Doc.php:364
https://api.vivoclass.com/Users.getExtraEarner?help_requests_id=94

Error Codes:

3011

Method: Users.registerForPushNotifications

Available since API version 2.1

Register user for push notifications

Parameters:

Name Required Type Default Description
session_id Required string A currently active and valid webservice session id
platform Required string Platform the app is running on (ANDROID, IOS)
token Required string Device token (for iOS) or Registration ID (for Android)

Response Parameters:

Name Description
status If no error occurred this will contain success

Example Request (click to see example response):


( ! ) Notice: Undefined property: stdClass::$user_data in /vivo/developers.vivomiles.com/application/models/Doc.php on line 400
Call Stack
#TimeMemoryFunctionLocation
10.0000240624{main}( ).../index.php:0
20.01671405760Zend_Application->run( ).../index.php:36
30.01671405880Zend_Application_Bootstrap_Bootstrap->run( ).../Application.php:366
40.01681406712Zend_Controller_Front->dispatch( ).../Bootstrap.php:97
50.01711486048Zend_Controller_Dispatcher_Standard->dispatch( ).../Front.php:954
60.15662536736Zend_Controller_Action->dispatch( ).../Standard.php:289
70.93524009000Zend_Controller_Action_HelperBroker->notifyPostDispatch( ).../Action.php:523
80.93524010048Zend_Controller_Action_Helper_ViewRenderer->postDispatch( ).../HelperBroker.php:277
90.93524010368Zend_Controller_Action_Helper_ViewRenderer->render( ).../ViewRenderer.php:957
100.93544011344Zend_Controller_Action_Helper_ViewRenderer->renderScript( ).../ViewRenderer.php:918
110.93544011376Zend_View_Abstract->render( ).../ViewRenderer.php:897
120.95484027960Zend_View->_run( ).../Abstract.php:880
130.95494028968include( '/vivo/developers.vivomiles.com/application/views/scripts/doc/method.phtml' ).../View.php:108
1411.22724984272Model_Doc->buildParamsWebService( ).../method.phtml:341
1511.22734990080Model_Doc->getSession( ).../Doc.php:468
1611.22734991240Model_Doc->callWebService( ).../Doc.php:377
1711.42315019192Model_Doc->setSessionId( ).../Doc.php:364

( ! ) Notice: Trying to get property of non-object in /vivo/developers.vivomiles.com/application/models/Doc.php on line 400
Call Stack
#TimeMemoryFunctionLocation
10.0000240624{main}( ).../index.php:0
20.01671405760Zend_Application->run( ).../index.php:36
30.01671405880Zend_Application_Bootstrap_Bootstrap->run( ).../Application.php:366
40.01681406712Zend_Controller_Front->dispatch( ).../Bootstrap.php:97
50.01711486048Zend_Controller_Dispatcher_Standard->dispatch( ).../Front.php:954
60.15662536736Zend_Controller_Action->dispatch( ).../Standard.php:289
70.93524009000Zend_Controller_Action_HelperBroker->notifyPostDispatch( ).../Action.php:523
80.93524010048Zend_Controller_Action_Helper_ViewRenderer->postDispatch( ).../HelperBroker.php:277
90.93524010368Zend_Controller_Action_Helper_ViewRenderer->render( ).../ViewRenderer.php:957
100.93544011344Zend_Controller_Action_Helper_ViewRenderer->renderScript( ).../ViewRenderer.php:918
110.93544011376Zend_View_Abstract->render( ).../ViewRenderer.php:897
120.95484027960Zend_View->_run( ).../Abstract.php:880
130.95494028968include( '/vivo/developers.vivomiles.com/application/views/scripts/doc/method.phtml' ).../View.php:108
1411.22724984272Model_Doc->buildParamsWebService( ).../method.phtml:341
1511.22734990080Model_Doc->getSession( ).../Doc.php:468
1611.22734991240Model_Doc->callWebService( ).../Doc.php:377
1711.42315019192Model_Doc->setSessionId( ).../Doc.php:364
https://api.vivoclass.com/Users.registerForPushNotifications?platform=4b43b0ae&token=4b43b0ae

Error Codes:

4001, 4002, 4003, 9999

Method: Users.unregisterForPushNotifications

Available since API version 2.1

Unregister user from push notifications

Parameters:

Name Required Type Default Description
session_id Required string A currently active and valid webservice session id
platform Required string Platform the app is running on (ANDROID, IOS)

Response Parameters:

Name Description
status If no error occurred this will contain success

Example Request (click to see example response):


( ! ) Notice: Undefined property: stdClass::$user_data in /vivo/developers.vivomiles.com/application/models/Doc.php on line 400
Call Stack
#TimeMemoryFunctionLocation
10.0000240624{main}( ).../index.php:0
20.01671405760Zend_Application->run( ).../index.php:36
30.01671405880Zend_Application_Bootstrap_Bootstrap->run( ).../Application.php:366
40.01681406712Zend_Controller_Front->dispatch( ).../Bootstrap.php:97
50.01711486048Zend_Controller_Dispatcher_Standard->dispatch( ).../Front.php:954
60.15662536736Zend_Controller_Action->dispatch( ).../Standard.php:289
70.93524009000Zend_Controller_Action_HelperBroker->notifyPostDispatch( ).../Action.php:523
80.93524010048Zend_Controller_Action_Helper_ViewRenderer->postDispatch( ).../HelperBroker.php:277
90.93524010368Zend_Controller_Action_Helper_ViewRenderer->render( ).../ViewRenderer.php:957
100.93544011344Zend_Controller_Action_Helper_ViewRenderer->renderScript( ).../ViewRenderer.php:918
110.93544011376Zend_View_Abstract->render( ).../ViewRenderer.php:897
120.95484027960Zend_View->_run( ).../Abstract.php:880
130.95494028968include( '/vivo/developers.vivomiles.com/application/views/scripts/doc/method.phtml' ).../View.php:108
1411.42475002096Model_Doc->buildParamsWebService( ).../method.phtml:341
1511.42475007808Model_Doc->getSession( ).../Doc.php:468
1611.42475008968Model_Doc->callWebService( ).../Doc.php:377
1711.61895036016Model_Doc->setSessionId( ).../Doc.php:364

( ! ) Notice: Trying to get property of non-object in /vivo/developers.vivomiles.com/application/models/Doc.php on line 400
Call Stack
#TimeMemoryFunctionLocation
10.0000240624{main}( ).../index.php:0
20.01671405760Zend_Application->run( ).../index.php:36
30.01671405880Zend_Application_Bootstrap_Bootstrap->run( ).../Application.php:366
40.01681406712Zend_Controller_Front->dispatch( ).../Bootstrap.php:97
50.01711486048Zend_Controller_Dispatcher_Standard->dispatch( ).../Front.php:954
60.15662536736Zend_Controller_Action->dispatch( ).../Standard.php:289
70.93524009000Zend_Controller_Action_HelperBroker->notifyPostDispatch( ).../Action.php:523
80.93524010048Zend_Controller_Action_Helper_ViewRenderer->postDispatch( ).../HelperBroker.php:277
90.93524010368Zend_Controller_Action_Helper_ViewRenderer->render( ).../ViewRenderer.php:957
100.93544011344Zend_Controller_Action_Helper_ViewRenderer->renderScript( ).../ViewRenderer.php:918
110.93544011376Zend_View_Abstract->render( ).../ViewRenderer.php:897
120.95484027960Zend_View->_run( ).../Abstract.php:880
130.95494028968include( '/vivo/developers.vivomiles.com/application/views/scripts/doc/method.phtml' ).../View.php:108
1411.42475002096Model_Doc->buildParamsWebService( ).../method.phtml:341
1511.42475007808Model_Doc->getSession( ).../Doc.php:468
1611.42475008968Model_Doc->callWebService( ).../Doc.php:377
1711.61895036016Model_Doc->setSessionId( ).../Doc.php:364
https://api.vivoclass.com/Users.unregisterForPushNotifications?platform=4b43b0ae

Error Codes:

9999

Method: Users.getScreenMessages

Available since API version 2.1

Get the current screen messages for the user

Parameters:

Name Required Type Default Description
session_id Required string A currently active and valid webservice session id

Response Parameters:

Name Description
id The message's ID
title The message's title (HTML format)
body The message's body (HTML format)

Example Request (click to see example response):


( ! ) Notice: Undefined property: stdClass::$user_data in /vivo/developers.vivomiles.com/application/models/Doc.php on line 400
Call Stack
#TimeMemoryFunctionLocation
10.0000240624{main}( ).../index.php:0
20.01671405760Zend_Application->run( ).../index.php:36
30.01671405880Zend_Application_Bootstrap_Bootstrap->run( ).../Application.php:366
40.01681406712Zend_Controller_Front->dispatch( ).../Bootstrap.php:97
50.01711486048Zend_Controller_Dispatcher_Standard->dispatch( ).../Front.php:954
60.15662536736Zend_Controller_Action->dispatch( ).../Standard.php:289
70.93524009000Zend_Controller_Action_HelperBroker->notifyPostDispatch( ).../Action.php:523
80.93524010048Zend_Controller_Action_Helper_ViewRenderer->postDispatch( ).../HelperBroker.php:277
90.93524010368Zend_Controller_Action_Helper_ViewRenderer->render( ).../ViewRenderer.php:957
100.93544011344Zend_Controller_Action_Helper_ViewRenderer->renderScript( ).../ViewRenderer.php:918
110.93544011376Zend_View_Abstract->render( ).../ViewRenderer.php:897
120.95484027960Zend_View->_run( ).../Abstract.php:880
130.95494028968include( '/vivo/developers.vivomiles.com/application/views/scripts/doc/method.phtml' ).../View.php:108
1411.62075017424Model_Doc->buildParamsWebService( ).../method.phtml:341
1511.62085023008Model_Doc->getSession( ).../Doc.php:468
1611.62085024168Model_Doc->callWebService( ).../Doc.php:377
1711.81685050680Model_Doc->setSessionId( ).../Doc.php:364

( ! ) Notice: Trying to get property of non-object in /vivo/developers.vivomiles.com/application/models/Doc.php on line 400
Call Stack
#TimeMemoryFunctionLocation
10.0000240624{main}( ).../index.php:0
20.01671405760Zend_Application->run( ).../index.php:36
30.01671405880Zend_Application_Bootstrap_Bootstrap->run( ).../Application.php:366
40.01681406712Zend_Controller_Front->dispatch( ).../Bootstrap.php:97
50.01711486048Zend_Controller_Dispatcher_Standard->dispatch( ).../Front.php:954
60.15662536736Zend_Controller_Action->dispatch( ).../Standard.php:289
70.93524009000Zend_Controller_Action_HelperBroker->notifyPostDispatch( ).../Action.php:523
80.93524010048Zend_Controller_Action_Helper_ViewRenderer->postDispatch( ).../HelperBroker.php:277
90.93524010368Zend_Controller_Action_Helper_ViewRenderer->render( ).../ViewRenderer.php:957
100.93544011344Zend_Controller_Action_Helper_ViewRenderer->renderScript( ).../ViewRenderer.php:918
110.93544011376Zend_View_Abstract->render( ).../ViewRenderer.php:897
120.95484027960Zend_View->_run( ).../Abstract.php:880
130.95494028968include( '/vivo/developers.vivomiles.com/application/views/scripts/doc/method.phtml' ).../View.php:108
1411.62075017424Model_Doc->buildParamsWebService( ).../method.phtml:341
1511.62085023008Model_Doc->getSession( ).../Doc.php:468
1611.62085024168Model_Doc->callWebService( ).../Doc.php:377
1711.81685050680Model_Doc->setSessionId( ).../Doc.php:364
https://api.vivoclass.com/Users.getScreenMessages?

Error Codes:

This method does not return any errors

Method: Users.updateProfile

Available since API version 2.1

Update user's profile details - makes call to Users_Manager to update both

Parameters:

Name Required Type Default Description
session_id Required string A currently active and valid webservice session id
email Optional string User's email address
mobile Optional string User's mobile number

Response Parameters:

Name Description
status If no error occurred this will contain success

Example Request (click to see example response):


( ! ) Notice: Undefined property: stdClass::$user_data in /vivo/developers.vivomiles.com/application/models/Doc.php on line 400
Call Stack
#TimeMemoryFunctionLocation
10.0000240624{main}( ).../index.php:0
20.01671405760Zend_Application->run( ).../index.php:36
30.01671405880Zend_Application_Bootstrap_Bootstrap->run( ).../Application.php:366
40.01681406712Zend_Controller_Front->dispatch( ).../Bootstrap.php:97
50.01711486048Zend_Controller_Dispatcher_Standard->dispatch( ).../Front.php:954
60.15662536736Zend_Controller_Action->dispatch( ).../Standard.php:289
70.93524009000Zend_Controller_Action_HelperBroker->notifyPostDispatch( ).../Action.php:523
80.93524010048Zend_Controller_Action_Helper_ViewRenderer->postDispatch( ).../HelperBroker.php:277
90.93524010368Zend_Controller_Action_Helper_ViewRenderer->render( ).../ViewRenderer.php:957
100.93544011344Zend_Controller_Action_Helper_ViewRenderer->renderScript( ).../ViewRenderer.php:918
110.93544011376Zend_View_Abstract->render( ).../ViewRenderer.php:897
120.95484027960Zend_View->_run( ).../Abstract.php:880
130.95494028968include( '/vivo/developers.vivomiles.com/application/views/scripts/doc/method.phtml' ).../View.php:108
1411.81815033200Model_Doc->buildParamsWebService( ).../method.phtml:341
1511.81825038968Model_Doc->getSession( ).../Doc.php:468
1611.81825040128Model_Doc->callWebService( ).../Doc.php:377
1712.01745068120Model_Doc->setSessionId( ).../Doc.php:364

( ! ) Notice: Trying to get property of non-object in /vivo/developers.vivomiles.com/application/models/Doc.php on line 400
Call Stack
#TimeMemoryFunctionLocation
10.0000240624{main}( ).../index.php:0
20.01671405760Zend_Application->run( ).../index.php:36
30.01671405880Zend_Application_Bootstrap_Bootstrap->run( ).../Application.php:366
40.01681406712Zend_Controller_Front->dispatch( ).../Bootstrap.php:97
50.01711486048Zend_Controller_Dispatcher_Standard->dispatch( ).../Front.php:954
60.15662536736Zend_Controller_Action->dispatch( ).../Standard.php:289
70.93524009000Zend_Controller_Action_HelperBroker->notifyPostDispatch( ).../Action.php:523
80.93524010048Zend_Controller_Action_Helper_ViewRenderer->postDispatch( ).../HelperBroker.php:277
90.93524010368Zend_Controller_Action_Helper_ViewRenderer->render( ).../ViewRenderer.php:957
100.93544011344Zend_Controller_Action_Helper_ViewRenderer->renderScript( ).../ViewRenderer.php:918
110.93544011376Zend_View_Abstract->render( ).../ViewRenderer.php:897
120.95484027960Zend_View->_run( ).../Abstract.php:880
130.95494028968include( '/vivo/developers.vivomiles.com/application/views/scripts/doc/method.phtml' ).../View.php:108
1411.81815033200Model_Doc->buildParamsWebService( ).../method.phtml:341
1511.81825038968Model_Doc->getSession( ).../Doc.php:468
1611.81825040128Model_Doc->callWebService( ).../Doc.php:377
1712.01745068120Model_Doc->setSessionId( ).../Doc.php:364
https://api.vivoclass.com/Users.updateProfile?

Error Codes:

1900, 1901, 9999

Method: Users.getSharedSecret

Available since API version 2.2

Generate shared secret key for the user

Parameters:

Name Required Type Default Description
session_id Required string A currently active and valid webservice session id

Response Parameters:

Name Description
sharedSecret md5 Shared secret key
timestamp integer representing the number of seconds since the UNIX epoch

Example Request (click to see example response):


( ! ) Notice: Undefined property: stdClass::$user_data in /vivo/developers.vivomiles.com/application/models/Doc.php on line 400
Call Stack
#TimeMemoryFunctionLocation
10.0000240624{main}( ).../index.php:0
20.01671405760Zend_Application->run( ).../index.php:36
30.01671405880Zend_Application_Bootstrap_Bootstrap->run( ).../Application.php:366
40.01681406712Zend_Controller_Front->dispatch( ).../Bootstrap.php:97
50.01711486048Zend_Controller_Dispatcher_Standard->dispatch( ).../Front.php:954
60.15662536736Zend_Controller_Action->dispatch( ).../Standard.php:289
70.93524009000Zend_Controller_Action_HelperBroker->notifyPostDispatch( ).../Action.php:523
80.93524010048Zend_Controller_Action_Helper_ViewRenderer->postDispatch( ).../HelperBroker.php:277
90.93524010368Zend_Controller_Action_Helper_ViewRenderer->render( ).../ViewRenderer.php:957
100.93544011344Zend_Controller_Action_Helper_ViewRenderer->renderScript( ).../ViewRenderer.php:918
110.93544011376Zend_View_Abstract->render( ).../ViewRenderer.php:897
120.95484027960Zend_View->_run( ).../Abstract.php:880
130.95494028968include( '/vivo/developers.vivomiles.com/application/views/scripts/doc/method.phtml' ).../View.php:108
1412.01915050944Model_Doc->buildParamsWebService( ).../method.phtml:341
1512.01925056520Model_Doc->getSession( ).../Doc.php:468
1612.01925057680Model_Doc->callWebService( ).../Doc.php:377
1712.21495083520Model_Doc->setSessionId( ).../Doc.php:364

( ! ) Notice: Trying to get property of non-object in /vivo/developers.vivomiles.com/application/models/Doc.php on line 400
Call Stack
#TimeMemoryFunctionLocation
10.0000240624{main}( ).../index.php:0
20.01671405760Zend_Application->run( ).../index.php:36
30.01671405880Zend_Application_Bootstrap_Bootstrap->run( ).../Application.php:366
40.01681406712Zend_Controller_Front->dispatch( ).../Bootstrap.php:97
50.01711486048Zend_Controller_Dispatcher_Standard->dispatch( ).../Front.php:954
60.15662536736Zend_Controller_Action->dispatch( ).../Standard.php:289
70.93524009000Zend_Controller_Action_HelperBroker->notifyPostDispatch( ).../Action.php:523
80.93524010048Zend_Controller_Action_Helper_ViewRenderer->postDispatch( ).../HelperBroker.php:277
90.93524010368Zend_Controller_Action_Helper_ViewRenderer->render( ).../ViewRenderer.php:957
100.93544011344Zend_Controller_Action_Helper_ViewRenderer->renderScript( ).../ViewRenderer.php:918
110.93544011376Zend_View_Abstract->render( ).../ViewRenderer.php:897
120.95484027960Zend_View->_run( ).../Abstract.php:880
130.95494028968include( '/vivo/developers.vivomiles.com/application/views/scripts/doc/method.phtml' ).../View.php:108
1412.01915050944Model_Doc->buildParamsWebService( ).../method.phtml:341
1512.01925056520Model_Doc->getSession( ).../Doc.php:468
1612.01925057680Model_Doc->callWebService( ).../Doc.php:377
1712.21495083520Model_Doc->setSessionId( ).../Doc.php:364
https://api.vivoclass.com/Users.getSharedSecret?

Error Codes:

This method does not return any errors

Method: Users.updatePassword

Available since API version 2.2

Update user's password

Parameters:

Name Required Type Default Description
session_id Required string A currently active and valid webservice session id
password Required string User's password

Response Parameters:

Name Description
status If no error occurred this will contain success

Example Request (click to see example response):


( ! ) Notice: Undefined property: stdClass::$user_data in /vivo/developers.vivomiles.com/application/models/Doc.php on line 400
Call Stack
#TimeMemoryFunctionLocation
10.0000240624{main}( ).../index.php:0
20.01671405760Zend_Application->run( ).../index.php:36
30.01671405880Zend_Application_Bootstrap_Bootstrap->run( ).../Application.php:366
40.01681406712Zend_Controller_Front->dispatch( ).../Bootstrap.php:97
50.01711486048Zend_Controller_Dispatcher_Standard->dispatch( ).../Front.php:954
60.15662536736Zend_Controller_Action->dispatch( ).../Standard.php:289
70.93524009000Zend_Controller_Action_HelperBroker->notifyPostDispatch( ).../Action.php:523
80.93524010048Zend_Controller_Action_Helper_ViewRenderer->postDispatch( ).../HelperBroker.php:277
90.93524010368Zend_Controller_Action_Helper_ViewRenderer->render( ).../ViewRenderer.php:957
100.93544011344Zend_Controller_Action_Helper_ViewRenderer->renderScript( ).../ViewRenderer.php:918
110.93544011376Zend_View_Abstract->render( ).../ViewRenderer.php:897
120.95484027960Zend_View->_run( ).../Abstract.php:880
130.95494028968include( '/vivo/developers.vivomiles.com/application/views/scripts/doc/method.phtml' ).../View.php:108
1412.21635065872Model_Doc->buildParamsWebService( ).../method.phtml:341
1512.21645071552Model_Doc->getSession( ).../Doc.php:468
1612.21645072712Model_Doc->callWebService( ).../Doc.php:377
1712.41115099624Model_Doc->setSessionId( ).../Doc.php:364

( ! ) Notice: Trying to get property of non-object in /vivo/developers.vivomiles.com/application/models/Doc.php on line 400
Call Stack
#TimeMemoryFunctionLocation
10.0000240624{main}( ).../index.php:0
20.01671405760Zend_Application->run( ).../index.php:36
30.01671405880Zend_Application_Bootstrap_Bootstrap->run( ).../Application.php:366
40.01681406712Zend_Controller_Front->dispatch( ).../Bootstrap.php:97
50.01711486048Zend_Controller_Dispatcher_Standard->dispatch( ).../Front.php:954
60.15662536736Zend_Controller_Action->dispatch( ).../Standard.php:289
70.93524009000Zend_Controller_Action_HelperBroker->notifyPostDispatch( ).../Action.php:523
80.93524010048Zend_Controller_Action_Helper_ViewRenderer->postDispatch( ).../HelperBroker.php:277
90.93524010368Zend_Controller_Action_Helper_ViewRenderer->render( ).../ViewRenderer.php:957
100.93544011344Zend_Controller_Action_Helper_ViewRenderer->renderScript( ).../ViewRenderer.php:918
110.93544011376Zend_View_Abstract->render( ).../ViewRenderer.php:897
120.95484027960Zend_View->_run( ).../Abstract.php:880
130.95494028968include( '/vivo/developers.vivomiles.com/application/views/scripts/doc/method.phtml' ).../View.php:108
1412.21635065872Model_Doc->buildParamsWebService( ).../method.phtml:341
1512.21645071552Model_Doc->getSession( ).../Doc.php:468
1612.21645072712Model_Doc->callWebService( ).../Doc.php:377
1712.41115099624Model_Doc->setSessionId( ).../Doc.php:364
https://api.vivoclass.com/Users.updatePassword?password=4b43b0ae

Error Codes:

3011, 9999

Method: Users.getUserSmsPreference

Available since API version 2.2

Get the User's current SMS updates preference setting

Parameters:

Name Required Type Default Description
session_id Required string A currently active and valid webservice session id

Response Parameters:

Name Description
result Result of the operation
md_sms_receive String YES/NO containing the value of the user's sms updates preference setting

Example Request (click to see example response):


( ! ) Notice: Undefined property: stdClass::$user_data in /vivo/developers.vivomiles.com/application/models/Doc.php on line 400
Call Stack
#TimeMemoryFunctionLocation
10.0000240624{main}( ).../index.php:0
20.01671405760Zend_Application->run( ).../index.php:36
30.01671405880Zend_Application_Bootstrap_Bootstrap->run( ).../Application.php:366
40.01681406712Zend_Controller_Front->dispatch( ).../Bootstrap.php:97
50.01711486048Zend_Controller_Dispatcher_Standard->dispatch( ).../Front.php:954
60.15662536736Zend_Controller_Action->dispatch( ).../Standard.php:289
70.93524009000Zend_Controller_Action_HelperBroker->notifyPostDispatch( ).../Action.php:523
80.93524010048Zend_Controller_Action_Helper_ViewRenderer->postDispatch( ).../HelperBroker.php:277
90.93524010368Zend_Controller_Action_Helper_ViewRenderer->render( ).../ViewRenderer.php:957
100.93544011344Zend_Controller_Action_Helper_ViewRenderer->renderScript( ).../ViewRenderer.php:918
110.93544011376Zend_View_Abstract->render( ).../ViewRenderer.php:897
120.95484027960Zend_View->_run( ).../Abstract.php:880
130.95494028968include( '/vivo/developers.vivomiles.com/application/views/scripts/doc/method.phtml' ).../View.php:108
1412.41265082936Model_Doc->buildParamsWebService( ).../method.phtml:341
1512.41275088528Model_Doc->getSession( ).../Doc.php:468
1612.41275089688Model_Doc->callWebService( ).../Doc.php:377
1712.60915115952Model_Doc->setSessionId( ).../Doc.php:364

( ! ) Notice: Trying to get property of non-object in /vivo/developers.vivomiles.com/application/models/Doc.php on line 400
Call Stack
#TimeMemoryFunctionLocation
10.0000240624{main}( ).../index.php:0
20.01671405760Zend_Application->run( ).../index.php:36
30.01671405880Zend_Application_Bootstrap_Bootstrap->run( ).../Application.php:366
40.01681406712Zend_Controller_Front->dispatch( ).../Bootstrap.php:97
50.01711486048Zend_Controller_Dispatcher_Standard->dispatch( ).../Front.php:954
60.15662536736Zend_Controller_Action->dispatch( ).../Standard.php:289
70.93524009000Zend_Controller_Action_HelperBroker->notifyPostDispatch( ).../Action.php:523
80.93524010048Zend_Controller_Action_Helper_ViewRenderer->postDispatch( ).../HelperBroker.php:277
90.93524010368Zend_Controller_Action_Helper_ViewRenderer->render( ).../ViewRenderer.php:957
100.93544011344Zend_Controller_Action_Helper_ViewRenderer->renderScript( ).../ViewRenderer.php:918
110.93544011376Zend_View_Abstract->render( ).../ViewRenderer.php:897
120.95484027960Zend_View->_run( ).../Abstract.php:880
130.95494028968include( '/vivo/developers.vivomiles.com/application/views/scripts/doc/method.phtml' ).../View.php:108
1412.41265082936Model_Doc->buildParamsWebService( ).../method.phtml:341
1512.41275088528Model_Doc->getSession( ).../Doc.php:468
1612.41275089688Model_Doc->callWebService( ).../Doc.php:377
1712.60915115952Model_Doc->setSessionId( ).../Doc.php:364
https://api.vivoclass.com/Users.getUserSmsPreference?

Error Codes:

9999

Method: Users.updateUserSmsPreference

Available since API version 2.2

Updates User's SMS preference setting

Parameters:

Name Required Type Default Description
session_id Required string A currently active and valid webservice session id
sms_updates_preference Required string The value of the new SMS update preference setting

Response Parameters:

Name Description
result Success, unless exception is thrown

Example Request (click to see example response):


( ! ) Notice: Undefined property: stdClass::$user_data in /vivo/developers.vivomiles.com/application/models/Doc.php on line 400
Call Stack
#TimeMemoryFunctionLocation
10.0000240624{main}( ).../index.php:0
20.01671405760Zend_Application->run( ).../index.php:36
30.01671405880Zend_Application_Bootstrap_Bootstrap->run( ).../Application.php:366
40.01