/users/{userId}/possessions/{possessionId}
The following methods are supported on this resource:
Mount Points
The following URLs are examples of where this resource is mounted :
| XML: | http://api.hi5.com |
| *JSON: | http://api.hi5.com |
| *JSON endpoints are mounted read-only. | |
delete
Delete an existing possession
Possible HTTP Parameters
| name | description |
|---|---|
| possessionId | Id of the possession to be deleted. |
| userId | Id of the user who owns the possession to be deleted. |
Errors
| code | description |
|---|---|
| 403 | Thrown when an attempt is made to do something without the correct permissions. |
| 400 | Thrown when invalid data is received for a specific method. |
read
Get one or all possessions of a specific user
Possible HTTP Parameters
| name | description |
|---|---|
| possessionId | The id of the possession to be returned. If no id is supplied all the users possessions are returned. |
| userId | The id of the user whose possession(s) 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 |
Output Payload
PossessionResponse
Errors
| code | description |
|---|---|
| 403 | Thrown when an attempt is made to do something without the correct permissions. |
| 400 | Thrown when invalid data is received for a specific method. |
update
Update an existing possession
Possible HTTP Parameters
| name | description |
|---|---|
| possessionId | The id of the possession to be updated. |
| userId | The id of the user whose possession is updated |
Input Payload
Contains the info to update: activationTime, applicationId, coinsCost, expirationTime, ownerId, productId, purchaserId
Errors
| code | description |
|---|---|
| 403 | Thrown when an attempt is made to do something without the correct permissions. |
| 400 | Thrown when invalid data is received for a specific method. |