Loading...
 

Xeerpa Enterprise CRM API

Endpoint: api/user/details 

Method
GET
Description
Returns the basic details for a user
Input Parameters
  • clientId
  • clientPwd
  • userId
Result
userId
User’s Xeerpa id (Varchar)
date
Creation date (Datetime)
modified
Last modification date (Datetime)
name
User’s name (Varchar)
surname
Surname(s) (Varchar)
gender
Gender (Varchar, ‘m’:male, ‘f’: female)
emails
Email (Varchar)
birthday
Birthday date (Datetime)
bornIn
Place of birth (Varchar)
friendsCount
Number of friends (Number)
locName
Current location (Varchar)
locLocale
Current Locale(Varchar)
socialScore
Social influence score (Float)
promotionalScore
Promotional score (Float)
fbId
Facebook id (Varchar)
twId
Twitter id (Varchar)
goId
Google id (Varchar)
fsId
FourSquare id (Varchar)
liId
LinkedIn id (Varchar)
robinson
Robinson (boolean). True: Does not accept communications
languages
Languages that the user speaks (array of Varchar)
brands:
User Brands and scores (Array of JSON Objects)
   brandName
Name of Brand (Varchar)
   engagementScore
Engagement score (Float)
   fanValue
Fan Value (Float)
   apps:
Xeerpa apps in which the user has taken part
      name
Name of app (Varchar)
      date
date
cats:
Name and value (0 to 10) for each category (Array of JSON Objects)
   name
Name of category (Varchar)
   value
value (0 to 10) (Float)

     

Endpoint: api/user/external

Method
GET
Description
Returns the external data of a user
Input Parameters
  • clientId
  • clientPwd
  • userId
  • idData: Tag to get. If not specified will return all data
Result
  • JSON object with the external data, in the format {‘name’:value}

     

Endpoint: api/user/remove

Method
GET
Description
Delete user and all related data
Input Parameters
  • clientId
  • clientPwd
  • userId
Result
  • Whether the request was successful or not (0 or above is successful, negative is error)

     

Endpoint: api/user/isRobinson

Method
GET
Description
Get if the user is a Robinson
Input Parameters
  • clientId
  • clientPwd
  • userId
Result
  • robinson
    • true: Does not accept communications, false: Accept communications