Difference between revisions of "HTTP API/Bot Commands/parcel info update"
From SmartBots Developers Docs
| Line 9: | Line 9: | ||
{{API Variable|x|no}} the X coordinate of the parcel (default - at bot's position) | {{API Variable|x|no}} the X coordinate of the parcel (default - at bot's position) | ||
{{API Variable|y|no}} the Y coordinate of the parcel (default - at bot's position) | {{API Variable|y|no}} the Y coordinate of the parcel (default - at bot's position) | ||
| − | {{API Variable|''item1''|yes}} the parcel entry to update (see the list below) | + | {{API Variable|''item1''|yes}} the parcel entry to update (see the list below and examples) |
{{API Variable|''item2''|optional}} another entry | {{API Variable|''item2''|optional}} another entry | ||
{{API Variable|''item3''...|optional}} and so on | {{API Variable|''item3''...|optional}} and so on | ||
Revision as of 17:09, 26 June 2019
Update parcel details
Variables
The following table shows input values (you send them with the API call) and returned output values.
| Variable | Required | Description | ||
|---|---|---|---|---|
| Input basic parameters: | ||||
| action | yes | = parcel_info_update | ||
| apikey | yes | Your personal developer's API key. | ||
| botname | yes | Your bot's SL login. | ||
| secret | yes | Bot access code of your bot. | ||
| dataType | optional | Set to "json" to get JSON reply instead of URL-encoded string | ||
| custom | optional | The custom data (string) to be passed back to caller script. This value will be returned back to the caller in HTTP response. | ||
| Input: | ||||
| x | optional | the X coordinate of the parcel (default - at bot's position) | ||
| y | optional | the Y coordinate of the parcel (default - at bot's position) | ||
| item1 | yes | the parcel entry to update (see the list below and examples) | ||
| item2 | optional | another entry | ||
| item3... | optional | and so on | ||
| Output: | ||||
| (to be received in http_response LSL event, see docs for details) | ||||
| result | OK - command completed successfully FAIL - command failed | |||
| resulttext | Detailed reason for the failure. | |||
| custom | The value from input "custom" parameter. See above. | |||
Available parcel entries
The available parcel entries to update:
- name
- The parcel name
- description
- The parcel description
- musicurl
- The parcel music URL
- sale
- Set to "on" to set land for sale, "off" to stop selling
- saleprice
- The selling price
- sellto
- The person UUID allowed to purchase this parcel
- sellobjects
- Set to "on" to allow selling objects with the parcels ("off" to disallow)
- snapshot
- The UUID of the picture to be set as a parcel image
- landingpoint
- The parcel landing point, format: "X/Y/Z"
- flags
- Internal parcel flags, one or more from the list below. Combined using comma (",")
Flags
Permissions
Your bot has to own the parcel, or have some of the permissions:
- Parcel identity > "Change parcel name, description, and 'Moderate Content' setting"
- Parcel settings > "Change music & media settings"
- Parcel Management > "Set land for sale info"
IMPORTANT:
Return values
The command returns result=OK if parcel update succeed.
<< return back to Bot commands
(Miss an API call or parameter? Submit your request in forum)
