Namespace http://api.hi5.com/

The following types are members of this namespace:

applicationUpdate
appMetrics
authLevel
AuthToken
contextMetric
emailResponse
friendUpdateResponse
hi5App
hi5AppDetails
hi5AppProvider
hi5AppStatus
hi5Auth
hi5AuthType
hi5ErrorResponse
hi5Response
hi5SuccessMessage
memberStatus
memberStatusList
metric
metrics
notification
notificationResponse
onlineFriend
onlineFriends
photo
pointUsage
profile
profileViews
testResponse
timestampedMetrics
user
userId
userVcard

The following elements are members of this namespace:

activity_response
application
applicationUpdate
authlevel
authToken
details
email_response
error_response
hi5_response
hi5appProvider
hi5AuthToken
memberStatus
memberStatusList
metricsResponse
notification
notification_response
onlineFriend
onlineFriends
pass
profile
TestResponse
user
userId
userVcard

applicationUpdate

Child Elements

name	min/max occurs	description
templateId	0/1	(no documentation provided)
iconUrl	0/1	(no documentation provided)
params	0/unbounded	(no documentation provided)
body	0/1	(no documentation provided)
url	0/1	(no documentation provided)
title	0/1	(no documentation provided)
images	0/unbounded	(no documentation provided)
imageLinks	0/unbounded	(no documentation provided)

appMetrics

Attributes

name	description
appId	(no documentation provided)

Child Elements

name	min/max occurs	description
metric	0/unbounded	(no documentation provided)

authLevel

Possible Authentication Rights

Possible Values

value	description
ANONYMOUS
READ
WRITE
ADMIN

AuthToken

An authentication token. The Authentication Token stores the state necessary to validate a request coming from an API client.

Attributes

name	description
ipAddressBound	(no documentation provided)
userId	(no documentation provided)
ipAddress	(no documentation provided)

Value

(no documentation provided)

contextMetric

Attributes

name	description
context	(no documentation provided)

Value

(no documentation provided)

emailResponse

Child Elements

name	min/max occurs	description
sent_ids	0/unbounded	(no documentation provided)
error_code	0/1	(no documentation provided)
error_message	0/1	(no documentation provided)

friendUpdateResponse

Child Elements

name	min/max occurs	description
success	0/1	(no documentation provided)
error_code	0/1	(no documentation provided)
error_message	0/1	(no documentation provided)

hi5App

Child Elements

name	min/max occurs	description
userId	0/1	(no documentation provided)
apiKey	0/1	(no documentation provided)
sharedSecret	0/1	(no documentation provided)
notes	0/1	(no documentation provided)
status	0/1	(no documentation provided)
authType	0/1	(no documentation provided)
issued	0/1	(no documentation provided)
details	0/unbounded	(no documentation provided)
id	0/1	(no documentation provided)
requested	0/1	(no documentation provided)
defaultLanguage	0/1	(no documentation provided)
pointUsage	0/1	(no documentation provided)

hi5AppDetails

languages - http://www.loc.gov/standards/iso639-2/php/English_list.php regions - ISO 2 char country code.

Child Elements

name	min/max occurs	description
title	0/1	(no documentation provided)
description	0/1	(no documentation provided)
logo100url	0/1	(no documentation provided)
appUrl	0/1	(no documentation provided)
callbackUrl	0/1	(no documentation provided)
privacyUrl	0/1	(no documentation provided)

hi5AppProvider

languages - http://www.loc.gov/standards/iso639-2/php/English_list.php regions - ISO 2 char country code.

Child Elements

name	min/max occurs	description
id	1/1	(no documentation provided)
name	0/1	(no documentation provided)
devKey	0/1	(no documentation provided)
userId	1/1	(no documentation provided)
timeAdded	0/1	(no documentation provided)
apps	0/unbounded	(no documentation provided)

hi5AppStatus

Possible Values

value	description
PENDING
ACTIVE
SUSPENDED

hi5Auth

An auth token that allows sign on for the hi5 site. Using the token value, apps can set hi5Auth Cookie to enable login on the hi5 site. The API is exposed only for partner apps.

hi5AuthType

Possible Values

value	description
WEB
DESKTOP
MOBILE

hi5ErrorResponse

Generates an XML Response when error are thrown by hi5 internal interceptors of requests. Date: Jun 13, 2008 Time: 5:07:54 PM

Child Elements

name	min/max occurs	description
error_code	0/1	(no documentation provided)
error_message	0/1	(no documentation provided)

hi5Response

Hi5 Generic Response.

Child Elements

name	min/max occurs	description
response_code	0/1	(no documentation provided)
response_message	0/1	(no documentation provided)

hi5SuccessMessage

memberStatus

Child Elements

name	min/max occurs	description
userId	1/1	(no documentation provided)
content	0/1	(no documentation provided)
timeAdded	0/1	(no documentation provided)
name	0/1	(no documentation provided)
imageUrl	0/1	(no documentation provided)

memberStatusList

Child Elements

name	min/max occurs	description
userId	1/1	(no documentation provided)
friendStatuses	0/unbounded	(no documentation provided)

metric

Attributes

name	description
count	(no documentation provided)
name	(no documentation provided)

Child Elements

name	min/max occurs	description
context	0/unbounded	(no documentation provided)

metrics

Created by IntelliJ IDEA. User: alekseyperfilov Date: Jul 7, 2008 Time: 2:38:06 PM

Child Elements

name	min/max occurs	description
apiName	0/1	(no documentation provided)
apiKeys	0/1	(no documentation provided)
appNames	0/1	(no documentation provided)
requestedMetrics	0/1	(no documentation provided)
requestedContext	0/1	(no documentation provided)
startTime	0/1	(no documentation provided)
endTime	0/1	(no documentation provided)
time	0/unbounded	(no documentation provided)
app	0/unbounded	(no documentation provided)

notification

Child Elements

name	min/max occurs	description
body	0/1	(no documentation provided)
toIds	0/unbounded	(no documentation provided)
friends	0/1	(no documentation provided)

notificationResponse

Child Elements

name	min/max occurs	description
sent_ids	0/unbounded	(no documentation provided)
error_code	0/1	(no documentation provided)
error_message	0/1	(no documentation provided)

onlineFriend

Child Elements

name	min/max occurs	description
userId	1/1	(no documentation provided)
online	1/1	(no documentation provided)

onlineFriends

Child Elements

name	min/max occurs	description
userId	1/1	(no documentation provided)
friends	0/unbounded	(no documentation provided)

photo

A hi5 photo, corresponds to the <item> element in <album>, see type album

Attributes

name	description
description	Description of the photo
img	URL for photo thumbnail
url	URL for full size image

pointUsage

Child Elements

name	min/max occurs	description
starthour	0/1	(no documentation provided)
values	0/unbounded	(no documentation provided)

profile

profileViews

Created by IntelliJ IDEA. User: aperfilov Date: Jan 8, 2009 Time: 11:49:18 AM

Child Elements

name	min/max occurs	description
totalViews	0/1	(no documentation provided)
monthlyViews	0/1	(no documentation provided)

testResponse

Child Elements

name	min/max occurs	description
message	0/1	(no documentation provided)

timestampedMetrics

Child Elements

name	min/max occurs	description
app	0/unbounded	(no documentation provided)

user

Attributes

name	description
id	(no documentation provided)

Child Elements

name	min/max occurs	description
hi5url	0/1	(no documentation provided)
alias	0/1	(no documentation provided)
name	0/1	(no documentation provided)
picture	0/1	(no documentation provided)

userId

Returns a userid as part of a lookup or search

Value

the userId

userVcard

extends user

activity_response

type: friendUpdateResponse

application

type: hi5App

applicationUpdate

type: applicationUpdate

authlevel

type: authLevel

Possible Authentication Rights

authToken

type: AuthToken

An authentication token. The Authentication Token stores the state necessary to validate a request coming from an API client.

details

type: hi5AppDetails

languages - http://www.loc.gov/standards/iso639-2/php/English_list.php regions - ISO 2 char country code.

email_response

type: emailResponse

error_response

type: hi5ErrorResponse

Generates an XML Response when error are thrown by hi5 internal interceptors of requests. Date: Jun 13, 2008 Time: 5:07:54 PM

hi5_response

type: hi5Response

Hi5 Generic Response.

hi5appProvider

type: hi5AppProvider

languages - http://www.loc.gov/standards/iso639-2/php/English_list.php regions - ISO 2 char country code.

hi5AuthToken

type: hi5Auth

An auth token that allows sign on for the hi5 site. Using the token value, apps can set hi5Auth Cookie to enable login on the hi5 site. The API is exposed only for partner apps.