VirtualGoodsApiService
Namespace http://api.hi5.com/ (wsdl):
Created by IntelliJ IDEA. User: dsakima Date: May 6, 2010 Time: 3:52:40 PM
The following methods are available on this endpoint:
createPossession
Add a new Possession
Input Parameters
| name | description |
|---|---|
| userId | Id of user getting the possession. |
| possession | The possession the user is getting. |
Return Value
possessionId The id of the new possession.
Faults
| name | description |
|---|---|
| BadRequestException | This is thrown if, no product exists for the product id supplied in the possession or, the owner id in the possession is invalid or, an error occurs during the creation of the possession. |
| PermissionDeniedException | Is thrown if the authentication to access the application fails. |
deletePossession
Delete an existing possession
Input Parameters
| name | description |
|---|---|
| userId | Id of the user who owns the possession to be deleted. |
| possessionId | Id of the possession to be deleted. |
Faults
| name | description |
|---|---|
| BadRequestException | Is thrown if there is no possession found for the supplied id. |
| PermissionDeniedException | Is thrown if the authentication to access the application fails. |
getPossession
Get one or all possessions of a specific user
Input Parameters
| name | description |
|---|---|
| userId | The id of the user whose possession(s) are returned. |
| possessionId | The id of the possession to be returned. If no id is supplied all the users possessions are returned. |
| startIndex | Beginning index for the subset of users possessions. |
| count | Number of possessions to return. If not supplied all users possessions will be returned. |
| sortBy | The field in which to sort the results by: ID, CREATION_DATE, EXPIRATION_DATE, PRODUCT_ID |
| sortOrder | The order in which the sorted results will appear: ASC, DESC |
| filterBy | Only return possessions that match a specific type of id: APPLICATION , DEVELOPER. |
| filterOp | Operation can be: EQUALS, NOTEQUALS |
| filterValue | Value used to compare |
Return Value
PossessionResponse
Faults
| name | description |
|---|---|
| BadRequestException | Is thrown if there is no possession found for the supplied id. |
| PermissionDeniedException | Is thrown if the authentication to access the application fails. |
getProduct
Get one or all products
Input Parameters
| name | description |
|---|---|
| productId | The id of the possession to be returned. If no id is supplied all the users possessions are returned |
| startIndex | Beginning index for the subset of users products |
| count | Number of products to return. If not supplied all users products will be returned |
| sortBy | The field in which to sort the results by: ID, CREATION_DATE, EXPIRATION_DATE |
| sortOrder | The order in which the sorted results will appear: ASC, DESC |
| filterBy | Only return products that match a specific type of id: DEVELOPER |
| filterOp | Operation can be: EQUALS, NOTEQUALS |
| filterValue | Value used to compare |
Return Value
Product
Faults
| name | description |
|---|---|
| BadRequestException | Is thrown if there is no product found for the supplied id. |
| PermissionDeniedException | (no documentation provided) |
updatePossession
Update an existing possession
Input Parameters
| name | description |
|---|---|
| userId | The id of the user whose possession is updated |
| possessionId | The id of the possession to be updated. |
| possession | Contains the info to update: activationTime, applicationId, coinsCost, expirationTime, ownerId, productId, purchaserId |
Faults
| name | description |
|---|---|
| BadRequestException | Is thrown if there is no possession found for the supplied id. |
| PermissionDeniedException | Is thrown if the authentication to access the application fails. |