Namespace http://api.hi5.com/
The following types are members of this namespace:
- applicationUpdate
- appMetrics
- assetList
- assetResponse
- authLevel
- AuthToken
- bundleResponse
- bundleResponseList
- clientLibResponse
- context
- contextMetric
- emailResponse
- errorCode
- fbAuthToken
- friendInvite
- friendInviteResponse
- friendSet
- friendUpdateResponse
- hi5App
- hi5AppDetails
- hi5AppProvider
- hi5AppStatus
- hi5Auth
- hi5AuthType
- hi5ErrorResponse
- hi5Response
- hi5SuccessMessage
- invitationResponse
- memberStatus
- memberStatusList
- metric
- metrics
- microFriendUpdate
- microFriendUpdateImage
- microFriendUpdateResponse
- notification
- notificationResponse
- onlineFriend
- onlineFriends
- photo
- pointUsage
- possessionList
- possessionResponse
- productList
- productResponse
- profile
- profileViews
- purchaseIntentResponse
- redemptionResponse
- registration
- registrationResponse
- searchType
- status
- testResponse
- textResponse
- timestampedMetrics
- user
- userId
- userItem
- userList
- userVcard
The following elements are members of this namespace:
- activity_response
- application
- applicationUpdate
- asset
- asset_list
- authlevel
- authToken
- bundle
- bundles
- details
- email_response
- EnvironmentInformation
- error_response
- friend_update
- friendInvite
- friendInvite
- friendSet
- hi5_response
- hi5appProvider
- hi5AuthToken
- invitation_response
- memberStatus
- memberStatusList
- metricsResponse
- microFriendUpdate
- microFriendUpdateImage
- notification
- notification_response
- onlineFriend
- onlineFriends
- pass
- possession
- possessions
- product
- products
- profile
- purchaseIntent
- redemption
- registration
- registrationResponse
- TestResponse
- user
- userId
- userItem
- users
- 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) |
assetList
Created by IntelliJ IDEA. User: Derrik Sakima Date: May 12, 2010 Time: 8:04:30 PM
Child Elements
| name | min/max occurs |
description |
|---|---|---|
| assetResponse | 0/unbounded | (no documentation provided) |
assetResponse
Created by IntelliJ IDEA. User: Derrik Sakima Date: May 12, 2010 Time: 8:04:24 PM
Child Elements
| name | min/max occurs |
description |
|---|---|---|
| productAssetType | 0/1 | (no documentation provided) |
| uri | 0/1 | (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)
bundleResponse
User: cmiddleton
bundleResponseList
User: cmiddleton
Child Elements
| name | min/max occurs |
description |
|---|---|---|
| bundle | 0/unbounded | (no documentation provided) |
clientLibResponse
User: Derrik Sakima Date: Nov 12, 2010 Time: 4:12:45 PM
Child Elements
| name | min/max occurs |
description |
|---|---|---|
| errorCode | 0/1 | (no documentation provided) |
| status | 0/1 | (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) |
errorCode
Possible Values
| value | description |
|---|---|
| AUTHENTICATION_FAILURE | |
| INVALID_DATA | |
| NEED_TO_REGISTER | |
| SYSTEM_ERROR | |
| USER_REGISTERED | |
| EMAIL_FAILURE | |
| INVALID_PASSWORD | |
| INVALID_FIRST_NAME | |
| INVALID_LAST_NAME |
fbAuthToken
extends AuthToken
friendInvite
extends clientLibResponse
User: Derrik Sakima Date: Nov 16, 2010 Time: 7:02:37 PM
Child Elements
| name | min/max occurs |
description |
|---|---|---|
| invitedUserIds | 0/unbounded | (no documentation provided) |
| openMessage | 0/1 | (no documentation provided) |
| productImgUrl | 0/1 | (no documentation provided) |
| success1 | 0/1 | (no documentation provided) |
| success2 | 0/1 | (no documentation provided) |
| thanks | 0/1 | (no documentation provided) |
friendInviteResponse
extends clientLibResponse
User: Derrik Sakima Date: Nov 9, 2010 Time: 8:45:57 PM
Child Elements
| name | min/max occurs |
description |
|---|---|---|
| emailAddress | 0/1 | (no documentation provided) |
| emailCommalist | 0/1 | (no documentation provided) |
| emailEnter | 0/1 | (no documentation provided) |
| errorMesg | 0/1 | (no documentation provided) |
| findFriends | 0/1 | (no documentation provided) |
| header | 0/1 | (no documentation provided) |
| hi5Games | 0/1 | (no documentation provided) |
| importGuideCopy | 0/1 | (no documentation provided) |
| importHeader | 0/1 | (no documentation provided) |
| importerEmail | 0/1 | (no documentation provided) |
| importerLegal | 0/1 | (no documentation provided) |
| importerLegalMs | 0/1 | (no documentation provided) |
| instructionKey | 0/1 | (no documentation provided) |
| itemDescription | 0/1 | (no documentation provided) |
| itemImageUrl | 0/1 | (no documentation provided) |
| itemName | 0/1 | (no documentation provided) |
| password | 0/1 | (no documentation provided) |
| quickAdd | 0/1 | (no documentation provided) |
| searchButton | 0/1 | (no documentation provided) |
| searchLabel | 0/1 | (no documentation provided) |
| selectedUsers | 0/1 | (no documentation provided) |
| selectedUsersButton | 0/1 | (no documentation provided) |
| selectedUsersPlural | 0/1 | (no documentation provided) |
| status | 0/1 | (no documentation provided) |
| users | 0/unbounded | (no documentation provided) |
friendSet
extends clientLibResponse
Child Elements
| name | min/max occurs |
description |
|---|---|---|
| emails | 0/unbounded | (no documentation provided) |
| importFailMessage | 0/1 | (no documentation provided) |
| users | 0/unbounded | (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) |
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.
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) |
invitationResponse
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) |
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) |
microFriendUpdate
Attributes
| name | description |
|---|---|
| id | (no documentation provided) |
Child Elements
| name | min/max occurs |
description |
|---|---|---|
| eventType | 0/1 | (no documentation provided) |
| iconImgUrl | 0/1 | (no documentation provided) |
| images | 0/unbounded | (no documentation provided) |
| link1Text | 0/1 | (no documentation provided) |
| link1Url | 0/1 | (no documentation provided) |
| link2Text | 0/1 | (no documentation provided) |
| link2Url | 0/1 | (no documentation provided) |
| link3Text | 0/1 | (no documentation provided) |
| link3Url | 0/1 | (no documentation provided) |
| localizedMessage | 0/1 | (no documentation provided) |
| snippet | 0/1 | (no documentation provided) |
| snippetLink | 0/1 | (no documentation provided) |
| snippetLinkCustomText | 0/1 | (no documentation provided) |
| snippetLinkText | 0/1 | (no documentation provided) |
| thumbnailUrl | 0/1 | (no documentation provided) |
| timestamp | 0/1 | (no documentation provided) |
| title | 0/1 | (no documentation provided) |
| url | 0/1 | (no documentation provided) |
microFriendUpdateImage
Child Elements
| name | min/max occurs |
description |
|---|---|---|
| contentImageUrl | 0/1 | (no documentation provided) |
| link | 0/1 | (no documentation provided) |
microFriendUpdateResponse
Child Elements
| name | min/max occurs |
description |
|---|---|---|
| success | 0/1 | (no documentation provided) |
| mfu | 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) |
possessionList
Created by IntelliJ IDEA. User: dsakima Date: May 6, 2010 Time: 6:25:59 PM
Child Elements
| name | min/max occurs |
description |
|---|---|---|
| possession | 0/unbounded | (no documentation provided) |
possessionResponse
Created by IntelliJ IDEA. User: Derrik Sakima Date: May 12, 2010 Time: 12:12:22 PM
Child Elements
| name | min/max occurs |
description |
|---|---|---|
| activationTime | 0/1 | (no documentation provided) |
| applicationId | 1/1 | (no documentation provided) |
| coinsCost | 1/1 | (no documentation provided) |
| creationDate | 0/1 | (no documentation provided) |
| deletionDate | 0/1 | (no documentation provided) |
| expirationDate | 0/1 | (no documentation provided) |
| id | 1/1 | (no documentation provided) |
| message | 0/1 | (no documentation provided) |
| ownerId | 1/1 | (no documentation provided) |
| productId | 1/1 | (no documentation provided) |
| purchaserId | 1/1 | (no documentation provided) |
productList
Created by IntelliJ IDEA. User: dsakima Date: May 7, 2010 Time: 10:36:19 AM
Child Elements
| name | min/max occurs |
description |
|---|---|---|
| product | 0/unbounded | (no documentation provided) |
productResponse
Created by IntelliJ IDEA. User: Derrik Sakima Date: May 12, 2010 Time: 12:45:49 PM
Child Elements
| name | min/max occurs |
description |
|---|---|---|
| assetList | 0/1 | (no documentation provided) |
| coinsCost | 1/1 | (no documentation provided) |
| creationDate | 0/1 | (no documentation provided) |
| description | 0/1 | (no documentation provided) |
| developerId | 1/1 | (no documentation provided) |
| expirationDate | 0/1 | (no documentation provided) |
| id | 1/1 | (no documentation provided) |
| releaseDate | 0/1 | (no documentation provided) |
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) |
purchaseIntentResponse
User: cmiddleton
redemptionResponse
User: cmiddleton
registration
extends clientLibResponse
User: Derrik Sakima Date: Oct 27, 2010 Time: 4:01:08 PM
Child Elements
| name | min/max occurs |
description |
|---|---|---|
| apr | 0/1 | (no documentation provided) |
| aug | 0/1 | (no documentation provided) |
| bday | 0/1 | (no documentation provided) |
| cancel | 0/1 | (no documentation provided) |
| change | 0/1 | (no documentation provided) |
| day | 0/1 | (no documentation provided) |
| dec | 0/1 | (no documentation provided) |
| desc | 0/1 | (no documentation provided) |
| 0/1 | (no documentation provided) | |
| emailDupError | 0/1 | (no documentation provided) |
| emailError | 0/1 | (no documentation provided) |
| feb | 0/1 | (no documentation provided) |
| female | 0/1 | (no documentation provided) |
| firstName | 0/1 | (no documentation provided) |
| gameCat | 0/1 | (no documentation provided) |
| gameImg | 0/1 | (no documentation provided) |
| gameTitle | 0/1 | (no documentation provided) |
| gender | 0/1 | (no documentation provided) |
| guide | 0/1 | (no documentation provided) |
| guideGeneric | 0/1 | (no documentation provided) |
| guideInvite | 0/1 | (no documentation provided) |
| jan | 0/1 | (no documentation provided) |
| jul | 0/1 | (no documentation provided) |
| jun | 0/1 | (no documentation provided) |
| lastName | 0/1 | (no documentation provided) |
| male | 0/1 | (no documentation provided) |
| mar | 0/1 | (no documentation provided) |
| may | 0/1 | (no documentation provided) |
| month | 0/1 | (no documentation provided) |
| nov | 0/1 | (no documentation provided) |
| oct | 0/1 | (no documentation provided) |
| passwd | 0/1 | (no documentation provided) |
| passwordError | 0/1 | (no documentation provided) |
| regHeader | 0/1 | (no documentation provided) |
| safetyComp | 0/1 | (no documentation provided) |
| safetyCompError | 0/1 | (no documentation provided) |
| sendInvites | 0/1 | (no documentation provided) |
| sep | 0/1 | (no documentation provided) |
| showPasswd | 0/1 | (no documentation provided) |
| status | 0/1 | (no documentation provided) |
| tos | 0/1 | (no documentation provided) |
| userEmail | 0/1 | (no documentation provided) |
| userPics | 0/unbounded | (no documentation provided) |
| year | 0/1 | (no documentation provided) |
| fNameError | 0/1 | (no documentation provided) |
| lNameError | 0/1 | (no documentation provided) |
registrationResponse
extends clientLibResponse
User: Derrik Sakima Date: Oct 28, 2010 Time: 2:23:53 PM
Child Elements
| name | min/max occurs |
description |
|---|---|---|
| congrats | 0/1 | (no documentation provided) |
| invite | 0/1 | (no documentation provided) |
| submit | 0/1 | (no documentation provided) |
| success1 | 0/1 | (no documentation provided) |
| success2 | 0/1 | (no documentation provided) |
| welcome | 0/1 | (no documentation provided) |
textResponse
Child Elements
| name | min/max occurs |
description |
|---|---|---|
| buildNumber | 0/1 | (no documentation provided) |
| hostName | 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) |
userList
User: Derrik Sakima Date: Oct 28, 2010 Time: 10:51:29 AM
application
type: hi5App
asset
type: assetResponse
Created by IntelliJ IDEA. User: Derrik Sakima Date: May 12, 2010 Time: 8:04:24 PM
asset_list
type: assetList
Created by IntelliJ IDEA. User: Derrik Sakima Date: May 12, 2010 Time: 8:04:30 PM
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
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.
memberStatus
type: memberStatus
metricsResponse
type: metrics
Created by IntelliJ IDEA. User: alekseyperfilov Date: Jul 7, 2008 Time: 2:38:06 PM
notification
type: notification
onlineFriend
type: onlineFriend
onlineFriends
type: onlineFriends
pass
type: hi5SuccessMessage
possession
type: possessionResponse
Created by IntelliJ IDEA. User: Derrik Sakima Date: May 12, 2010 Time: 12:12:22 PM
possessions
type: possessionList
Created by IntelliJ IDEA. User: dsakima Date: May 6, 2010 Time: 6:25:59 PM
product
type: productResponse
Created by IntelliJ IDEA. User: Derrik Sakima Date: May 12, 2010 Time: 12:45:49 PM
products
type: productList
Created by IntelliJ IDEA. User: dsakima Date: May 7, 2010 Time: 10:36:19 AM
registrationResponse
type: registrationResponse
User: Derrik Sakima Date: Oct 28, 2010 Time: 2:23:53 PM
TestResponse
type: testResponse