Executes an action for the currently logged in user.
The following built-in actions are available:
Content-Type: application/json
App-Id: {app_id}
The Transfer Action transfers a vAtom (if transferable) specified with this.id
to a new owner. The recipient can be given as new.owner.phone_number
, new.owner.email
or new.owner.id
.
{
"this.id": "0000374c-2e55-4868-9db8-c0a6df5ced93",
"new.owner.phone_number": "+1234567890"
}
{
"this.id": "0000374c-2e55-4868-9db8-c0a6df5ced93",
"new.owner.email": "testuser1@example.com"
}
{
"this.id": "0000374c-2e55-4868-9db8-c0a6df5ced93",
"new.owner.id": "29828993-c2b4-4f6b-a289-f4bdd965d068"
}
The clone action clones a vAtom based on its vAtom ID (if cloneable) specified as this.id
and transfers the copy to another user. The recipient can be given as new.owner.phone_number
, new.owner.email
or new.owner.id
.
{
"this.id": "0000374c-2e55-4868-9db8-c0a6df5ced93",
"new.owner.phone_number": "+1234567890"
}
{
"this.id": "0000374c-2e55-4868-9db8-c0a6df5ced93",
"new.owner.email": "testuser1@example.com"
}
{
"this.id": "0000374c-2e55-4868-9db8-c0a6df5ced93",
"new.owner.id": "29828993-c2b4-4f6b-a289-f4bdd965d068"
}
The drop action allows a user to drop a vAtom at a specific location. "geo_pos" specifies the geo coordinates of the vAtom to be dropped. The user still owns it until another user picks the vAtom up.
{
"this.id": "0000374c-2e55-4868-9db8-c0a6df5ced93",
"geo.pos": {
"Lon": 8.515284063931858,
"Lat": 47.166601832822856
}
}
The Pickup Action allows a user to pick up a vAtom specified by this.id from the map.
The acquire action acquires the vAtom based on its vAtom ID (if acquirable), specified as this.id
in the Action
The acquire pub. variation action acquires a vAtom of a template variation (if acquirable) of an existing vAtom based on its vAtom ID, specified as this.id
in the Action
The redeem action redeems the vAtom based on its vAtom ID (if redeemable), specified as this.id
in the Action. New owner indicates the redeeming recipient, who must be accepting the redeemable.
{
"this.id": "0000374c-2e55-4868-9db8-c0a6df5ced93",
"new.owner.id": "29828993-c2b4-4f6b-a289-f4bdd965d068"
}
The discover action reveals vAtoms, faces and actions associated with a Discover Container vAtom by using the discover query of the vAtoms defined by this.id
.
The activate action unpacks a package specified by this.id
.
Error | Type | Description |
---|---|---|
200 | http | Everything is OK |
400 | http | Invalid request |
401 | http | Not an owner or bad recipient |
403 | http | Not Authorized |
404 | http | Action not found |
{
"payload": {
"success_message": "v1::transfer successfully executed"
}
}