VNP Output Webservices - Users
WS Output User Registration
"UserRegistrationOutput.jsp" is a VirtualNewspaper output webservice to transmit newly registered user informations to any external platform. Any external platform needs to reply with a transaction result, providing its own internal user ID upon a successful user registration. Each time a new user is registered on VirtualNewspaper, user informations are transmitted to the external platform. The external platform stores user informations inside its own internal database.
How to invoke this webservice
Each time a new user is registered, VirtualNewspaper will call any external platform. A complete set of user informations is transmitted to any external platform.
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 compiled 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...
If during the registration process, the end user will not fill a particular field, this one will be provided using a "default value" defined within VirtualNewspaper.
A different call will take place for every newly registered user account.
Parameters and their values, will be separated by the "equal to" char ("=").
After each parameter/value an "&" char is provided.
Webservice reply
Any external platform, once datas will be collected, will need to reply providing its own internal user ID.
Two different replies are expected by VirtualNewspaper :
01) User account has been succesfully created, and this is the user ID stored on the external platform.
In this scenario a JSON reply will look like this :
{
"status": “OK”
"externalId: “23513”
}
VirtualNewspaper will link the user ID provided by any external platform to its own internal user account ID.
02) Something went wrong and user has not been registered.
In this scenario a JSON reply will look like this :
{
“status”:“KO”
}
PARAMETERS REFERENCE TABLE
| PARAMETER NAME | VALUE FORMAT | DESCRIPTION | EXAMPLE |
|---|---|---|---|
| customerId | string | user ID as stored on the external platform | |
| varchar(255) | user email address | ||
| password | mediumtext | password as typed by end user | |
| 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 | ||
| externalId | varchar(100) | ||
| fax | mediumtext | ||
| formatted_address | |||
| formatted_address_company | |||
| gender | varchar(30) | ||
| id | int(11) | Internal unique user identifier | |
| income | string | ||
| work | string | ||
| lat | varchar(50) | ||
| lng | varchar(50) | ||
| name | mediumtext | ||
| nation | mediumtext | ||
| newsletter | int(11) | ||
| surname | mediumtext | ||
| taxCode | string | ||
| telephone | mediumtext | ||
| town | mediumtext | ||
| type | varchar(255) | ||
| username | mediumtext | ||
| zip | string | ||
| version | int fixed | Fixed value = 2 | can be ignored |
21/12/2015
15/02/2017