ProfileApiService
Namespace http://api.hi5.com/profile (wsdl):
These services are used to perform actions on data associated with a user's profile.
The following methods are available on this endpoint:
Create Application Specific Data to Hi5.
This method stores data on the Hi5 API server for later retrieval.
It replaces any existing data with the specified information.
Input Parameters
| name |
description |
| uid |
User to associate data with.
|
| data |
an Instance of Hi5AppData, which contains key/value pairs.
|
Faults
| name |
description |
| PermissionDeniedException |
When using an invalid AuthToken.
|
Delete Application Specific Data on Hi5
Input Parameters
| name |
description |
| uid |
User to delete data for.
|
Faults
| name |
description |
| PermissionDeniedException |
When using an invalid AuthToken
|
Look up a user by email or nickname of a Hi5 url.
Looks up a userId given a certain set of criteria.
Input Parameters
| name |
description |
| email |
Email address of a user
|
| nickname |
Nickname of a Hi5 url of a user where nickname is the subdomain of a hi5 vanity url e.g. nickname.hi5.com
|
Return Value
the user id.
Faults
| name |
description |
| NotFoundException |
(no documentation provided)
|
Fetch Application Data from Hi5.
This method will fetch data associated with the current AuthToken + the specified user.
Input Parameters
| name |
description |
| uid |
the ID of the user to retrieve from.
|
Return Value
Hi5AppData, a set of key/value pairs.
Faults
| name |
description |
| PermissionDeniedException |
When using an invalid AuthToken.
|
Fetch Application Data from Hi5.
This method will fetch data associated with the current AuthToken + the specified user.
Input Parameters
| name |
description |
| uid |
the ID of the user to retrieve from.
|
Return Value
Hi5AppData, a set of key/value pairs.
Faults
| name |
description |
| PermissionDeniedException |
When using an invalid AuthToken.
|
Returns FOAF (Friend of a Friend) formatted information about a user.
The FOAF protocol is documented at http://www.foaf-project.org/
Input Parameters
| name |
description |
| userId |
The id of the user to read.
|
Return Value
FOAF formated XML representation of the User
Faults
| name |
description |
| BadRequestException |
if an invalidate userId is supplied.
|
| NotFoundException |
if you specify an non-existent userId
|
| PermissionDeniedException |
if the user is hidden.
|
Reads information about a user.
Input Parameters
| name |
description |
| userId |
The id of the user to read.
|
Return Value
The User.
Faults
| name |
description |
| NotFoundException |
if you specify an non-existant userId
|
| PermissionDeniedException |
if the user is hidden.
|
Returns XML Profile Targetting data about a user.
Special access is required to use this endpoint
Input Parameters
| name |
description |
| encryptedId |
(no documentation provided)
|
Return Value
XML Profile Targetting XML Information
Faults
| name |
description |
| BadRequestException |
if an invalidate userId is supplied.
|
| NotFoundException |
if you specify an non-existent userId
|
| PermissionDeniedException |
if the user is hidden.
|
Update Application Specific Data to Hi5.
This method stores data on the Hi5 API server for later retrieval.
It replaces any existing data with the specified information.
Input Parameters
| name |
description |
| uid |
User to associate data with.
|
| data |
an Instance of Hi5AppData, which contains key/value pairs.
|
Faults
| name |
description |
| PermissionDeniedException |
When using an invalid AuthToken.
|
Input Parameters
| name |
description |
| uid |
(no documentation provided)
|
| key |
(no documentation provided)
|
| value |
(no documentation provided)
|
Return Value
(no documentation provided)
Faults
| name |
description |
| PermissionDeniedException |
(no documentation provided)
|
