MyLivePage Inc / Pages / General / XML-RPC Interface

Interface URL: http://en.mylivepage.com/mylivepage-rpc?_type=xml

General

Every MyLivePage interface method gets one struct as a parameter and also returns a struct value. Most methods require client authentication. This means that the incoming parameter should contain auth_name field and one of three fields: auth_password, auth_hpassword, or auth_session

Client Authentication

Client authentication used to restrict access to MyLivePage XML-RPC Interface. It is realized with passing username/password to every XML-RPC request.
It is allowed to pass one of following sets of fields:

auth_name, auth_password
auth_name, auth_hpassword
auth_name, auth_session

where auth_name - registered username (examples: user.mylivepage.com, partner.domain.com),
auth_password - password of the user,
auth_hpassword - md5 of password,
auth_session - session ID that can be received through User Authentication
Following authorization procedure used in case a method requires reading/writing user data:

if the client is a normal user then he can manipulate only his data
if the client is a partner then he can manipulate only his user's data (including himself)

'authentication failed' error will be sent back in case wrong authentication data passed.

User Authentication

User Authentication used in order to synchronize login/logout actions on MyLivePage Sites and Partner Sites. MyLivePage engine manages user authentication via sessions. This involves 3-stage process:

Login using username and password. Clients should call MLP.XMLRPC.create_user_session, pass username/password and get session ID.
Checking whether session ID is correct using MLP.XMLRPC.get_user_session
Logout using MLP.XMLRPC.destroy_user_session

TODO example

MLP.XMLRPC.create_user_session

Authenticates user via username/password and creates user session. This method requires client authentication (see Client Authentication).

Arguments

[struct]

username string (mandatory)
password string
hpassword string: md5 of password

Either password or hpassword field has to be set.

Return Value

[struct]

status boolean: true if login was successful or false elsewhere
session string: session ID, set only if login was successful

MLP.XMLRPC.get_user_session

Authenticates user session. It checks whether passed session ID is valid. This method requires client authentication (see Client Authentication).

Arguments

[struct]

username string (mandatory)
session string (mandatory): session ID to check

Return Value

[struct]

status boolean: true if session ID is correct or false elsewhere

MLP.XMLRPC.destroy_user_session

Session logout. This method requires client authentication (see Client Authentication).

Arguments

[struct]

username string (mandatory)
session string (mandatory): session ID to check

Return Value

[struct]

status boolean: true if logout was successful or false elsewhere

Registration/Statistic methods

MLP.XMLRPC.register_user

Registers new user. Only partners can register new users, so authorization as a partner required (see Client Authentication).
Either password or hpassword has to be specified.

Arguments

[struct]

username string (mandatory)
email string (mandatory) - has to be a correct email address
activate boolean (mandatory) - make account active if true
lang string (mandatory)
password string
hpassword string
dating_searchable boolean (optional), default: true - participate in dating search

Return Value

[struct]

status boolean: true if registration was successful or false elsewhere

MLP.XMLRPC.get_user_profile

Returns some user properties from About page. This method requires client authentication (see Client Authentication).

Arguments

[struct]

username string (mandatory)

Return Value

[struct]

community boolean
rating int: 0 - participate, 1 - not participate, 2 - adult site (not participate)
gmt int: GMT timezone
template int
style int
display_name string
lang string
realname string
realsurename string
sign string
keywords string
icq string
aol string
yahoo string
msn string
nationality string
job string
about string
country string (deprecated)
city string (deprecated)
region string (deprecated)
postalcode string
geo_country_id string
geo_region_id string
geo_city_id int
city_other string
interests array: array of strings
dating_searchable boolean
dating_sex string
birthday dateTime.iso8601
dating_height string
dating_weight string
dating_constitution string
dating_hair string
dating_study string
dating_finance string
dating_residing string
dating_marriage string
dating_children string
dating_smoking string
dating_alcohol string
dating_drugs string
dating_aim struct
dating_description string

MLP.XMLRPC.change_user_profile

Change some user properties from About page. This method requires client authentication (see Client Authentication).

Arguments

[struct]

username string (mandatory)
community boolean
rating int: 0 - participate, 1 - not participate, 2 - adult site (not participate)
gmt int: GMT timezone
template int
style int
display_name string
lang string
realname string
realsurename string
sign string
keywords string
icq string
aol string
yahoo string
msn string
nationality string
job string
about string
country string (deprecated)
city string (deprecated)
region string (deprecated)
postalcode string
geo_country_id string - country code
geo_region_id string - region code
geo_city_id int - city id
city_other string
interests array: array of strings
dating_searchable boolean
dating_sex string
birthday dateTime.iso8601
dating_height string
dating_weight string
dating_constitution string
dating_hair string
dating_study string
dating_finance string
dating_residing string
dating_marriage string
dating_children string
dating_smoking string
dating_alcohol string
dating_drugs string
dating_aim struct
dating_description string

Omitted fields will remain unchanged.
Pass geo_country_id,geo_region_id,geo_city_id,city_other to define user location.
See also get_countries, get_regions, get_cities.

Return Value

[struct]

status boolean: true if change was successful or false elsewhere

MLP.XMLRPC.get_countries

Get list of countries. This method requires client authentication (see Client Authentication)

Arguments

[struct]

lang string - default 'en'

Return Value

[struct]

countries array of structs
- code string
- name string

MLP.XMLRPC.get_regions

Get list of regions. This method requires client authentication (see Client Authentication)

Arguments

[struct]

geo_country_id string (mandatory) - country code
lang string - default 'en'

Return Value

[struct]

regions array of structs
- region string - region code
- name string

MLP.XMLRPC.get_cities

Get list of cities. This method requires client authentication (see Client Authentication)

Arguments

[struct]

geo_country_id string (mandatory) - country code
geo_region_id string (mandatory) - region code
lang string - default 'en'

Return Value

[struct]

cities array of structs
- id int
- name string

Structure of Fields

Structure of Dating Fields

Possible values (constants) of some dating fields:

dating_sex: UNDEFINED, MALE, FEMALE
dating_constitution: UNDEFINED, THIN, NORMAL, SPORTS, MUSCULAR, WELL-BUILT, PLUMP
dating_hair: UNDEFINED, LIGHT, DARK, RED, DYED, BRIGHT, GREY
dating_study: UNDEFINED, NONE, SCHOOL_STUDENT, SECONDARY, SPECIALIZED_SECONDARY_EDUCATION, UNIVERSITY_STUDENT, INCOMPLETE_HIGHER, HIGHER, HAVE_A_PHD
dating_finance: UNDEFINED, LIVE_OFF_PARENTS, DONT_WORK, VARIABLE_INCOME, STABLE_SMALL_INCOME, STABLE_AVERAGE_INCOME, HIGH_INCOME
dating_residing: UNDEFINED, SEPARATE_APPARTMENT, DORMITORY_SHARED_APPARTMENT_HOUSE, LIVE_WITH_PARENTS, LIVE_WITH_GIRLFRIEND_BOYFRIEND, LIVE_WITH_SPOUSE_PARTNER, NO_PERMANENT_RESIDENCE
dating_marriage: UNDEFINED, YES_LIVE_TOGETHER, YES_LIVE_SEPARATELY, YES_MARRIAGE_FOR_IMAGE, NO
dating_children: UNDEFINED, NO, NO_BUT_WILLING_TO_HAVE, YES_LIVE_TOGETHER, YES_LIVE_SEPARATELY
dating_smoking: UNDEFINED, NO, TRYING_TO_QUIT, RARELY, FREQUENTLY
dating_alcohol: UNDEFINED, DONT_DRINK, DRINK_SOCIALLY, DRINK_FREQUENTLY
dating_drugs: UNDEFINED, NEVER_TRIED, FIND_DRUGS_UNACCEPTABLE, SOMETIMES_SMOKE_WEED, TAKE_SOFT, TAKE_HARD, TRYING_TO_QUIT, I_RECOVER_ON_NA, NOT_ANYMORE

dating_aim is a structure with following fields that take boolean values:

MAKE_FRIENDS_AND_CHAT
FIND_PENPAL
LOVER_SERIOUS_RELATIONSHIP
MARRIAGE_CREATION_OF_FAMILY
BIRTH_EDUCATION_OF_THE_CHILD
MARRIAGE_FOR_IMAGE
MARRIAGE_FOR_IMMIGRATION
SPORT_ACTIVE_RECREATION
SHARED_RENT
REGULAR_SEX_TOGETHER
ONE_TIME_SEX_PARTNER
GROUP_SEX
VIRTUAL_SEX
OFFER_X_SERVICES
SEARCH_FOR_X_SERVICES

Possible Languages

en, ru, cz, il, gr, my, ua, de, lt, fr, bg, cn, ee, es, sq, nl, sk

Possible Countries

AD (Andorra)
AE (United Arab Emirates)
AF (Afghanistan)
AG (Antigua and Barbuda)
AI (Anguilla)
AL (Albania)
AM (Armenia)
AN (Netherlands Antilles)
AO (Angola)
AQ (Antarctica)
AR (Argentina)
AS (American Samoa)
AT (Austria)
AU (Australia)
AW (Aruba)
AX (Aland Islands)
AZ (Azerbaijan)
BA (Bosnia and Herzegovina)
BB (Barbados)
BD (Bangladesh)
BE (Belgium)
BF (Burkina Faso)
BG (Bulgaria)
BH (Bahrain)
BI (Burundi)
BJ (Benin)
BM (Bermuda)
BN (Brunei)
BO (Bolivia)
BR (Brazil)
BS (Bahamas)
BT (Bhutan)
BV (Bouvet Island)
BW (Botswana)
BY (Belarus)
BZ (Belize)
CA (Canada)
CC (Cocos (Keeling) Islands)
CD (Congo (Kinshasa))
CF (Central African Republic)
CG (Congo (Brazzaville))
CH (Switzerland)
CI (Ivory Coast)
CK (Cook Islands)
CL (Chile)
CM (Cameroon)
CN (China)
CO (Colombia)
CR (Costa Rica)
CS (Serbia And Montenegro)
CU (Cuba)
CV (Cape Verde)
CX (Christmas Island)
CY (Cyprus)
CZ (Czech Republic)
DE (Germany)
DJ (Djibouti)
DK (Denmark)
DM (Dominica)
DO (Dominican Republic)
DZ (Algeria)
EC (Ecuador)
EE (Estonia)
EG (Egypt)
EH (Western Sahara)
ER (Eritrea)
ES (Spain)
ET (Ethiopia)
FI (Finland)
FJ (Fiji)
FK (Falkland Islands)
FM (Micronesia)
FO (Faroe Islands)
FR (France)
GA (Gabon)
GB (United Kingdom)
GD (Grenada)
GE (Georgia)
GF (French Guiana)
GG (Guernsey)
GH (Ghana)
GI (Gibraltar)
GL (Greenland)
GM (Gambia)
GN (Guinea)
GP (Guadeloupe)
GQ (Equatorial Guinea)
GR (Greece)
GS (South Georgia and the South Sandwich Islands)
GT (Guatemala)
GU (Guam)
GW (Guinea-Bissau)
GY (Guyana)
HK (Hong Kong S.A.R., China)
HM (Heard Island and McDonald Islands)
HN (Honduras)
HR (Croatia)
HT (Haiti)
HU (Hungary)
ID (Indonesia)
IE (Ireland)
IL (Israel)
IM (Isle of Man)
IN (India)
IO (British Indian Ocean Territory)
IQ (Iraq)
IR (Iran)
IS (Iceland)
IT (Italy)
JE (Jersey)
JM (Jamaica)
JO (Jordan)
JP (Japan)
KE (Kenya)
KG (Kyrgyzstan)
KH (Cambodia)
KI (Kiribati)
KM (Comoros)
KN (Saint Kitts and Nevis)
KP (North Korea)
KR (South Korea)
KW (Kuwait)
KY (Cayman Islands)
KZ (Kazakhstan)
LA (Laos)
LB (Lebanon)
LC (Saint Lucia)
LI (Liechtenstein)
LK (Sri Lanka)
LR (Liberia)
LS (Lesotho)
LT (Lithuania)
LU (Luxembourg)
LV (Latvia)
LY (Libya)
MA (Morocco)
MC (Monaco)
MD (Moldova)
MG (Madagascar)
MH (Marshall Islands)
MK (Macedonia)
ML (Mali)
MM (Myanmar)
MN (Mongolia)
MO (Macao S.A.R., China)
MP (Northern Mariana Islands)
MQ (Martinique)
MR (Mauritania)
MS (Montserrat)
MT (Malta)
MU (Mauritius)
MV (Maldives)
MW (Malawi)
MX (Mexico)
MY (Malaysia)
MZ (Mozambique)
NA (Namibia)
NC (New Caledonia)
NE (Niger)
NF (Norfolk Island)
NG (Nigeria)
NI (Nicaragua)
NL (Netherlands)
NO (Norway)
NP (Nepal)
NR (Nauru)
NU (Niue)
NZ (New Zealand)
OM (Oman)
PA (Panama)
PE (Peru)
PF (French Polynesia)
PG (Papua New Guinea)
PH (Philippines)
PK (Pakistan)
PL (Poland)
PM (Saint Pierre and Miquelon)
PN (Pitcairn)
PR (Puerto Rico)
PS (Palestinian Territory)
PT (Portugal)
PW (Palau)
PY (Paraguay)
QA (Qatar)
RE (Reunion)
RO (Romania)
RU (Russia)
RW (Rwanda)
SA (Saudi Arabia)
SB (Solomon Islands)
SC (Seychelles)
SD (Sudan)
SE (Sweden)
SG (Singapore)
SH (Saint Helena)
SI (Slovenia)
SJ (Svalbard and Jan Mayen)
SK (Slovakia)
SL (Sierra Leone)
SM (San Marino)
SN (Senegal)
SO (Somalia)
SR (Suriname)
ST (Sao Tome and Principe)
SV (El Salvador)
SY (Syria)
SZ (Swaziland)
TC (Turks and Caicos Islands)
TD (Chad)
TF (French Southern Territories)
TG (Togo)
TH (Thailand)
TJ (Tajikistan)
TK (Tokelau)
TL (East Timor)
TM (Turkmenistan)
TN (Tunisia)
TO (Tonga)
TR (Turkey)
TT (Trinidad and Tobago)
TV (Tuvalu)
TW (Taiwan)
TZ (Tanzania)
UA (Ukraine)
UG (Uganda)
UM (United States Minor Outlying Islands)
US (United States)
UY (Uruguay)
UZ (Uzbekistan)
VA (Vatican)
VC (Saint Vincent and the Grenadines)
VE (Venezuela)
VG (British Virgin Islands)
VI (U.S. Virgin Islands)
VN (Vietnam)
VU (Vanuatu)
WF (Wallis and Futuna)
WS (Samoa)
YE (Yemen)
YT (Mayotte)
ZA (South Africa)
ZM (Zambia)
ZW (Zimbabwe)

Community Profiles

Questions that communities ask members (profiles).

MLP.XMLRPC.get_user_communities

get list of communities that the user belongs to

Arguments

[struct]

username string (mandatory)

Return Value

[struct]

communities array of structs:
- id int
- name string

MLP.XMLRPC.get_community_profile_questions

get list of community questions

Arguments

[struct]

username string (mandatory) - community name

Return Value

[struct]

questions array of structs:
- id int
- communityid int
- question_text string
- question_type string - 'textfield'|'textfield_large'|'number'|'date'|'selectbox'|'checkbox'|'url'
- mandatory boolean
- num_maximum double
- num_minimum double
- multiple_choice boolean
- variants array of structs:
  - id int
  - variant_text string

MLP.XMLRPC.get_community_profile_answers

get list of user's answers

Arguments

[struct]

username string (mandatory)
community_name string (optional) - constrain
question_id int (optional) - constrain

Return Value

[struct]

answers array of structs:
- id int
- communityid int
- questionid int
- text_answer string
- num_answer double
- bool_answer boolean
- date_answer dateTime.iso8601
- variant_answer int - id of answer

MLP.XMLRPC.update_community_profile_answer

update answer or insert new one

Arguments

[struct]

username string (mandatory)
question_id int (mandatory)
community_id int (mandatory)
value mixed (mandatory) - type of value has to be string for (textfield, textfield_large,url), double or int for (number), dateTime.iso8601 for (date), int for (selectbox), boolean for (checkbox)

Return Value

[struct]

status boolean

Authentication Cookies

The cookies used on MyLivePage sites (not for XML-RPC). Partners should set/unset the cookies for synchronization when users login/logout.

mlp_name - name of user
mlp_session - session ID

Comments: 0 Views: 6300 [History of changes] Size:17917 byte
Last changes are made by: nailk Наиль Кашапов 636 days ago 12.06.2008 20:27:29

Send comment

Who is active on the site?

Anonymous: 6, Registered: 0 (?)