VNP Output Webservices - Users
WS Output Update User
"UpdateUser.jsp" is an output VirtualNewspaper webservice, to communicate to any external system any change that has took place on an user account inside Virtualnewspaper. This webservice sends a call every time any user details are updated on Virtualnewspaper. A complete set of user informations is always transmitted, even if only few fields have been updated.
How to invoke this webservice
VirtualNewspaper will make this POST call to an external webservice, providing a complete set of informations coming out from any user that has been updated on VirtualNewspaper.
Warning:
This POST call will be url encoded
Webservice url
Any external platform needs to provide a proper webservice url, allowing VirtualNewspaper to make its own call.
Parameters
VirtualNewspaper will transmit a complete parameters set, even if only few of them have been updated by the end user. Any external platform needs to be ready to collect and store informations arriving from VirtualNewspaper.
Example
Parameters will be provided using this syntax:
email=g.lopresti%40virtualcom.it&company=Virtualcom&dateJoin=2013-06-20&town=Kuala+Lumpur&ecc...
A different call will take place for every user in need of update.
Parameters and their values, will be separated by the "equal to" char ("=").
After each parameter/value an "&" char is provided.
Webservice reply
Two different replies are expected by VirtualNewspaper :
01) User account has been found and his infos have been updated .
In this scenario a JSON reply will look like this :
{
“updated” : “1”,
}
02) User account has not been found or something went wrong.
In this scenario a JSON reply will look like this :
{
“updated” : “0”
"reason" : "user not found"
}
PARAMETERS REFERENCE TABLE
| PARAMETER NAME | VALUE FORMAT | DESCRIPTION | EXAMPLE |
|---|---|---|---|
| externalId | varchar(255) | External platform unique user id provided during the registration process | externalId=H12CHF |
| varchar(255) | Contains the email the user provided in the Registration Form | ||
| password | mediumtext | Contains the password the user provided in the Registration Form | |
| address | mediumtext |  | |
| administrative_area_level_1 | varchar(200) | ||
| administrative_area_level_1_company | varchar(200) | ||
| administrative_area_level_2 | varchar(200) |  | |
| administrative_area_level_2_company | varchar(200) |  | |
| administrative_area_level_3 | varchar(200) | ||
| administrative_area_level_3_company | varchar(200) | ||
| born | date | ||
| birthPlace | varchar(300) | ||
| category | varchar(255) | ||
| city | mediumtext | ||
| citycode | varchar(255) | ||
| citycode_company | varchar(255) | ||
| code | varchar(50) | ||
| company | String | ||
| companyAddress | varchar(255) | ||
| companyCity | varchar(255) | ||
| companyFax | varchar(255) | ||
| companyLat | varchar(50) |  | |
| companyLng | varchar(50) |  | |
| companyNation | varchar(255) | ||
| companyTaxCode | String | ||
| companyTelephone | varchar(255) | ||
| companyTown | varchar(255) | ||
| companyVAT | String | ||
| companyZip | String | ||
| custom1 | varchar(300) | ||
| custom2 | varchar(300) | ||
| custom3 | varchar(300) | ||
| custom4 | varchar(300) | ||
| custom5 | varchar(300) | ||
| custom6 | varchar(300) | ||
| custom7 | varchar(300) | ||
| custom8 | varchar(300) | ||
| custom9 | varchar(300) | ||
| custom10 | varchar(300) | ||
| dateJoin | date | ||
| delete | tinyint(1) | If set to 1, user account will be invisible in VirtualNewspaper back-end | |
| fax | mediumtext | ||
| formatted_address | varchar(500) |  | |
| formatted_address_company | varchar(500) |  | |
| gender | varchar(30) | ||
| id | int(11) | ||
| income | String | ||
| work | String | ||
| lat | varchar(50) |  | |
| lng | varchar(50) |  | |
| mobile | varchar(50) | ||
| name | mediumtext | ||
| nation | mediumtext | ||
| newsletter | int(11) | ||
| surname | mediumtext | ||
| taxCode | String | ||
| telephone | mediumtext | ||
| town | mediumtext | ||
| type | varchar(255) | ||
| username | mediumtext | ||
| zip | String | ||
| encryptedPassword | String | ||
| delete | tinyint(1) | ||
| version | int fixed | FIXED VALUE = 2 | can be ignored |
21/12/2015
15/02/2017