Linden Lab Official:Inventory API v3

From Second Life Wiki
Revision as of 10:55, 4 October 2013 by Don Linden (talk | contribs)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

Resource Methods Overview

† - Partially Implemented ‡ - Not Implemented
Category /category/{category}{?tid,depth,simulate} GET POST† PUT PATCH COPY MOVE‡ DELETE
CategoryChildren /category/{category}/children{?tid,depth,simulate} GET PUT‡ COPY‡ MOVE‡ DELETE
CategoryLinks /category/{category}/links{?tid,simulate} GET PUT COPY‡ MOVE‡ DELETE
CategoryItems /category/{category}/items{?tid,simulate} GET PUT‡ COPY‡ MOVE‡ DELETE
CategoryCategories /category/{category}/categories{?tid,depth,simulate} GET PUT‡ COPY‡ MOVE‡ DELETE
Item /item/{item}{?tid,simulate} GET PATCH COPY‡ MOVE‡ DELETE

Resources


Category

Description

  • An inventory category.

Path:

  • /category/{category}{?tid,depth,simulate}

Parameters

  • category → Category UUID or 'special' category name, e.g. "current".
    • Validation: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
    • Validation: ^(animatn|bodypart|clothing|current|favorite|gesture|inbox|landmark|lsltext)$
    • Validation: ^(lstndfnd|my_otfts|notecard|object|outbox|root|snapshot|sound|texture|trash)$
  • tid → Transaction ID.
  • depth → Category child depth to retrieve.
    • Validation: ^(\*|[0-9]+)?$
  • simulate → Whether or not to skip writing back results.
    • Validation: ^(0|1|true|false)?$

Methods


Category-GET

Implementation Status

  • COMPLETE

Description

  • Retrieve a category
Request Headers
If-None-Match (optional) Only process request if none of the supplied entity tags matches resource.
If-Match (optional) Only process request if any supplied entity tags matches resource.
Status Codes
200

Description

  • Category retrieved successfully

Response Schemas:

categoryResponse † - Optional
_links
self
href

uri

name†

enum: self, link

parent
href

uri

name†

enum: self, link

category†
href

uri

name†

enum: self, link

parent
href

uri

name†

enum: self, link

links
href

uri

name†

enum: self, link

items
href

uri

name†

enum: self, link

self
href

uri

name†

enum: self, link

children
href

uri

name†

enum: self, link

categories†
href

uri

name†

enum: self, link

_base_uri

uri

name

string

type_default

integer ( -151 )

parent_id

uuid

version

integer ( 1 )

agent_id

uuid

category_id

uuid

categoryChildrenResponse † - Optional
_links
self
href

uri

name†

enum: self, link

parent
href

uri

name†

enum: self, link

category†
href

uri

name†

enum: self, link

parent
href

uri

name†

enum: self, link

links
href

uri

name†

enum: self, link

items
href

uri

name†

enum: self, link

self
href

uri

name†

enum: self, link

children
href

uri

name†

enum: self, link

categories†
href

uri

name†

enum: self, link

_base_uri

uri

name

string

type_default

integer ( -151 )

parent_id

uuid

version

integer ( 1 )

agent_id

uuid

category_id

uuid

_embedded
items
uuid
asset_id

uuid

inv_type

integer ( 022 )

name

string

sale_info
sale_price

integer ( 0 )

sale_type

integer ( 03 )

created_at

unixtime

parent_id†

uuid

flags

integer ( 0 )

agent_id

uuid

item_id

uuid

permissions
base_mask

integer ( 0 )

group_mask

integer ( 0 )

last_owner_id

uuid

owner_id

uuid

creator_id

uuid

next_owner_mask

integer ( 0 )

owner_mask

integer ( 0 )

group_id

uuid

everyone_mask

integer ( 0 )

type

integer ( -151 )

desc

string

_links
self
href

uri

name†

enum: self, link

parent
href

uri

name†

enum: self, link

links
uuid
linked_id

uuid

name

string

created_at

unixtime

parent_id

uuid

agent_id

uuid

item_id

uuid

inv_type

integer ( 022 )

type

integer ( 2425 )

desc

string

_links
item
href

uri

name†

enum: self, link

category
href

uri

name†

enum: self, link

self
href

uri

name†

enum: self, link

parent
href

uri

name†

enum: self, link

categories
uuid
name

string

type_default

integer ( -151 )

parent_id

uuid

version

integer ( 1 )

agent_id

uuid

category_id

uuid

_links
self
href

uri

name†

enum: self, link

parent
href

uri

name†

enum: self, link

_embedded
items
uuid
asset_id

uuid

inv_type

integer ( 022 )

name

string

sale_info
sale_price

integer ( 0 )

sale_type

integer ( 03 )

created_at

unixtime

parent_id†

uuid

flags

integer ( 0 )

agent_id

uuid

item_id

uuid

permissions
base_mask

integer ( 0 )

group_mask

integer ( 0 )

last_owner_id

uuid

owner_id

uuid

creator_id

uuid

next_owner_mask

integer ( 0 )

owner_mask

integer ( 0 )

group_id

uuid

everyone_mask

integer ( 0 )

type

integer ( -151 )

desc

string

_links
self
href

uri

name†

enum: self, link

parent
href

uri

name†

enum: self, link

links
uuid
linked_id

uuid

name

string

created_at

unixtime

parent_id

uuid

agent_id

uuid

item_id

uuid

inv_type

integer ( 022 )

type

integer ( 2425 )

desc

string

_links
item
href

uri

name†

enum: self, link

category
href

uri

name†

enum: self, link

self
href

uri

name†

enum: self, link

parent
href

uri

name†

enum: self, link

categories

metaEmbeddedCategoriesWithChildren (recursive)

Response Headers
ETag Current value of the entity tag for the requested variant.
304

Description

  • Not modified

Response Schemas: string

Response Headers
ETag Current value of the entity tag for the requested variant.
404

Description

  • Category not found

Response Schemas:

errorCategoryNotFound † - Optional
error_line_number†

integer

error_filename†

string

error_description

string

error_function†

string

category_id†

uuid

error_code

integer ( 46 )

412

Description

  • Precondition failed

Response Schemas:

errorPreconditionFailed † - Optional
error_line_number†

integer

error_filename†

string

error_description

string

error_function†

string

etags

[ string , ... ]

etag

string

error_code

integer ( 10 )

condition

string

Response Headers
ETag Current value of the entity tag for the requested variant.

Category-POST

Implementation Status

  • PARTIAL

Description

  • Create inventory in category.
Request Headers
If-None-Match (optional) Only process request if none of the supplied entity tags matches resource.
If-Match (optional) Only process request if any supplied entity tags matches resource.
Request Schemas
newEmbeddedChildren † - Optional
items†

[

asset_id

uuid

inv_type

integer ( 022 )

name

string

sale_info†
sale_price†

integer ( 0 )

sale_type†

integer ( 03 )

flags†

integer ( 0 )

desc†

string

type

integer ( -151 )

permissions†
owner_mask†

integer ( 0 )

base_mask†

integer ( 0 )

next_owner_mask†

integer ( 0 )

group_mask†

integer ( 0 )

everyone_mask†

integer ( 0 )

, ... ]

links†

[

type

integer ( 2425 )

linked_id

uuid

name†

string

desc†

string

, ... ]

categories†

[

_embedded†
items†

[

asset_id

uuid

inv_type

integer ( 022 )

name

string

sale_info†
sale_price†

integer ( 0 )

sale_type†

integer ( 03 )

flags†

integer ( 0 )

desc†

string

type

integer ( -151 )

permissions†
owner_mask†

integer ( 0 )

base_mask†

integer ( 0 )

next_owner_mask†

integer ( 0 )

group_mask†

integer ( 0 )

everyone_mask†

integer ( 0 )

, ... ]

links†

[

type

integer ( 2425 )

linked_id

uuid

name†

string

desc†

string

, ... ]

categories†

[ newCategory (recursive) , ... ]

name

string

type_default†

integer ( -151 )

, ... ]

Status Codes
201

Description

  • Inventory created

Response Schemas:

categoryNewChildrenResponse † - Optional
_links
self
href

uri

name†

enum: self, link

parent
href

uri

name†

enum: self, link

category†
href

uri

name†

enum: self, link

parent
href

uri

name†

enum: self, link

links
href

uri

name†

enum: self, link

items
href

uri

name†

enum: self, link

self
href

uri

name†

enum: self, link

children
href

uri

name†

enum: self, link

categories†
href

uri

name†

enum: self, link

_base_uri

uri

name

string

type_default

integer ( -151 )

parent_id

uuid

version

integer ( 1 )

agent_id

uuid

category_id

uuid

_embedded
items
uuid
asset_id

uuid

inv_type

integer ( 022 )

name

string

sale_info
sale_price

integer ( 0 )

sale_type

integer ( 03 )

created_at

unixtime

parent_id†

uuid

flags

integer ( 0 )

agent_id

uuid

item_id

uuid

permissions
base_mask

integer ( 0 )

group_mask

integer ( 0 )

last_owner_id

uuid

owner_id

uuid

creator_id

uuid

next_owner_mask

integer ( 0 )

owner_mask

integer ( 0 )

group_id

uuid

everyone_mask

integer ( 0 )

type

integer ( -151 )

desc

string

_links
self
href

uri

name†

enum: self, link

parent
href

uri

name†

enum: self, link

links
uuid
linked_id

uuid

name

string

created_at

unixtime

parent_id

uuid

agent_id

uuid

item_id

uuid

inv_type

integer ( 022 )

type

integer ( 2425 )

desc

string

_links
item
href

uri

name†

enum: self, link

category
href

uri

name†

enum: self, link

self
href

uri

name†

enum: self, link

parent
href

uri

name†

enum: self, link

categories
uuid
name

string

type_default

integer ( -151 )

parent_id

uuid

version

integer ( 1 )

agent_id

uuid

category_id

uuid

_links
self
href

uri

name†

enum: self, link

parent
href

uri

name†

enum: self, link

_embedded
items
uuid
asset_id

uuid

inv_type

integer ( 022 )

name

string

sale_info
sale_price

integer ( 0 )

sale_type

integer ( 03 )

created_at

unixtime

parent_id†

uuid

flags

integer ( 0 )

agent_id

uuid

item_id

uuid

permissions
base_mask

integer ( 0 )

group_mask

integer ( 0 )

last_owner_id

uuid

owner_id

uuid

creator_id

uuid

next_owner_mask

integer ( 0 )

owner_mask

integer ( 0 )

group_id

uuid

everyone_mask

integer ( 0 )

type

integer ( -151 )

desc

string

_links
self
href

uri

name†

enum: self, link

parent
href

uri

name†

enum: self, link

links
uuid
linked_id

uuid

name

string

created_at

unixtime

parent_id

uuid

agent_id

uuid

item_id

uuid

inv_type

integer ( 022 )

type

integer ( 2425 )

desc

string

_links
item
href

uri

name†

enum: self, link

category
href

uri

name†

enum: self, link

self
href

uri

name†

enum: self, link

parent
href

uri

name†

enum: self, link

categories

metaEmbeddedCategoriesWithChildren (recursive)

_links
self
href

uri

name†

enum: self, link

parent
href

uri

name†

enum: self, link

category†
href

uri

name†

enum: self, link

parent
href

uri

name†

enum: self, link

links
href

uri

name†

enum: self, link

items
href

uri

name†

enum: self, link

self
href

uri

name†

enum: self, link

children
href

uri

name†

enum: self, link

categories†
href

uri

name†

enum: self, link

_base_uri

uri

name

string

type_default

integer ( -151 )

parent_id

uuid

version

integer ( 1 )

agent_id

uuid

category_id

uuid

_embedded
links
uuid
_embedded
item
asset_id

uuid

inv_type

integer ( 022 )

name

string

sale_info
sale_price

integer ( 0 )

sale_type

integer ( 03 )

created_at

unixtime

parent_id†

uuid

flags

integer ( 0 )

agent_id

uuid

item_id

uuid

permissions
base_mask

integer ( 0 )

group_mask

integer ( 0 )

last_owner_id

uuid

owner_id

uuid

creator_id

uuid

next_owner_mask

integer ( 0 )

owner_mask

integer ( 0 )

group_id

uuid

everyone_mask

integer ( 0 )

type

integer ( -151 )

desc

string

_links
self
href

uri

name†

enum: self, link

parent
href

uri

name†

enum: self, link

category
name

string

type_default

integer ( -151 )

parent_id

uuid

version

integer ( 1 )

agent_id

uuid

category_id

uuid

_links
self
href

uri

name†

enum: self, link

parent
href

uri

name†

enum: self, link

_broken

boolean

_links
item
href

uri

name†

enum: self, link

category
href

uri

name†

enum: self, link

self
href

uri

name†

enum: self, link

parent
href

uri

name†

enum: self, link

linked_id

uuid

name

string

created_at

unixtime

parent_id

uuid

agent_id

uuid

item_id

uuid

inv_type

integer ( 022 )

type

integer ( 2425 )

desc

string

_created_categories

[ uuid , ... ]

_created_items

[ uuid , ... ]

_updated_category_versions
uuid

integer

Response Headers
Location The URL of the category children containing the created inventory.
400

Description

  • Invalid request

Response Schemas:

errorInvalidLinksShape † - Optional
error_line_number†

integer

error_filename†

string

error_description

string

error_function†

string

invalid_linked_ids†

[ uuid , ... ]

error_code

integer ( 1 )

errorInvalidRequest † - Optional
error_line_number†

integer

error_filename†

string

error_description

string

error_function†

string

error_code

integer ( 0 )

404

Description

  • Category not found

Response Schemas:

errorCategoryNotFound † - Optional
error_line_number†

integer

error_filename†

string

error_description

string

error_function†

string

category_id†

uuid

error_code

integer ( 46 )

409

Description

  • Duplicate transaction.

Response Schemas:

errorDuplicateTransaction † - Optional
error_line_number†

integer

error_filename†

string

error_description

string

error_function†

string

error_code

integer ( 8 )

transaction_id

string

412

Description

  • Precondition failed

Response Schemas:

errorPreconditionFailed † - Optional
error_line_number†

integer

error_filename†

string

error_description

string

error_function†

string

etags

[ string , ... ]

etag

string

error_code

integer ( 10 )

condition

string

Response Headers
ETag Current value of the entity tag for the requested variant.

Category-PUT

Implementation Status

  • COMPLETE

Description

  • Create and retrieve a 'special' category.
Request Headers
If-None-Match (optional) Only process request if none of the supplied entity tags matches resource.
If-Match (optional) Only process request if any supplied entity tags matches resource.
Status Codes
201

Description

  • Category created

Response Schemas:

categoryNewResponse † - Optional
_links
self
href

uri

name†

enum: self, link

parent
href

uri

name†

enum: self, link

category†
href

uri

name†

enum: self, link

parent
href

uri

name†

enum: self, link

links
href

uri

name†

enum: self, link

items
href

uri

name†

enum: self, link

self
href

uri

name†

enum: self, link

children
href

uri

name†

enum: self, link

categories†
href

uri

name†

enum: self, link

_base_uri

uri

name

string

type_default

integer ( -151 )

parent_id

uuid

version

integer ( 1 )

agent_id

uuid

category_id

uuid

_created_categories

[ uuid , ... ]

_updated_category_versions
uuid

integer

Response Headers
Location The URL of the created category
404

Description

  • Category not found

Response Schemas:

errorCategoryNotFound † - Optional
error_line_number†

integer

error_filename†

string

error_description

string

error_function†

string

category_id†

uuid

error_code

integer ( 46 )

409

Description

  • Category already exists

Response Schemas:

categoryResponse † - Optional
_links
self
href

uri

name†

enum: self, link

parent
href

uri

name†

enum: self, link

category†
href

uri

name†

enum: self, link

parent
href

uri

name†

enum: self, link

links
href

uri

name†

enum: self, link

items
href

uri

name†

enum: self, link

self
href

uri

name†

enum: self, link

children
href

uri

name†

enum: self, link

categories†
href

uri

name†

enum: self, link

_base_uri

uri

name

string

type_default

integer ( -151 )

parent_id

uuid

version

integer ( 1 )

agent_id

uuid

category_id

uuid

412

Description

  • Precondition failed

Response Schemas:

errorPreconditionFailed † - Optional
error_line_number†

integer

error_filename†

string

error_description

string

error_function†

string

etags

[ string , ... ]

etag

string

error_code

integer ( 10 )

condition

string

Response Headers
ETag Current value of the entity tag for the requested variant.

Category-PATCH

Implementation Status

  • COMPLETE

Description

  • Modify a category
Request Headers
If-None-Match (optional) Only process request if none of the supplied entity tags matches resource.
If-Match (optional) Only process request if any supplied entity tags matches resource.
Request Schemas
modifyCategory † - Optional
name

string

Status Codes
200

Description

  • Category modified successfully

Response Schemas:

categoryModifyResponse † - Optional
_links
self
href

uri

name†

enum: self, link

parent
href

uri

name†

enum: self, link

category†
href

uri

name†

enum: self, link

parent
href

uri

name†

enum: self, link

links
href

uri

name†

enum: self, link

items
href

uri

name†

enum: self, link

self
href

uri

name†

enum: self, link

children
href

uri

name†

enum: self, link

categories†
href

uri

name†

enum: self, link

_base_uri

uri

name

string

type_default

integer ( -151 )

parent_id

uuid

version

integer ( 1 )

agent_id

uuid

category_id

uuid

_updated_categories

[ uuid , ... ]

_update_result†
server_response†

string

fault_code†

integer

code

integer ( 08 )

message

string

success

boolean

_updated_category_versions
uuid

integer

Response Headers
ETag Current value of the entity tag for the requested variant.
400

Description

  • Invalid request

Response Schemas:

errorInvalidCategoryRequest † - Optional
error_line_number†

integer

error_filename†

string

error_description

string

error_function†

string

category_id†

uuid

error_code

integer ( 0 )

404

Description

  • Category not found

Response Schemas:

errorCategoryNotFound † - Optional
error_line_number†

integer

error_filename†

string

error_description

string

error_function†

string

category_id†

uuid

error_code

integer ( 46 )

412

Description

  • Precondition failed

Response Schemas:

errorPreconditionFailed † - Optional
error_line_number†

integer

error_filename†

string

error_description

string

error_function†

string

etags

[ string , ... ]

etag

string

error_code

integer ( 10 )

condition

string

Response Headers
ETag Current value of the entity tag for the requested variant.

Category-COPY

Implementation Status

  • COMPLETE

Description

  • Copy a category
Request Headers
If-None-Match (optional) Only process request if none of the supplied entity tags matches resource.
Destination Destination category_id or 'special' category.
If-Match (optional) Only process request if any supplied entity tags matches resource.
Status Codes
201

Description

  • Category copied successfully

Response Schemas:

categoryCopyResponse † - Optional
_links
self
href

uri

name†

enum: self, link

parent
href

uri

name†

enum: self, link

category†
href

uri

name†

enum: self, link

parent
href

uri

name†

enum: self, link

links
href

uri

name†

enum: self, link

items
href

uri

name†

enum: self, link

self
href

uri

name†

enum: self, link

children
href

uri

name†

enum: self, link

categories†
href

uri

name†

enum: self, link

_base_uri

uri

name

string

type_default

integer ( -151 )

parent_id

uuid

version

integer ( 1 )

agent_id

uuid

category_id

uuid

_embedded
items
uuid
asset_id

uuid

inv_type

integer ( 022 )

name

string

sale_info
sale_price

integer ( 0 )

sale_type

integer ( 03 )

created_at

unixtime

parent_id†

uuid

flags

integer ( 0 )

agent_id

uuid

item_id

uuid

permissions
base_mask

integer ( 0 )

group_mask

integer ( 0 )

last_owner_id

uuid

owner_id

uuid

creator_id

uuid

next_owner_mask

integer ( 0 )

owner_mask

integer ( 0 )

group_id

uuid

everyone_mask

integer ( 0 )

type

integer ( -151 )

desc

string

_links
self
href

uri

name†

enum: self, link

parent
href

uri

name†

enum: self, link

links
uuid
linked_id

uuid

name

string

created_at

unixtime

parent_id

uuid

agent_id

uuid

item_id

uuid

inv_type

integer ( 022 )

type

integer ( 2425 )

desc

string

_links
item
href

uri

name†

enum: self, link

category
href

uri

name†

enum: self, link

self
href

uri

name†

enum: self, link

parent
href

uri

name†

enum: self, link

categories
uuid
name

string

type_default

integer ( -151 )

parent_id

uuid

version

integer ( 1 )

agent_id

uuid

category_id

uuid

_links
self
href

uri

name†

enum: self, link

parent
href

uri

name†

enum: self, link

_embedded
items
uuid
asset_id

uuid

inv_type

integer ( 022 )

name

string

sale_info
sale_price

integer ( 0 )

sale_type

integer ( 03 )

created_at

unixtime

parent_id†

uuid

flags

integer ( 0 )

agent_id

uuid

item_id

uuid

permissions
base_mask

integer ( 0 )

group_mask

integer ( 0 )

last_owner_id

uuid

owner_id

uuid

creator_id

uuid

next_owner_mask

integer ( 0 )

owner_mask

integer ( 0 )

group_id

uuid

everyone_mask

integer ( 0 )

type

integer ( -151 )

desc

string

_links
self
href

uri

name†

enum: self, link

parent
href

uri

name†

enum: self, link

links
uuid
linked_id

uuid

name

string

created_at

unixtime

parent_id

uuid

agent_id

uuid

item_id

uuid

inv_type

integer ( 022 )

type

integer ( 2425 )

desc

string

_links
item
href

uri

name†

enum: self, link

category
href

uri

name†

enum: self, link

self
href

uri

name†

enum: self, link

parent
href

uri

name†

enum: self, link

categories

metaEmbeddedCategoriesWithChildren (recursive)

_removed_items

[ uuid , ... ]

_top_category_id

uuid

_created_items

[ uuid , ... ]

_moved_items

[ uuid , ... ]

_created_categories

[ uuid , ... ]

_updated_category_versions
uuid

integer

Response Headers
ETag Current value of the entity tag for the requested variant.
Location The URL of the copied inventory.
403

Description

  • Permissions check failed.

Response Schemas:

errorInvalidPermissions † - Optional
error_line_number†

integer

error_filename†

string

error_description

string

error_function†

string

error_code

integer ( 14 )

404

Description

  • Destination category not found.

Response Schemas:

errorCategoryNotFound † - Optional
error_line_number†

integer

error_filename†

string

error_description

string

error_function†

string

category_id†

uuid

error_code

integer ( 46 )

409

Description

  • Duplicate transaction.

Response Schemas:

errorDuplicateTransaction † - Optional
error_line_number†

integer

error_filename†

string

error_description

string

error_function†

string

error_code

integer ( 8 )

transaction_id

string

410

Description

  • Source category gone

Response Schemas:

errorCategoryGone † - Optional
error_line_number†

integer

error_filename†

string

error_description

string

error_function†

string

category_id†

uuid

error_code

integer ( 9 )

412

Description

  • Precondition failed

Response Schemas:

errorPreconditionFailed † - Optional
error_line_number†

integer

error_filename†

string

error_description

string

error_function†

string

etags

[ string , ... ]

etag

string

error_code

integer ( 10 )

condition

string

Response Headers
ETag Current value of the entity tag for the requested variant.

Category-MOVE

Implementation Status

  • NONE

Description

  • Move a category
Request Headers
If-None-Match (optional) Only process request if none of the supplied entity tags matches resource.
Destination Destination category_id.
If-Match (optional) Only process request if any supplied entity tags matches resource.
Status Codes
200

Description

  • Category moved successfully

Response Schemas:

categoryMoveResponse † - Optional
_links
self
href

uri

name†

enum: self, link

parent
href

uri

name†

enum: self, link

category†
href

uri

name†

enum: self, link

parent
href

uri

name†

enum: self, link

links
href

uri

name†

enum: self, link

items
href

uri

name†

enum: self, link

self
href

uri

name†

enum: self, link

children
href

uri

name†

enum: self, link

categories†
href

uri

name†

enum: self, link

_base_uri

uri

name

string

type_default

integer ( -151 )

parent_id

uuid

version

integer ( 1 )

agent_id

uuid

category_id

uuid

_updated_categories

[ uuid , ... ]

_updated_category_versions
uuid

integer

Response Headers
ETag Current value of the entity tag for the requested variant.
Location The URL of the moved inventory.
403

Description

  • Permissions check failed.

Response Schemas:

errorInvalidPermissions † - Optional
error_line_number†

integer

error_filename†

string

error_description

string

error_function†

string

error_code

integer ( 14 )

404

Description

  • Destination category not found.

Response Schemas:

errorCategoryNotFound † - Optional
error_line_number†

integer

error_filename†

string

error_description

string

error_function†

string

category_id†

uuid

error_code

integer ( 46 )

410

Description

  • Source category gone

Response Schemas:

errorCategoryGone † - Optional
error_line_number†

integer

error_filename†

string

error_description

string

error_function†

string

category_id†

uuid

error_code

integer ( 9 )

412

Description

  • Precondition failed

Response Schemas:

errorPreconditionFailed † - Optional
error_line_number†

integer

error_filename†

string

error_description

string

error_function†

string

etags

[ string , ... ]

etag

string

error_code

integer ( 10 )

condition

string

Response Headers
ETag Current value of the entity tag for the requested variant.

Category-DELETE

Implementation Status

  • COMPLETE

Description

  • Delete a category
Request Headers
If-None-Match (optional) Only process request if none of the supplied entity tags matches resource.
If-Match (optional) Only process request if any supplied entity tags matches resource.
Status Codes
200

Description

  • Category deleted successfully

Response Schemas:

categoryDeleteResponse † - Optional
_update_result†
server_response†

string

fault_code†

integer

code

integer ( 08 )

message

string

success

boolean

_attachments_removed
^[0-9]+$

uuid

_active_gestures_removed

[ uuid , ... ]

_broken_links_removed

[ uuid , ... ]

_total_items_removed

integer

_wearables_removed
^[0-9]+$

uuid

_category_items_removed

[ uuid , ... ]

_categories_removed

[ uuid , ... ]

_updated_category_versions
uuid

integer

410

Description

  • Category gone

Response Schemas:

errorCategoryGone † - Optional
error_line_number†

integer

error_filename†

string

error_description

string

error_function†

string

category_id†

uuid

error_code

integer ( 9 )

412

Description

  • Precondition failed

Response Schemas:

errorPreconditionFailed † - Optional
error_line_number†

integer

error_filename†

string

error_description

string

error_function†

string

etags

[ string , ... ]

etag

string

error_code

integer ( 10 )

condition

string

Response Headers
ETag Current value of the entity tag for the requested variant.

CategoryChildren

Description

  • Children in an inventory category.

Path:

  • /category/{category}/children{?tid,depth,simulate}

Parameters

  • category → Category UUID or 'special' category name, e.g. "current".
    • Validation: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
    • Validation: ^(animatn|bodypart|clothing|current|favorite|gesture|inbox|landmark|lsltext)$
    • Validation: ^(lstndfnd|my_otfts|notecard|object|outbox|root|snapshot|sound|texture|trash)$
  • tid → Transaction ID.
  • depth → Category child depth to retrieve.
    • Validation: ^(\*|[0-9]+)?$
  • simulate → Whether or not to skip writing back results.
    • Validation: ^(0|1|true|false)?$

Methods


CategoryChildren-GET

Implementation Status

  • COMPLETE

Description

  • Retrieve children in a category
Request Headers
If-None-Match (optional) Only process request if none of the supplied entity tags matches resource.
If-Match (optional) Only process request if any supplied entity tags matches resource.
Status Codes
200

Description

  • Category children retrieved successfully

Response Schemas:

categoryChildrenResponse † - Optional
_links
self
href

uri

name†

enum: self, link

parent
href

uri

name†

enum: self, link

category†
href

uri

name†

enum: self, link

parent
href

uri

name†

enum: self, link

links
href

uri

name†

enum: self, link

items
href

uri

name†

enum: self, link

self
href

uri

name†

enum: self, link

children
href

uri

name†

enum: self, link

categories†
href

uri

name†

enum: self, link

_base_uri

uri

name

string

type_default

integer ( -151 )

parent_id

uuid

version

integer ( 1 )

agent_id

uuid

category_id

uuid

_embedded
items
uuid
asset_id

uuid

inv_type

integer ( 022 )

name

string

sale_info
sale_price

integer ( 0 )

sale_type

integer ( 03 )

created_at

unixtime

parent_id†

uuid

flags

integer ( 0 )

agent_id

uuid

item_id

uuid

permissions
base_mask

integer ( 0 )

group_mask

integer ( 0 )

last_owner_id

uuid

owner_id

uuid

creator_id

uuid

next_owner_mask

integer ( 0 )

owner_mask

integer ( 0 )

group_id

uuid

everyone_mask

integer ( 0 )

type

integer ( -151 )

desc

string

_links
self
href

uri

name†

enum: self, link

parent
href

uri

name†

enum: self, link

links
uuid
linked_id

uuid

name

string

created_at

unixtime

parent_id

uuid

agent_id

uuid

item_id

uuid

inv_type

integer ( 022 )

type

integer ( 2425 )

desc

string

_links
item
href

uri

name†

enum: self, link

category
href

uri

name†

enum: self, link

self
href

uri

name†

enum: self, link

parent
href

uri

name†

enum: self, link

categories
uuid
name

string

type_default

integer ( -151 )

parent_id

uuid

version

integer ( 1 )

agent_id

uuid

category_id

uuid

_links
self
href

uri

name†

enum: self, link

parent
href

uri

name†

enum: self, link

_embedded
items
uuid
asset_id

uuid

inv_type

integer ( 022 )

name

string

sale_info
sale_price

integer ( 0 )

sale_type

integer ( 03 )

created_at

unixtime

parent_id†

uuid

flags

integer ( 0 )

agent_id

uuid

item_id

uuid

permissions
base_mask

integer ( 0 )

group_mask

integer ( 0 )

last_owner_id

uuid

owner_id

uuid

creator_id

uuid

next_owner_mask

integer ( 0 )

owner_mask

integer ( 0 )

group_id

uuid

everyone_mask

integer ( 0 )

type

integer ( -151 )

desc

string

_links
self
href

uri

name†

enum: self, link

parent
href

uri

name†

enum: self, link

links
uuid
linked_id

uuid

name

string

created_at

unixtime

parent_id

uuid

agent_id

uuid

item_id

uuid

inv_type

integer ( 022 )

type

integer ( 2425 )

desc

string

_links
item
href

uri

name†

enum: self, link

category
href

uri

name†

enum: self, link

self
href

uri

name†

enum: self, link

parent
href

uri

name†

enum: self, link

categories

metaEmbeddedCategoriesWithChildren (recursive)

Response Headers
ETag Current value of the entity tag for the requested variant.
304

Description

  • Not modified

Response Schemas: string

Response Headers
ETag Current value of the entity tag for the requested variant.
404

Description

  • Category not found

Response Schemas:

errorCategoryNotFound † - Optional
error_line_number†

integer

error_filename†

string

error_description

string

error_function†

string

category_id†

uuid

error_code

integer ( 46 )

412

Description

  • Precondition failed

Response Schemas:

errorPreconditionFailed † - Optional
error_line_number†

integer

error_filename†

string

error_description

string

error_function†

string

etags

[ string , ... ]

etag

string

error_code

integer ( 10 )

condition

string

Response Headers
ETag Current value of the entity tag for the requested variant.

CategoryChildren-PUT

Implementation Status

  • NONE

Description

  • Replace category children.
Request Headers
If-None-Match (optional) Only process request if none of the supplied entity tags matches resource.
If-Match (optional) Only process request if any supplied entity tags matches resource.
Request Schemas
newEmbeddedChildren † - Optional
items†

[

asset_id

uuid

inv_type

integer ( 022 )

name

string

sale_info†
sale_price†

integer ( 0 )

sale_type†

integer ( 03 )

flags†

integer ( 0 )

desc†

string

type

integer ( -151 )

permissions†
owner_mask†

integer ( 0 )

base_mask†

integer ( 0 )

next_owner_mask†

integer ( 0 )

group_mask†

integer ( 0 )

everyone_mask†

integer ( 0 )

, ... ]

links†

[

type

integer ( 2425 )

linked_id

uuid

name†

string

desc†

string

, ... ]

categories†

[

_embedded†
items†

[

asset_id

uuid

inv_type

integer ( 022 )

name

string

sale_info†
sale_price†

integer ( 0 )

sale_type†

integer ( 03 )

flags†

integer ( 0 )

desc†

string

type

integer ( -151 )

permissions†
owner_mask†

integer ( 0 )

base_mask†

integer ( 0 )

next_owner_mask†

integer ( 0 )

group_mask†

integer ( 0 )

everyone_mask†

integer ( 0 )

, ... ]

links†

[

type

integer ( 2425 )

linked_id

uuid

name†

string

desc†

string

, ... ]

categories†

[ newCategory (recursive) , ... ]

name

string

type_default†

integer ( -151 )

, ... ]

Status Codes
201

Description

  • Category children replaced

Response Schemas:

categoryChildrenReplaceResponse † - Optional
_links
self
href

uri

name†

enum: self, link

parent
href

uri

name†

enum: self, link

category†
href

uri

name†

enum: self, link

parent
href

uri

name†

enum: self, link

links
href

uri

name†

enum: self, link

items
href

uri

name†

enum: self, link

self
href

uri

name†

enum: self, link

children
href

uri

name†

enum: self, link

categories†
href

uri

name†

enum: self, link

_base_uri

uri

name

string

type_default

integer ( -151 )

parent_id

uuid

version

integer ( 1 )

agent_id

uuid

category_id

uuid

_embedded
items
uuid
asset_id

uuid

inv_type

integer ( 022 )

name

string

sale_info
sale_price

integer ( 0 )

sale_type

integer ( 03 )

created_at

unixtime

parent_id†

uuid

flags

integer ( 0 )

agent_id

uuid

item_id

uuid

permissions
base_mask

integer ( 0 )

group_mask

integer ( 0 )

last_owner_id

uuid

owner_id

uuid

creator_id

uuid

next_owner_mask

integer ( 0 )

owner_mask

integer ( 0 )

group_id

uuid

everyone_mask

integer ( 0 )

type

integer ( -151 )

desc

string

_links
self
href

uri

name†

enum: self, link

parent
href

uri

name†

enum: self, link

links
uuid
linked_id

uuid

name

string

created_at

unixtime

parent_id

uuid

agent_id

uuid

item_id

uuid

inv_type

integer ( 022 )

type

integer ( 2425 )

desc

string

_links
item
href

uri

name†

enum: self, link

category
href

uri

name†

enum: self, link

self
href

uri

name†

enum: self, link

parent
href

uri

name†

enum: self, link

categories
uuid
name

string

type_default

integer ( -151 )

parent_id

uuid

version

integer ( 1 )

agent_id

uuid

category_id

uuid

_links
self
href

uri

name†

enum: self, link

parent
href

uri

name†

enum: self, link

_embedded
items
uuid
asset_id

uuid

inv_type

integer ( 022 )

name

string

sale_info
sale_price

integer ( 0 )

sale_type

integer ( 03 )

created_at

unixtime

parent_id†

uuid

flags

integer ( 0 )

agent_id

uuid

item_id

uuid

permissions
base_mask

integer ( 0 )

group_mask

integer ( 0 )

last_owner_id

uuid

owner_id

uuid

creator_id

uuid

next_owner_mask

integer ( 0 )

owner_mask

integer ( 0 )

group_id

uuid

everyone_mask

integer ( 0 )

type

integer ( -151 )

desc

string

_links
self
href

uri

name†

enum: self, link

parent
href

uri

name†

enum: self, link

links
uuid
linked_id

uuid

name

string

created_at

unixtime

parent_id

uuid

agent_id

uuid

item_id

uuid

inv_type

integer ( 022 )

type

integer ( 2425 )

desc

string

_links
item
href

uri

name†

enum: self, link

category
href

uri

name†

enum: self, link

self
href

uri

name†

enum: self, link

parent
href

uri

name†

enum: self, link

categories

metaEmbeddedCategoriesWithChildren (recursive)

_attachments_removed
^[0-9]+$

uuid

_active_gestures_removed

[ uuid , ... ]

_broken_links_removed

[ uuid , ... ]

_total_items_removed

integer

_created_items

[ uuid , ... ]

_wearables_removed
^[0-9]+$

uuid

_created_categories

[ uuid , ... ]

_categories_removed

[ uuid , ... ]

_updated_category_versions
uuid

integer

Response Headers
ETag Current value of the entity tag for the requested variant.
Location The URL of the replaced category children.
404

Description

  • Category not found

Response Schemas:

errorCategoryNotFound † - Optional
error_line_number†

integer

error_filename†

string

error_description

string

error_function†

string

category_id†

uuid

error_code

integer ( 46 )

412

Description

  • Precondition failed

Response Schemas:

errorPreconditionFailed † - Optional
error_line_number†

integer

error_filename†

string

error_description

string

error_function†

string

etags

[ string , ... ]

etag

string

error_code

integer ( 10 )

condition

string

Response Headers
ETag Current value of the entity tag for the requested variant.

CategoryChildren-COPY

Implementation Status

  • NONE

Description

  • Copy category children
Request Headers
If-None-Match (optional) Only process request if none of the supplied entity tags matches resource.
Destination Destination category_id or 'special' category.
If-Match (optional) Only process request if any supplied entity tags matches resource.
Status Codes
201

Description

  • Category children copied successfully

Response Schemas:

categoryCopyResponse † - Optional
_links
self
href

uri

name†

enum: self, link

parent
href

uri

name†

enum: self, link

category†
href

uri

name†

enum: self, link

parent
href

uri

name†

enum: self, link

links
href

uri

name†

enum: self, link

items
href

uri

name†

enum: self, link

self
href

uri

name†

enum: self, link

children
href

uri

name†

enum: self, link

categories†
href

uri

name†

enum: self, link

_base_uri

uri

name

string

type_default

integer ( -151 )

parent_id

uuid

version

integer ( 1 )

agent_id

uuid

category_id

uuid

_embedded
items
uuid
asset_id

uuid

inv_type

integer ( 022 )

name

string

sale_info
sale_price

integer ( 0 )

sale_type

integer ( 03 )

created_at

unixtime

parent_id†

uuid

flags

integer ( 0 )

agent_id

uuid

item_id

uuid

permissions
base_mask

integer ( 0 )

group_mask

integer ( 0 )

last_owner_id

uuid

owner_id

uuid

creator_id

uuid

next_owner_mask

integer ( 0 )

owner_mask

integer ( 0 )

group_id

uuid

everyone_mask

integer ( 0 )

type

integer ( -151 )

desc

string

_links
self
href

uri

name†

enum: self, link

parent
href

uri

name†

enum: self, link

links
uuid
linked_id

uuid

name

string

created_at

unixtime

parent_id

uuid

agent_id

uuid

item_id

uuid

inv_type

integer ( 022 )

type

integer ( 2425 )

desc

string

_links
item
href

uri

name†

enum: self, link

category
href

uri

name†

enum: self, link

self
href

uri

name†

enum: self, link

parent
href

uri

name†

enum: self, link

categories
uuid
name

string

type_default

integer ( -151 )

parent_id

uuid

version

integer ( 1 )

agent_id

uuid

category_id

uuid

_links
self
href

uri

name†

enum: self, link

parent
href

uri

name†

enum: self, link

_embedded
items
uuid
asset_id

uuid

inv_type

integer ( 022 )

name

string

sale_info
sale_price

integer ( 0 )

sale_type

integer ( 03 )

created_at

unixtime

parent_id†

uuid

flags

integer ( 0 )

agent_id

uuid

item_id

uuid

permissions
base_mask

integer ( 0 )

group_mask

integer ( 0 )

last_owner_id

uuid

owner_id

uuid

creator_id

uuid

next_owner_mask

integer ( 0 )

owner_mask

integer ( 0 )

group_id

uuid

everyone_mask

integer ( 0 )

type

integer ( -151 )

desc

string

_links
self
href

uri

name†

enum: self, link

parent
href

uri

name†

enum: self, link

links
uuid
linked_id

uuid

name

string

created_at

unixtime

parent_id

uuid

agent_id

uuid

item_id

uuid

inv_type

integer ( 022 )

type

integer ( 2425 )

desc

string

_links
item
href

uri

name†

enum: self, link

category
href

uri

name†

enum: self, link

self
href

uri

name†

enum: self, link

parent
href

uri

name†

enum: self, link

categories

metaEmbeddedCategoriesWithChildren (recursive)

_removed_items

[ uuid , ... ]

_top_category_id

uuid

_created_items

[ uuid , ... ]

_moved_items

[ uuid , ... ]

_created_categories

[ uuid , ... ]

_updated_category_versions
uuid

integer

Response Headers
ETag Current value of the entity tag for the requested variant.
Location The URL of the copied inventory.
403

Description

  • Permissions check failed.

Response Schemas:

errorInvalidPermissions † - Optional
error_line_number†

integer

error_filename†

string

error_description

string

error_function†

string

error_code

integer ( 14 )

404

Description

  • Destination category not found.

Response Schemas:

errorCategoryNotFound † - Optional
error_line_number†

integer

error_filename†

string

error_description

string

error_function†

string

category_id†

uuid

error_code

integer ( 46 )

410

Description

  • Source category gone

Response Schemas:

errorCategoryGone † - Optional
error_line_number†

integer

error_filename†

string

error_description

string

error_function†

string

category_id†

uuid

error_code

integer ( 9 )

412

Description

  • Precondition failed

Response Schemas:

errorPreconditionFailed † - Optional
error_line_number†

integer

error_filename†

string

error_description

string

error_function†

string

etags

[ string , ... ]

etag

string

error_code

integer ( 10 )

condition

string

Response Headers
ETag Current value of the entity tag for the requested variant.

CategoryChildren-MOVE

Implementation Status

  • NONE

Description

  • Move category children
Request Headers
If-None-Match (optional) Only process request if none of the supplied entity tags matches resource.
Destination Destination category_id.
If-Match (optional) Only process request if any supplied entity tags matches resource.
Status Codes
200

Description

  • Category children moved successfully

Response Schemas:

categoryChildrenMoveResponse † - Optional
_links
self
href

uri

name†

enum: self, link

parent
href

uri

name†

enum: self, link

category†
href

uri

name†

enum: self, link

parent
href

uri

name†

enum: self, link

links
href

uri

name†

enum: self, link

items
href

uri

name†

enum: self, link

self
href

uri

name†

enum: self, link

children
href

uri

name†

enum: self, link

categories†
href

uri

name†

enum: self, link

_base_uri

uri

name

string

type_default

integer ( -151 )

parent_id

uuid

version

integer ( 1 )

agent_id

uuid

category_id

uuid

_embedded
items
uuid
asset_id

uuid

inv_type

integer ( 022 )

name

string

sale_info
sale_price

integer ( 0 )

sale_type

integer ( 03 )

created_at

unixtime

parent_id†

uuid

flags

integer ( 0 )

agent_id

uuid

item_id

uuid

permissions
base_mask

integer ( 0 )

group_mask

integer ( 0 )

last_owner_id

uuid

owner_id

uuid

creator_id

uuid

next_owner_mask

integer ( 0 )

owner_mask

integer ( 0 )

group_id

uuid

everyone_mask

integer ( 0 )

type

integer ( -151 )

desc

string

_links
self
href

uri

name†

enum: self, link

parent
href

uri

name†

enum: self, link

links
uuid
linked_id

uuid

name

string

created_at

unixtime

parent_id

uuid

agent_id

uuid

item_id

uuid

inv_type

integer ( 022 )

type

integer ( 2425 )

desc

string

_links
item
href

uri

name†

enum: self, link

category
href

uri

name†

enum: self, link

self
href

uri

name†

enum: self, link

parent
href

uri

name†

enum: self, link

categories
uuid
name

string

type_default

integer ( -151 )

parent_id

uuid

version

integer ( 1 )

agent_id

uuid

category_id

uuid

_links
self
href

uri

name†

enum: self, link

parent
href

uri

name†

enum: self, link

_embedded
items
uuid
asset_id

uuid

inv_type

integer ( 022 )

name

string

sale_info
sale_price

integer ( 0 )

sale_type

integer ( 03 )

created_at

unixtime

parent_id†

uuid

flags

integer ( 0 )

agent_id

uuid

item_id

uuid

permissions
base_mask

integer ( 0 )

group_mask

integer ( 0 )

last_owner_id

uuid

owner_id

uuid

creator_id

uuid

next_owner_mask

integer ( 0 )

owner_mask

integer ( 0 )

group_id

uuid

everyone_mask

integer ( 0 )

type

integer ( -151 )

desc

string

_links
self
href

uri

name†

enum: self, link

parent
href

uri

name†

enum: self, link

links
uuid
linked_id

uuid

name

string

created_at

unixtime

parent_id

uuid

agent_id

uuid

item_id

uuid

inv_type

integer ( 022 )

type

integer ( 2425 )

desc

string

_links
item
href

uri

name†

enum: self, link

category
href

uri

name†

enum: self, link

self
href

uri

name†

enum: self, link

parent
href

uri

name†

enum: self, link

categories

metaEmbeddedCategoriesWithChildren (recursive)

_updated_items

[ uuid , ... ]

_updated_categories

[ uuid , ... ]

_updated_category_versions
uuid

integer

Response Headers
ETag Current value of the entity tag for the requested variant.
Location The URL of the moved inventory.
403

Description

  • Permissions check failed.

Response Schemas:

errorInvalidPermissions † - Optional
error_line_number†

integer

error_filename†

string

error_description

string

error_function†

string

error_code

integer ( 14 )

404

Description

  • Destination category not found.

Response Schemas:

errorCategoryNotFound † - Optional
error_line_number†

integer

error_filename†

string

error_description

string

error_function†

string

category_id†

uuid

error_code

integer ( 46 )

410

Description

  • Source category gone

Response Schemas:

errorCategoryGone † - Optional
error_line_number†

integer

error_filename†

string

error_description

string

error_function†

string

category_id†

uuid

error_code

integer ( 9 )

412

Description

  • Precondition failed

Response Schemas:

errorPreconditionFailed † - Optional
error_line_number†

integer

error_filename†

string

error_description

string

error_function†

string

etags

[ string , ... ]

etag

string

error_code

integer ( 10 )

condition

string

Response Headers
ETag Current value of the entity tag for the requested variant.

CategoryChildren-DELETE

Implementation Status

  • COMPLETE

Description

  • Delete category children
Request Headers
If-None-Match (optional) Only process request if none of the supplied entity tags matches resource.
If-Match (optional) Only process request if any supplied entity tags matches resource.
Status Codes
200

Description

  • Category children deleted successfully

Response Schemas:

categoryDeleteResponse † - Optional
_update_result†
server_response†

string

fault_code†

integer

code

integer ( 08 )

message

string

success

boolean

_attachments_removed
^[0-9]+$

uuid

_active_gestures_removed

[ uuid , ... ]

_broken_links_removed

[ uuid , ... ]

_total_items_removed

integer

_wearables_removed
^[0-9]+$

uuid

_category_items_removed

[ uuid , ... ]

_categories_removed

[ uuid , ... ]

_updated_category_versions
uuid

integer

410

Description

  • Category gone

Response Schemas:

errorCategoryGone † - Optional
error_line_number†

integer

error_filename†

string

error_description

string

error_function†

string

category_id†

uuid

error_code

integer ( 9 )

412

Description

  • Precondition failed

Response Schemas:

errorPreconditionFailed † - Optional
error_line_number†

integer

error_filename†

string

error_description

string

error_function†

string

etags

[ string , ... ]

etag

string

error_code

integer ( 10 )

condition

string

Response Headers
ETag Current value of the entity tag for the requested variant.

CategoryLinks

Description

  • Links in an inventory category.

Path:

  • /category/{category}/links{?tid,simulate}

Parameters

  • category → Category UUID or 'special' category name, e.g. "current".
    • Validation: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
    • Validation: ^(animatn|bodypart|clothing|current|favorite|gesture|inbox|landmark|lsltext)$
    • Validation: ^(lstndfnd|my_otfts|notecard|object|outbox|root|snapshot|sound|texture|trash)$
  • tid → Transaction ID.
  • simulate → Whether or not to skip writing back results.
    • Validation: ^(0|1|true|false)?$

Methods


CategoryLinks-GET

Implementation Status

  • COMPLETE

Description

  • Retrieve links in a category
Status Codes

Description

  • Category links retrieved successfully

Response Schemas:

categoryLinksResponse † - Optional
_links
self
href

uri

name†

enum: self, link

parent
href

uri

name†

enum: self, link

category†
href

uri

name†

enum: self, link

parent
href

uri

name†

enum: self, link

links
href

uri

name†

enum: self, link

items
href

uri

name†

enum: self, link

self
href

uri

name†

enum: self, link

children
href

uri

name†

enum: self, link

categories†
href

uri

name†

enum: self, link

_base_uri

uri

name

string

type_default

integer ( -151 )

parent_id

uuid

version

integer ( 1 )

agent_id

uuid

category_id

uuid

_embedded
links
uuid
_embedded
item
asset_id

uuid

inv_type

integer ( 022 )

name

string

sale_info
sale_price

integer ( 0 )

sale_type

integer ( 03 )

created_at

unixtime

parent_id†

uuid

flags

integer ( 0 )

agent_id

uuid

item_id

uuid

permissions
base_mask

integer ( 0 )

group_mask

integer ( 0 )

last_owner_id

uuid

owner_id

uuid

creator_id

uuid

next_owner_mask

integer ( 0 )

owner_mask

integer ( 0 )

group_id

uuid

everyone_mask

integer ( 0 )

type

integer ( -151 )

desc

string

_links
self
href

uri

name†

enum: self, link

parent
href

uri

name†

enum: self, link

category
name

string

type_default

integer ( -151 )

parent_id

uuid

version

integer ( 1 )

agent_id

uuid

category_id

uuid

_links
self
href

uri

name†

enum: self, link

parent
href

uri

name†

enum: self, link

_broken

boolean

_links
item
href

uri

name†

enum: self, link

category
href

uri

name†

enum: self, link

self
href

uri

name†

enum: self, link

parent
href

uri

name†

enum: self, link

linked_id

uuid

name

string

created_at

unixtime

parent_id

uuid

agent_id

uuid

item_id

uuid

inv_type

integer ( 022 )

type

integer ( 2425 )

desc

string

Description

  • Category not found

Response Schemas:

errorCategoryNotFound † - Optional
error_line_number†

integer

error_filename†

string

error_description

string

error_function†

string

category_id†

uuid

error_code

integer ( 46 )


CategoryLinks-PUT

Implementation Status

  • COMPLETE

Description

  • Replace category links.
Request Schemas

[

replaceCategoryLinks † - Optional
type

integer ( 2425 )

linked_id

uuid

name†

string

desc†

string

, ... ]

Status Codes

Description

  • Category links replaced

Response Schemas:

categoryLinksReplaceResponse † - Optional
_links
self
href

uri

name†

enum: self, link

parent
href

uri

name†

enum: self, link

category†
href

uri

name†

enum: self, link

parent
href

uri

name†

enum: self, link

links
href

uri

name†

enum: self, link

items
href

uri

name†

enum: self, link

self
href

uri

name†

enum: self, link

children
href

uri

name†

enum: self, link

categories†
href

uri

name†

enum: self, link

_base_uri

uri

name

string

type_default

integer ( -151 )

parent_id

uuid

version

integer ( 1 )

agent_id

uuid

category_id

uuid

_embedded
links
uuid
_embedded
item
asset_id

uuid

inv_type

integer ( 022 )

name

string

sale_info
sale_price

integer ( 0 )

sale_type

integer ( 03 )

created_at

unixtime

parent_id†

uuid

flags

integer ( 0 )

agent_id

uuid

item_id

uuid

permissions
base_mask

integer ( 0 )

group_mask

integer ( 0 )

last_owner_id

uuid

owner_id

uuid

creator_id

uuid

next_owner_mask

integer ( 0 )

owner_mask

integer ( 0 )

group_id

uuid

everyone_mask

integer ( 0 )

type

integer ( -151 )

desc

string

_links
self
href

uri

name†

enum: self, link

parent
href

uri

name†

enum: self, link

category
name

string

type_default

integer ( -151 )

parent_id

uuid

version

integer ( 1 )

agent_id

uuid

category_id

uuid

_links
self
href

uri

name†

enum: self, link

parent
href

uri

name†

enum: self, link

_broken

boolean

_links
item
href

uri

name†

enum: self, link

category
href

uri

name†

enum: self, link

self
href

uri

name†

enum: self, link

parent
href

uri

name†

enum: self, link

linked_id

uuid

name

string

created_at

unixtime

parent_id

uuid

agent_id

uuid

item_id

uuid

inv_type

integer ( 022 )

type

integer ( 2425 )

desc

string

_linked_ids
uuid

uuid

_updated_items

[ uuid , ... ]

_category_items_removed

[ uuid , ... ]

_created_items

[ uuid , ... ]

_updated_category_versions
uuid

integer

Response Headers
Location The URL of the replaced category links.

Description

  • Invalid request

Response Schemas:

errorInvalidLinksShape † - Optional
error_line_number†

integer

error_filename†

string

error_description

string

error_function†

string

invalid_linked_ids†

[ uuid , ... ]

error_code

integer ( 1 )

errorInvalidRequest † - Optional
error_line_number†

integer

error_filename†

string

error_description

string

error_function†

string

error_code

integer ( 0 )

Description

  • Category not found

Response Schemas:

errorCategoryNotFound † - Optional
error_line_number†

integer

error_filename†

string

error_description

string

error_function†

string

category_id†

uuid

error_code

integer ( 46 )


CategoryLinks-COPY

Implementation Status

  • NONE

Description

  • Copy category links
Request Headers
Destination Destination category_id or 'special' category.
Status Codes

Description

  • Category links copied successfully

Response Schemas:

categoryLinksCopyResponse † - Optional
_links
self
href

uri

name†

enum: self, link

parent
href

uri

name†

enum: self, link

category†
href

uri

name†

enum: self, link

parent
href

uri

name†

enum: self, link

links
href

uri

name†

enum: self, link

items
href

uri

name†

enum: self, link

self
href

uri

name†

enum: self, link

children
href

uri

name†

enum: self, link

categories†
href

uri

name†

enum: self, link

_base_uri

uri

name

string

type_default

integer ( -151 )

parent_id

uuid

version

integer ( 1 )

agent_id

uuid

category_id

uuid

_embedded
links
uuid
_embedded
item
asset_id

uuid

inv_type

integer ( 022 )

name

string

sale_info
sale_price

integer ( 0 )

sale_type

integer ( 03 )

created_at

unixtime

parent_id†

uuid

flags

integer ( 0 )

agent_id

uuid

item_id

uuid

permissions
base_mask

integer ( 0 )

group_mask

integer ( 0 )

last_owner_id

uuid

owner_id

uuid

creator_id

uuid

next_owner_mask

integer ( 0 )

owner_mask

integer ( 0 )

group_id

uuid

everyone_mask

integer ( 0 )

type

integer ( -151 )

desc

string

_links
self
href

uri

name†

enum: self, link

parent
href

uri

name†

enum: self, link

category
name

string

type_default

integer ( -151 )

parent_id

uuid

version

integer ( 1 )

agent_id

uuid

category_id

uuid

_links
self
href

uri

name†

enum: self, link

parent
href

uri

name†

enum: self, link

_broken

boolean

_links
item
href

uri

name†

enum: self, link

category
href

uri

name†

enum: self, link

self
href

uri

name†

enum: self, link

parent
href

uri

name†

enum: self, link

linked_id

uuid

name

string

created_at

unixtime

parent_id

uuid

agent_id

uuid

item_id

uuid

inv_type

integer ( 022 )

type

integer ( 2425 )

desc

string

_created_items

[ uuid , ... ]

_updated_category_versions
uuid

integer

Response Headers
Location The URL of the copied inventory.

Description

  • Permissions check failed.

Response Schemas:

errorInvalidPermissions † - Optional
error_line_number†

integer

error_filename†

string

error_description

string

error_function†

string

error_code

integer ( 14 )

Description

  • Destination category not found.

Response Schemas:

errorCategoryNotFound † - Optional
error_line_number†

integer

error_filename†

string

error_description

string

error_function†

string

category_id†

uuid

error_code

integer ( 46 )

Description

  • Source category gone

Response Schemas:

errorCategoryGone † - Optional
error_line_number†

integer

error_filename†

string

error_description

string

error_function†

string

category_id†

uuid

error_code

integer ( 9 )


CategoryLinks-MOVE

Implementation Status

  • NONE

Description

  • Move category links
Request Headers
Destination Destination category_id.
Status Codes

Description

  • Category links moved successfully

Response Schemas:

categoryLinksMoveResponse † - Optional
_links
self
href

uri

name†

enum: self, link

parent
href

uri

name†

enum: self, link

category†
href

uri

name†

enum: self, link

parent
href

uri

name†

enum: self, link

links
href

uri

name†

enum: self, link

items
href

uri

name†

enum: self, link

self
href

uri

name†

enum: self, link

children
href

uri

name†

enum: self, link

categories†
href

uri

name†

enum: self, link

_base_uri

uri

name

string

type_default

integer ( -151 )

parent_id

uuid

version

integer ( 1 )

agent_id

uuid

category_id

uuid

_embedded
links
uuid
_embedded
item
asset_id

uuid

inv_type

integer ( 022 )

name

string

sale_info
sale_price

integer ( 0 )

sale_type

integer ( 03 )

created_at

unixtime

parent_id†

uuid

flags

integer ( 0 )

agent_id

uuid

item_id

uuid

permissions
base_mask

integer ( 0 )

group_mask

integer ( 0 )

last_owner_id

uuid

owner_id

uuid

creator_id

uuid

next_owner_mask

integer ( 0 )

owner_mask

integer ( 0 )

group_id

uuid

everyone_mask

integer ( 0 )

type

integer ( -151 )

desc

string

_links
self
href

uri

name†

enum: self, link

parent
href

uri

name†

enum: self, link

category
name

string

type_default

integer ( -151 )

parent_id

uuid

version

integer ( 1 )

agent_id

uuid

category_id

uuid

_links
self
href

uri

name†

enum: self, link

parent
href

uri

name†

enum: self, link

_broken

boolean

_links
item
href

uri

name†

enum: self, link

category
href

uri

name†

enum: self, link

self
href

uri

name†

enum: self, link

parent
href

uri

name†

enum: self, link

linked_id

uuid

name

string

created_at

unixtime

parent_id

uuid

agent_id

uuid

item_id

uuid

inv_type

integer ( 022 )

type

integer ( 2425 )

desc

string

_updated_items

[ uuid , ... ]

_updated_category_versions
uuid

integer

Response Headers
Location The URL of the moved inventory.

Description

  • Permissions check failed.

Response Schemas:

errorInvalidPermissions † - Optional
error_line_number†

integer

error_filename†

string

error_description

string

error_function†

string

error_code

integer ( 14 )

Description

  • Destination category not found.

Response Schemas:

errorCategoryNotFound † - Optional
error_line_number†

integer

error_filename†

string

error_description

string

error_function†

string

category_id†

uuid

error_code

integer ( 46 )

Description

  • Source category gone

Response Schemas:

errorCategoryGone † - Optional
error_line_number†

integer

error_filename†

string

error_description

string

error_function†

string

category_id†

uuid

error_code

integer ( 9 )


CategoryLinks-DELETE

Implementation Status

  • COMPLETE

Description

  • Delete category links
Status Codes

Description

  • Category links deleted successfully

Response Schemas:

categoryLinksDeleteResponse † - Optional
_category_items_removed

[ uuid , ... ]

_updated_category_versions
uuid

integer

Description

  • Category gone

Response Schemas:

errorCategoryGone † - Optional
error_line_number†

integer

error_filename†

string

error_description

string

error_function†

string

category_id†

uuid

error_code

integer ( 9 )


CategoryItems

Description

  • Items in an inventory category.

Path:

  • /category/{category}/items{?tid,simulate}

Parameters

  • category → Category UUID or 'special' category name, e.g. "current".
    • Validation: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
    • Validation: ^(animatn|bodypart|clothing|current|favorite|gesture|inbox|landmark|lsltext)$
    • Validation: ^(lstndfnd|my_otfts|notecard|object|outbox|root|snapshot|sound|texture|trash)$
  • tid → Transaction ID.
  • simulate → Whether or not to skip writing back results.
    • Validation: ^(0|1|true|false)?$

Methods


CategoryItems-GET

Implementation Status

  • COMPLETE

Description

  • Retrieve items in a category
Status Codes
200

Description

  • Category items retrieved successfully

Response Schemas:

categoryItemsResponse † - Optional
_links
self
href

uri

name†

enum: self, link

parent
href

uri

name†

enum: self, link

category†
href

uri

name†

enum: self, link

parent
href

uri

name†

enum: self, link

links
href

uri

name†

enum: self, link

items
href

uri

name†

enum: self, link

self
href

uri

name†

enum: self, link

children
href

uri

name†

enum: self, link

categories†
href

uri

name†

enum: self, link

_base_uri

uri

name

string

type_default

integer ( -151 )

parent_id

uuid

version

integer ( 1 )

agent_id

uuid

category_id

uuid

_embedded
items
uuid
asset_id

uuid

inv_type

integer ( 022 )

name

string

sale_info
sale_price

integer ( 0 )

sale_type

integer ( 03 )

created_at

unixtime

parent_id†

uuid

flags

integer ( 0 )

agent_id

uuid

item_id

uuid

permissions
base_mask

integer ( 0 )

group_mask

integer ( 0 )

last_owner_id

uuid

owner_id

uuid

creator_id

uuid

next_owner_mask

integer ( 0 )

owner_mask

integer ( 0 )

group_id

uuid

everyone_mask

integer ( 0 )

type

integer ( -151 )

desc

string

_links
self
href

uri

name†

enum: self, link

parent
href

uri

name†

enum: self, link

links
uuid
linked_id

uuid

name

string

created_at

unixtime

parent_id

uuid

agent_id

uuid

item_id

uuid

inv_type

integer ( 022 )

type

integer ( 2425 )

desc

string

_links
item
href

uri

name†

enum: self, link

category
href

uri

name†

enum: self, link

self
href

uri

name†

enum: self, link

parent
href

uri

name†

enum: self, link

Response Headers
ETag Current value of the entity tag for the requested variant.
304

Description

  • Not modified

Response Schemas: string

Response Headers
ETag Current value of the entity tag for the requested variant.
404

Description

  • Category not found

Response Schemas:

errorCategoryNotFound † - Optional
error_line_number†

integer

error_filename†

string

error_description

string

error_function†

string

category_id†

uuid

error_code

integer ( 46 )

412

Description

  • Precondition failed

Response Schemas:

errorPreconditionFailed † - Optional
error_line_number†

integer

error_filename†

string

error_description

string

error_function†

string

etags

[ string , ... ]

etag

string

error_code

integer ( 10 )

condition

string

Response Headers
ETag Current value of the entity tag for the requested variant.

CategoryItems-PUT

Implementation Status

  • NONE

Description

  • Replace category items.
Request Headers
If-None-Match (optional) Only process request if none of the supplied entity tags matches resource.
If-Match (optional) Only process request if any supplied entity tags matches resource.
Request Schemas
replaceCategoryItems † - Optional
items†

[

asset_id

uuid

inv_type

integer ( 022 )

name

string

sale_info†
sale_price†

integer ( 0 )

sale_type†

integer ( 03 )

flags†

integer ( 0 )

desc†

string

type

integer ( -151 )

permissions†
owner_mask†

integer ( 0 )

base_mask†

integer ( 0 )

next_owner_mask†

integer ( 0 )

group_mask†

integer ( 0 )

everyone_mask†

integer ( 0 )

, ... ]

links†

[

type

integer ( 2425 )

linked_id

uuid

name†

string

desc†

string

, ... ]

Status Codes
201

Description

  • Category items replaced

Response Schemas:

categoryItemsReplaceResponse † - Optional
_links
self
href

uri

name†

enum: self, link

parent
href

uri

name†

enum: self, link

category†
href

uri

name†

enum: self, link

parent
href

uri

name†

enum: self, link

links
href

uri

name†

enum: self, link

items
href

uri

name†

enum: self, link

self
href

uri

name†

enum: self, link

children
href

uri

name†

enum: self, link

categories†
href

uri

name†

enum: self, link

_base_uri

uri

name

string

type_default

integer ( -151 )

parent_id

uuid

version

integer ( 1 )

agent_id

uuid

category_id

uuid

_embedded
items
uuid
asset_id

uuid

inv_type

integer ( 022 )

name

string

sale_info
sale_price

integer ( 0 )

sale_type

integer ( 03 )

created_at

unixtime

parent_id†

uuid

flags

integer ( 0 )

agent_id

uuid

item_id

uuid

permissions
base_mask

integer ( 0 )

group_mask

integer ( 0 )

last_owner_id

uuid

owner_id

uuid

creator_id

uuid

next_owner_mask

integer ( 0 )

owner_mask

integer ( 0 )

group_id

uuid

everyone_mask

integer ( 0 )

type

integer ( -151 )

desc

string

_links
self
href

uri

name†

enum: self, link

parent
href

uri

name†

enum: self, link

links
uuid
linked_id

uuid

name

string

created_at

unixtime

parent_id

uuid

agent_id

uuid

item_id

uuid

inv_type

integer ( 022 )

type

integer ( 2425 )

desc

string

_links
item
href

uri

name†

enum: self, link

category
href

uri

name†

enum: self, link

self
href

uri

name†

enum: self, link

parent
href

uri

name†

enum: self, link

_attachments_removed
^[0-9]+$

uuid

_linked_ids
uuid

uuid

_active_gestures_removed

[ uuid , ... ]

_broken_links_removed

[ uuid , ... ]

_created_items

[ uuid , ... ]

_wearables_removed
^[0-9]+$

uuid

_updated_items

[ uuid , ... ]

_category_items_removed

[ uuid , ... ]

_updated_category_versions
uuid

integer

Response Headers
ETag Current value of the entity tag for the requested variant.
Location The URL of the replaced category items.
404

Description

  • Category not found

Response Schemas:

errorCategoryNotFound † - Optional
error_line_number†

integer

error_filename†

string

error_description

string

error_function†

string

category_id†

uuid

error_code

integer ( 46 )

412

Description

  • Precondition failed

Response Schemas:

errorPreconditionFailed † - Optional
error_line_number†

integer

error_filename†

string

error_description

string

error_function†

string

etags

[ string , ... ]

etag

string

error_code

integer ( 10 )

condition

string

Response Headers
ETag Current value of the entity tag for the requested variant.

CategoryItems-COPY

Implementation Status

  • NONE

Description

  • Copy category items
Request Headers
If-None-Match (optional) Only process request if none of the supplied entity tags matches resource.
Destination Destination category_id or 'special' category.
If-Match (optional) Only process request if any supplied entity tags matches resource.
Status Codes
201

Description

  • Category items copied successfully

Response Schemas:

categoryItemsCopyResponse † - Optional
_links
self
href

uri

name†

enum: self, link

parent
href

uri

name†

enum: self, link

category†
href

uri

name†

enum: self, link

parent
href

uri

name†

enum: self, link

links
href

uri

name†

enum: self, link

items
href

uri

name†

enum: self, link

self
href

uri

name†

enum: self, link

children
href

uri

name†

enum: self, link

categories†
href

uri

name†

enum: self, link

_base_uri

uri

name

string

type_default

integer ( -151 )

parent_id

uuid

version

integer ( 1 )

agent_id

uuid

category_id

uuid

_embedded
items
uuid
asset_id

uuid

inv_type

integer ( 022 )

name

string

sale_info
sale_price

integer ( 0 )

sale_type

integer ( 03 )

created_at

unixtime

parent_id†

uuid

flags

integer ( 0 )

agent_id

uuid

item_id

uuid

permissions
base_mask

integer ( 0 )

group_mask

integer ( 0 )

last_owner_id

uuid

owner_id

uuid

creator_id

uuid

next_owner_mask

integer ( 0 )

owner_mask

integer ( 0 )

group_id

uuid

everyone_mask

integer ( 0 )

type

integer ( -151 )

desc

string

_links
self
href

uri

name†

enum: self, link

parent
href

uri

name†

enum: self, link

links
uuid
linked_id

uuid

name

string

created_at

unixtime

parent_id

uuid

agent_id

uuid

item_id

uuid

inv_type

integer ( 022 )

type

integer ( 2425 )

desc

string

_links
item
href

uri

name†

enum: self, link

category
href

uri

name†

enum: self, link

self
href

uri

name†

enum: self, link

parent
href

uri

name†

enum: self, link

_created_items

[ uuid , ... ]

_updated_category_versions
uuid

integer

Response Headers
ETag Current value of the entity tag for the requested variant.
Location The URL of the copied inventory.
403

Description

  • Permissions check failed.

Response Schemas:

errorInvalidPermissions † - Optional
error_line_number†

integer

error_filename†

string

error_description

string

error_function†

string

error_code

integer ( 14 )

404

Description

  • Destination category not found.

Response Schemas:

errorCategoryNotFound † - Optional
error_line_number†

integer

error_filename†

string

error_description

string

error_function†

string

category_id†

uuid

error_code

integer ( 46 )

410

Description

  • Source category gone

Response Schemas:

errorCategoryGone † - Optional
error_line_number†

integer

error_filename†

string

error_description

string

error_function†

string

category_id†

uuid

error_code

integer ( 9 )

412

Description

  • Precondition failed

Response Schemas:

errorPreconditionFailed † - Optional
error_line_number†

integer

error_filename†

string

error_description

string

error_function†

string

etags

[ string , ... ]

etag

string

error_code

integer ( 10 )

condition

string

Response Headers
ETag Current value of the entity tag for the requested variant.

CategoryItems-MOVE

Implementation Status

  • NONE

Description

  • Move category items
Request Headers
If-None-Match (optional) Only process request if none of the supplied entity tags matches resource.
Destination Destination category_id.
If-Match (optional) Only process request if any supplied entity tags matches resource.
Status Codes
200

Description

  • Category items moved successfully

Response Schemas:

categoryItemsMoveResponse † - Optional
_links
self
href

uri

name†

enum: self, link

parent
href

uri

name†

enum: self, link

category†
href

uri

name†

enum: self, link

parent
href

uri

name†

enum: self, link

links
href

uri

name†

enum: self, link

items
href

uri

name†

enum: self, link

self
href

uri

name†

enum: self, link

children
href

uri

name†

enum: self, link

categories†
href

uri

name†

enum: self, link

_base_uri

uri

name

string

type_default

integer ( -151 )

parent_id

uuid

version

integer ( 1 )

agent_id

uuid

category_id

uuid

_embedded
items
uuid
asset_id

uuid

inv_type

integer ( 022 )

name

string

sale_info
sale_price

integer ( 0 )

sale_type

integer ( 03 )

created_at

unixtime

parent_id†

uuid

flags

integer ( 0 )

agent_id

uuid

item_id

uuid

permissions
base_mask

integer ( 0 )

group_mask

integer ( 0 )

last_owner_id

uuid

owner_id

uuid

creator_id

uuid

next_owner_mask

integer ( 0 )

owner_mask

integer ( 0 )

group_id

uuid

everyone_mask

integer ( 0 )

type

integer ( -151 )

desc

string

_links
self
href

uri

name†

enum: self, link

parent
href

uri

name†

enum: self, link

links
uuid
linked_id

uuid

name

string

created_at

unixtime

parent_id

uuid

agent_id

uuid

item_id

uuid

inv_type

integer ( 022 )

type

integer ( 2425 )

desc

string

_links
item
href

uri

name†

enum: self, link

category
href

uri

name†

enum: self, link

self
href

uri

name†

enum: self, link

parent
href

uri

name†

enum: self, link

_updated_items

[ uuid , ... ]

_updated_category_versions
uuid

integer

Response Headers
ETag Current value of the entity tag for the requested variant.
Location The URL of the moved inventory.
403

Description

  • Permissions check failed.

Response Schemas:

errorInvalidPermissions † - Optional
error_line_number†

integer

error_filename†

string

error_description

string

error_function†

string

error_code

integer ( 14 )

404

Description

  • Destination category not found.

Response Schemas:

errorCategoryNotFound † - Optional
error_line_number†

integer

error_filename†

string

error_description

string

error_function†

string

category_id†

uuid

error_code

integer ( 46 )

410

Description

  • Source category gone

Response Schemas:

errorCategoryGone † - Optional
error_line_number†

integer

error_filename†

string

error_description

string

error_function†

string

category_id†

uuid

error_code

integer ( 9 )

412

Description

  • Precondition failed

Response Schemas:

errorPreconditionFailed † - Optional
error_line_number†

integer

error_filename†

string

error_description

string

error_function†

string

etags

[ string , ... ]

etag

string

error_code

integer ( 10 )

condition

string

Response Headers
ETag Current value of the entity tag for the requested variant.

CategoryItems-DELETE

Implementation Status

  • COMPLETE

Description

  • Delete category items
Request Headers
If-None-Match (optional) Only process request if none of the supplied entity tags matches resource.
If-Match (optional) Only process request if any supplied entity tags matches resource.
Status Codes
200

Description

  • Category items deleted successfully

Response Schemas:

categoryItemsDeleteResponse † - Optional
_attachments_removed
^[0-9]+$

uuid

_active_gestures_removed

[ uuid , ... ]

_broken_links_removed

[ uuid , ... ]

_wearables_removed
^[0-9]+$

uuid

_category_items_removed

[ uuid , ... ]

_updated_category_versions
uuid

integer

410

Description

  • Category gone

Response Schemas:

errorCategoryGone † - Optional
error_line_number†

integer

error_filename†

string

error_description

string

error_function†

string

category_id†

uuid

error_code

integer ( 9 )

412

Description

  • Precondition failed

Response Schemas:

errorPreconditionFailed † - Optional
error_line_number†

integer

error_filename†

string

error_description

string

error_function†

string

etags

[ string , ... ]

etag

string

error_code

integer ( 10 )

condition

string

Response Headers
ETag Current value of the entity tag for the requested variant.

CategoryCategories

Description

  • Categories in an inventory category.

Path:

  • /category/{category}/categories{?tid,depth,simulate}

Parameters

  • category → Category UUID or 'special' category name, e.g. "current".
    • Validation: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
    • Validation: ^(animatn|bodypart|clothing|current|favorite|gesture|inbox|landmark|lsltext)$
    • Validation: ^(lstndfnd|my_otfts|notecard|object|outbox|root|snapshot|sound|texture|trash)$
  • tid → Transaction ID.
  • depth → Category child depth to retrieve.
    • Validation: ^(\*|[0-9]+)?$
  • simulate → Whether or not to skip writing back results.
    • Validation: ^(0|1|true|false)?$

Methods


CategoryCategories-GET

Implementation Status

  • COMPLETE

Description

  • Retrieve categories in a category
Request Headers
If-None-Match (optional) Only process request if none of the supplied entity tags matches resource.
If-Match (optional) Only process request if any supplied entity tags matches resource.
Status Codes
200

Description

  • Category categories retrieved successfully

Response Schemas:

categoryCategoriesResponse † - Optional
_links
self
href

uri

name†

enum: self, link

parent
href

uri

name†

enum: self, link

category†
href

uri

name†

enum: self, link

parent
href

uri

name†

enum: self, link

links
href

uri

name†

enum: self, link

items
href

uri

name†

enum: self, link

self
href

uri

name†

enum: self, link

children
href

uri

name†

enum: self, link

categories†
href

uri

name†

enum: self, link

_base_uri

uri

name

string

type_default

integer ( -151 )

parent_id

uuid

version

integer ( 1 )

agent_id

uuid

category_id

uuid

_embedded
categories
uuid
name

string

type_default

integer ( -151 )

parent_id

uuid

version

integer ( 1 )

agent_id

uuid

category_id

uuid

_links
self
href

uri

name†

enum: self, link

parent
href

uri

name†

enum: self, link

_embedded
categories

metaEmbeddedCategories (recursive)

Response Headers
ETag Current value of the entity tag for the requested variant.
304

Description

  • Not modified

Response Schemas: string

Response Headers
ETag Current value of the entity tag for the requested variant.
404

Description

  • Category not found

Response Schemas:

errorCategoryNotFound † - Optional
error_line_number†

integer

error_filename†

string

error_description

string

error_function†

string

category_id†

uuid

error_code

integer ( 46 )

412

Description

  • Precondition failed

Response Schemas:

errorPreconditionFailed † - Optional
error_line_number†

integer

error_filename†

string

error_description

string

error_function†

string

etags

[ string , ... ]

etag

string

error_code

integer ( 10 )

condition

string

Response Headers
ETag Current value of the entity tag for the requested variant.

CategoryCategories-PUT

Implementation Status

  • NONE

Description

  • Replace category categories.
Request Headers
If-None-Match (optional) Only process request if none of the supplied entity tags matches resource.
If-Match (optional) Only process request if any supplied entity tags matches resource.
Request Schemas

[

replaceCategoryCategories † - Optional
_embedded†
items†

[

asset_id

uuid

inv_type

integer ( 022 )

name

string

sale_info†
sale_price†

integer ( 0 )

sale_type†

integer ( 03 )

flags†

integer ( 0 )

desc†

string

type

integer ( -151 )

permissions†
owner_mask†

integer ( 0 )

base_mask†

integer ( 0 )

next_owner_mask†

integer ( 0 )

group_mask†

integer ( 0 )

everyone_mask†

integer ( 0 )

, ... ]

links†

[

type

integer ( 2425 )

linked_id

uuid

name†

string

desc†

string

, ... ]

categories†

[

_embedded†

newEmbeddedChildren (recursive)

name

string

type_default†

integer ( -151 )

, ... ]

name

string

type_default†

integer ( -151 )

, ... ]

Status Codes
201

Description

  • Category categories replaced

Response Schemas:

categoryChildrenReplaceResponse † - Optional
_links
self
href

uri

name†

enum: self, link

parent
href

uri

name†

enum: self, link

category†
href

uri

name†

enum: self, link

parent
href

uri

name†

enum: self, link

links
href

uri

name†

enum: self, link

items
href

uri

name†

enum: self, link

self
href

uri

name†

enum: self, link

children
href

uri

name†

enum: self, link

categories†
href

uri

name†

enum: self, link

_base_uri

uri

name

string

type_default

integer ( -151 )

parent_id

uuid

version

integer ( 1 )

agent_id

uuid

category_id

uuid

_embedded
items
uuid
asset_id

uuid

inv_type

integer ( 022 )

name

string

sale_info
sale_price

integer ( 0 )

sale_type

integer ( 03 )

created_at

unixtime

parent_id†

uuid

flags

integer ( 0 )

agent_id

uuid

item_id

uuid

permissions
base_mask

integer ( 0 )

group_mask

integer ( 0 )

last_owner_id

uuid

owner_id

uuid

creator_id

uuid

next_owner_mask

integer ( 0 )

owner_mask

integer ( 0 )

group_id

uuid

everyone_mask

integer ( 0 )

type

integer ( -151 )

desc

string

_links
self
href

uri

name†

enum: self, link

parent
href

uri

name†

enum: self, link

links
uuid
linked_id

uuid

name

string

created_at

unixtime

parent_id

uuid

agent_id

uuid

item_id

uuid

inv_type

integer ( 022 )

type

integer ( 2425 )

desc

string

_links
item
href

uri

name†

enum: self, link

category
href

uri

name†

enum: self, link

self
href

uri

name†

enum: self, link

parent
href

uri

name†

enum: self, link

categories
uuid
name

string

type_default

integer ( -151 )

parent_id

uuid

version

integer ( 1 )

agent_id

uuid

category_id

uuid

_links
self
href

uri

name†

enum: self, link

parent
href

uri

name†

enum: self, link

_embedded
items
uuid
asset_id

uuid

inv_type

integer ( 022 )

name

string

sale_info
sale_price

integer ( 0 )

sale_type

integer ( 03 )

created_at

unixtime

parent_id†

uuid

flags

integer ( 0 )

agent_id

uuid

item_id

uuid

permissions
base_mask

integer ( 0 )

group_mask

integer ( 0 )

last_owner_id

uuid

owner_id

uuid

creator_id

uuid

next_owner_mask

integer ( 0 )

owner_mask

integer ( 0 )

group_id

uuid

everyone_mask

integer ( 0 )

type

integer ( -151 )

desc

string

_links
self
href

uri

name†

enum: self, link

parent
href

uri

name†

enum: self, link

links
uuid
linked_id

uuid

name

string

created_at

unixtime

parent_id

uuid

agent_id

uuid

item_id

uuid

inv_type

integer ( 022 )

type

integer ( 2425 )

desc

string

_links
item
href

uri

name†

enum: self, link

category
href

uri

name†

enum: self, link

self
href

uri

name†

enum: self, link

parent
href

uri

name†

enum: self, link

categories

metaEmbeddedCategoriesWithChildren (recursive)

_attachments_removed
^[0-9]+$

uuid

_active_gestures_removed

[ uuid , ... ]

_broken_links_removed

[ uuid , ... ]

_total_items_removed

integer

_created_items

[ uuid , ... ]

_wearables_removed
^[0-9]+$

uuid

_created_categories

[ uuid , ... ]

_categories_removed

[ uuid , ... ]

_updated_category_versions
uuid

integer

Response Headers
ETag Current value of the entity tag for the requested variant.
Location The URL of the replaced category categories.
404

Description

  • Category not found

Response Schemas:

errorCategoryNotFound † - Optional
error_line_number†

integer

error_filename†

string

error_description

string

error_function†

string

category_id†

uuid

error_code

integer ( 46 )

412

Description

  • Precondition failed

Response Schemas:

errorPreconditionFailed † - Optional
error_line_number†

integer

error_filename†

string

error_description

string

error_function†

string

etags

[ string , ... ]

etag

string

error_code

integer ( 10 )

condition

string

Response Headers
ETag Current value of the entity tag for the requested variant.

CategoryCategories-COPY

Implementation Status

  • NONE

Description

  • Copy category categories
Request Headers
If-None-Match (optional) Only process request if none of the supplied entity tags matches resource.
Destination Destination category_id or 'special' category.
If-Match (optional) Only process request if any supplied entity tags matches resource.
Status Codes
201

Description

  • Category categories copied successfully

Response Schemas:

categoryCopyResponse † - Optional
_links
self
href

uri

name†

enum: self, link

parent
href

uri

name†

enum: self, link

category†
href

uri

name†

enum: self, link

parent
href

uri

name†

enum: self, link

links
href

uri

name†

enum: self, link

items
href

uri

name†

enum: self, link

self
href

uri

name†

enum: self, link

children
href

uri

name†

enum: self, link

categories†
href

uri

name†

enum: self, link

_base_uri

uri

name

string

type_default

integer ( -151 )

parent_id

uuid

version

integer ( 1 )

agent_id

uuid

category_id

uuid

_embedded
items
uuid
asset_id

uuid

inv_type

integer ( 022 )

name

string

sale_info
sale_price

integer ( 0 )

sale_type

integer ( 03 )

created_at

unixtime

parent_id†

uuid

flags

integer ( 0 )

agent_id

uuid

item_id

uuid

permissions
base_mask

integer ( 0 )

group_mask

integer ( 0 )

last_owner_id

uuid

owner_id

uuid

creator_id

uuid

next_owner_mask

integer ( 0 )

owner_mask

integer ( 0 )

group_id

uuid

everyone_mask

integer ( 0 )

type

integer ( -151 )

desc

string

_links
self
href

uri

name†

enum: self, link

parent
href

uri

name†

enum: self, link

links
uuid
linked_id

uuid

name

string

created_at

unixtime

parent_id

uuid

agent_id

uuid

item_id

uuid

inv_type

integer ( 022 )

type

integer ( 2425 )

desc

string

_links
item
href

uri

name†

enum: self, link

category
href

uri

name†

enum: self, link

self
href

uri

name†

enum: self, link

parent
href

uri

name†

enum: self, link

categories
uuid
name

string

type_default

integer ( -151 )

parent_id

uuid

version

integer ( 1 )

agent_id

uuid

category_id

uuid

_links
self
href

uri

name†

enum: self, link

parent
href

uri

name†

enum: self, link

_embedded
items
uuid
asset_id

uuid

inv_type

integer ( 022 )

name

string

sale_info
sale_price

integer ( 0 )

sale_type

integer ( 03 )

created_at

unixtime

parent_id†

uuid

flags

integer ( 0 )

agent_id

uuid

item_id

uuid

permissions
base_mask

integer ( 0 )

group_mask

integer ( 0 )

last_owner_id

uuid

owner_id

uuid

creator_id

uuid

next_owner_mask

integer ( 0 )

owner_mask

integer ( 0 )

group_id

uuid

everyone_mask

integer ( 0 )

type

integer ( -151 )

desc

string

_links
self
href

uri

name†

enum: self, link

parent
href

uri

name†

enum: self, link

links
uuid
linked_id

uuid

name

string

created_at

unixtime

parent_id

uuid

agent_id

uuid

item_id

uuid

inv_type

integer ( 022 )

type

integer ( 2425 )

desc

string

_links
item
href

uri

name†

enum: self, link

category
href

uri

name†

enum: self, link

self
href

uri

name†

enum: self, link

parent
href

uri

name†

enum: self, link

categories

metaEmbeddedCategoriesWithChildren (recursive)

_removed_items

[ uuid , ... ]

_top_category_id

uuid

_created_items

[ uuid , ... ]

_moved_items

[ uuid , ... ]

_created_categories

[ uuid , ... ]

_updated_category_versions
uuid

integer

Response Headers
ETag Current value of the entity tag for the requested variant.
Location The URL of the copied inventory.
403

Description

  • Permissions check failed.

Response Schemas:

errorInvalidPermissions † - Optional
error_line_number†

integer

error_filename†

string

error_description

string

error_function†

string

error_code

integer ( 14 )

404

Description

  • Destination category not found.

Response Schemas:

errorCategoryNotFound † - Optional
error_line_number†

integer

error_filename†

string

error_description

string

error_function†

string

category_id†

uuid

error_code

integer ( 46 )

410

Description

  • Source category gone

Response Schemas:

errorCategoryGone † - Optional
error_line_number†

integer

error_filename†

string

error_description

string

error_function†

string

category_id†

uuid

error_code

integer ( 9 )

412

Description

  • Precondition failed

Response Schemas:

errorPreconditionFailed † - Optional
error_line_number†

integer

error_filename†

string

error_description

string

error_function†

string

etags

[ string , ... ]

etag

string

error_code

integer ( 10 )

condition

string

Response Headers
ETag Current value of the entity tag for the requested variant.

CategoryCategories-MOVE

Implementation Status

  • NONE

Description

  • Move category categories
Request Headers
If-None-Match (optional) Only process request if none of the supplied entity tags matches resource.
Destination Destination category_id.
If-Match (optional) Only process request if any supplied entity tags matches resource.
Status Codes
200

Description

  • Category categories moved successfully

Response Schemas:

categoryCategoriesMoveResponse † - Optional
_links
self
href

uri

name†

enum: self, link

parent
href

uri

name†

enum: self, link

category†
href

uri

name†

enum: self, link

parent
href

uri

name†

enum: self, link

links
href

uri

name†

enum: self, link

items
href

uri

name†

enum: self, link

self
href

uri

name†

enum: self, link

children
href

uri

name†

enum: self, link

categories†
href

uri

name†

enum: self, link

_base_uri

uri

name

string

type_default

integer ( -151 )

parent_id

uuid

version

integer ( 1 )

agent_id

uuid

category_id

uuid

_embedded
categories
uuid
name

string

type_default

integer ( -151 )

parent_id

uuid

version

integer ( 1 )

agent_id

uuid

category_id

uuid

_links
self
href

uri

name†

enum: self, link

parent
href

uri

name†

enum: self, link

_embedded
categories

metaEmbeddedCategories (recursive)

_updated_categories

[ uuid , ... ]

_updated_category_versions
uuid

integer

Response Headers
ETag Current value of the entity tag for the requested variant.
Location The URL of the moved inventory.
403

Description

  • Permissions check failed.

Response Schemas:

errorInvalidPermissions † - Optional
error_line_number†

integer

error_filename†

string

error_description

string

error_function†

string

error_code

integer ( 14 )

404

Description

  • Destination category not found.

Response Schemas:

errorCategoryNotFound † - Optional
error_line_number†

integer

error_filename†

string

error_description

string

error_function†

string

category_id†

uuid

error_code

integer ( 46 )

410

Description

  • Source category gone

Response Schemas:

errorCategoryGone † - Optional
error_line_number†

integer

error_filename†

string

error_description

string

error_function†

string

category_id†

uuid

error_code

integer ( 9 )

412

Description

  • Precondition failed

Response Schemas:

errorPreconditionFailed † - Optional
error_line_number†

integer

error_filename†

string

error_description

string

error_function†

string

etags

[ string , ... ]

etag

string

error_code

integer ( 10 )

condition

string

Response Headers
ETag Current value of the entity tag for the requested variant.

CategoryCategories-DELETE

Implementation Status

  • COMPLETE

Description

  • Delete category categories
Request Headers
If-None-Match (optional) Only process request if none of the supplied entity tags matches resource.
If-Match (optional) Only process request if any supplied entity tags matches resource.
Status Codes
200

Description

  • Category categories deleted successfully

Response Schemas:

categoryDeleteResponse † - Optional
_update_result†
server_response†

string

fault_code†

integer

code

integer ( 08 )

message

string

success

boolean

_attachments_removed
^[0-9]+$

uuid

_active_gestures_removed

[ uuid , ... ]

_broken_links_removed

[ uuid , ... ]

_total_items_removed

integer

_wearables_removed
^[0-9]+$

uuid

_category_items_removed

[ uuid , ... ]

_categories_removed

[ uuid , ... ]

_updated_category_versions
uuid

integer

410

Description

  • Category gone

Response Schemas:

errorCategoryGone † - Optional
error_line_number†

integer

error_filename†

string

error_description

string

error_function†

string

category_id†

uuid

error_code

integer ( 9 )

412

Description

  • Precondition failed

Response Schemas:

errorPreconditionFailed † - Optional
error_line_number†

integer

error_filename†

string

error_description

string

error_function†

string

etags

[ string , ... ]

etag

string

error_code

integer ( 10 )

condition

string

Response Headers
ETag Current value of the entity tag for the requested variant.

Item

Description

  • An inventory item.

Path:

  • /item/{item}{?tid,simulate}

Parameters

  • tid → Transaction ID.
  • item → Item UUID
    • Validation: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
  • simulate → Whether or not to skip writing back results.
    • Validation: ^(0|1|true|false)?$

Methods


Item-GET

Implementation Status

  • COMPLETE

Description

  • Retrieve an item
Status Codes
200

Description

  • Item retrieved successfully

Response Schemas:

itemResponse † - Optional
_links
self
href

uri

name†

enum: self, link

parent
href

uri

name†

enum: self, link

_base_uri

uri

asset_id

uuid

inv_type

integer ( 022 )

name

string

sale_info
sale_price

integer ( 0 )

sale_type

integer ( 03 )

created_at

unixtime

parent_id†

uuid

flags

integer ( 0 )

agent_id

uuid

item_id

uuid

permissions
base_mask

integer ( 0 )

group_mask

integer ( 0 )

last_owner_id

uuid

owner_id

uuid

creator_id

uuid

next_owner_mask

integer ( 0 )

owner_mask

integer ( 0 )

group_id

uuid

everyone_mask

integer ( 0 )

type

integer ( -151 )

desc

string

linkResponse † - Optional
_base_uri

uri

_links
item
href

uri

name†

enum: self, link

category
href

uri

name†

enum: self, link

self
href

uri

name†

enum: self, link

parent
href

uri

name†

enum: self, link

_embedded
item
asset_id

uuid

inv_type

integer ( 022 )

name

string

sale_info
sale_price

integer ( 0 )

sale_type

integer ( 03 )

created_at

unixtime

parent_id†

uuid

flags

integer ( 0 )

agent_id

uuid

item_id

uuid

permissions
base_mask

integer ( 0 )

group_mask

integer ( 0 )

last_owner_id

uuid

owner_id

uuid

creator_id

uuid

next_owner_mask

integer ( 0 )

owner_mask

integer ( 0 )

group_id

uuid

everyone_mask

integer ( 0 )

type

integer ( -151 )

desc

string

_links
self
href

uri

name†

enum: self, link

parent
href

uri

name†

enum: self, link

category
name

string

type_default

integer ( -151 )

parent_id

uuid

version

integer ( 1 )

agent_id

uuid

category_id

uuid

_links
self
href

uri

name†

enum: self, link

parent
href

uri

name†

enum: self, link

_broken

boolean

linked_id

uuid

name

string

created_at

unixtime

parent_id

uuid

agent_id

uuid

item_id

uuid

inv_type

integer ( 022 )

type

integer ( 2425 )

desc

string

404

Description

  • Item not found

Response Schemas:

errorItemNotFound † - Optional
error_line_number†

integer

error_filename†

string

error_description

string

error_function†

string

item_id†

uuid

error_code

integer ( 4 )


Item-PATCH

Implementation Status

  • COMPLETE

Description

  • Modify an item
Request Schemas
modifyItem † - Optional
asset_id†

uuid

name†

string

sale_info†
sale_price†

integer ( 0 )

sale_type†

integer ( 03 )

flags†

integer ( 0 )

desc†

string

hash_id†

uuid

permissions†
owner_mask†

integer ( 0 )

everyone_mask†

integer ( 0 )

next_owner_mask†

integer ( 0 )

group_mask†

integer ( 0 )

modifyLink † - Optional
linked_id†

uuid

name†

string

desc†

string

Status Codes
200

Description

  • Item modified successfully

Response Schemas:

itemModifyResponse † - Optional
_links
self
href

uri

name†

enum: self, link

parent
href

uri

name†

enum: self, link

_base_uri

uri

asset_id

uuid

inv_type

integer ( 022 )

name

string

sale_info
sale_price

integer ( 0 )

sale_type

integer ( 03 )

created_at

unixtime

parent_id†

uuid

flags

integer ( 0 )

agent_id

uuid

item_id

uuid

permissions
base_mask

integer ( 0 )

group_mask

integer ( 0 )

last_owner_id

uuid

owner_id

uuid

creator_id

uuid

next_owner_mask

integer ( 0 )

owner_mask

integer ( 0 )

group_id

uuid

everyone_mask

integer ( 0 )

type

integer ( -151 )

desc

string

_updated_items

[ uuid , ... ]

_update_result†
server_response†

string

fault_code†

integer

code

integer ( 08 )

message

string

success

boolean

_updated_category_versions
uuid

integer

linkModifyResponse † - Optional
_base_uri

uri

_links
item
href

uri

name†

enum: self, link

category
href

uri

name†

enum: self, link

self
href

uri

name†

enum: self, link

parent
href

uri

name†

enum: self, link

_embedded
item
asset_id

uuid

inv_type

integer ( 022 )

name

string

sale_info
sale_price

integer ( 0 )

sale_type

integer ( 03 )

created_at

unixtime

parent_id†

uuid

flags

integer ( 0 )

agent_id

uuid

item_id

uuid

permissions
base_mask

integer ( 0 )

group_mask

integer ( 0 )

last_owner_id

uuid

owner_id

uuid

creator_id

uuid

next_owner_mask

integer ( 0 )

owner_mask

integer ( 0 )

group_id

uuid

everyone_mask

integer ( 0 )

type

integer ( -151 )

desc

string

_links
self
href

uri

name†

enum: self, link

parent
href

uri

name†

enum: self, link

category
name

string

type_default

integer ( -151 )

parent_id

uuid

version

integer ( 1 )

agent_id

uuid

category_id

uuid

_links
self
href

uri

name†

enum: self, link

parent
href

uri

name†

enum: self, link

_broken

boolean

linked_id

uuid

name

string

created_at

unixtime

parent_id

uuid

agent_id

uuid

item_id

uuid

inv_type

integer ( 022 )

type

integer ( 2425 )

desc

string

_updated_items

[ uuid , ... ]

_update_result†
server_response†

string

fault_code†

integer

code

integer ( 08 )

message

string

success

boolean

_updated_category_versions
uuid

integer

400

Description

  • Invalid request

Response Schemas:

errorInvalidItemRequest † - Optional
error_line_number†

integer

error_filename†

string

error_description

string

error_function†

string

item_id†

uuid

error_code

integer ( 0 )

404

Description

  • Item not found

Response Schemas:

errorItemNotFound † - Optional
error_line_number†

integer

error_filename†

string

error_description

string

error_function†

string

item_id†

uuid

error_code

integer ( 4 )


Item-COPY

Implementation Status

  • NONE

Description

  • Copy an item
Request Headers
Destination Destination category_id or 'special' category.
Status Codes
201

Description

  • Item copied successfully

Response Schemas:

itemCopyResponse † - Optional
asset_id

uuid

inv_type

integer ( 022 )

name

string

sale_info
sale_price

integer ( 0 )

sale_type

integer ( 03 )

created_at

unixtime

parent_id†

uuid

flags

integer ( 0 )

agent_id

uuid

item_id

uuid

permissions
base_mask

integer ( 0 )

group_mask

integer ( 0 )

last_owner_id

uuid

owner_id

uuid

creator_id

uuid

next_owner_mask

integer ( 0 )

owner_mask

integer ( 0 )

group_id

uuid

everyone_mask

integer ( 0 )

type

integer ( -151 )

desc

string

_created_items

[ uuid , ... ]

_updated_category_versions
uuid

integer

linkCopyResponse † - Optional
linked_id

uuid

name

string

created_at

unixtime

parent_id

uuid

agent_id

uuid

item_id

uuid

inv_type

integer ( 022 )

type

integer ( 2425 )

desc

string

_created_items

[ uuid , ... ]

_updated_category_versions
uuid

integer

Response Headers
Location The URL of the copied inventory.
403

Description

  • Permissions check failed.

Response Schemas:

errorInvalidPermissions † - Optional
error_line_number†

integer

error_filename†

string

error_description

string

error_function†

string

error_code

integer ( 14 )

404

Description

  • Destination category not found.

Response Schemas:

errorCategoryNotFound † - Optional
error_line_number†

integer

error_filename†

string

error_description

string

error_function†

string

category_id†

uuid

error_code

integer ( 46 )

410

Description

  • Source item gone

Response Schemas:

errorItemGone † - Optional
error_line_number†

integer

error_filename†

string

error_description

string

error_function†

string

item_id

uuid

error_code

integer ( 9 )


Item-MOVE

Implementation Status

  • NONE

Description

  • Move an item
Request Headers
Destination Destination category_id or 'special' category.
Status Codes
200

Description

  • Item moved successfully

Response Schemas:

itemMoveResponse † - Optional
asset_id

uuid

inv_type

integer ( 022 )

name

string

sale_info
sale_price

integer ( 0 )

sale_type

integer ( 03 )

created_at

unixtime

parent_id†

uuid

flags

integer ( 0 )

agent_id

uuid

item_id

uuid

permissions
base_mask

integer ( 0 )

group_mask

integer ( 0 )

last_owner_id

uuid

owner_id

uuid

creator_id

uuid

next_owner_mask

integer ( 0 )

owner_mask

integer ( 0 )

group_id

uuid

everyone_mask

integer ( 0 )

type

integer ( -151 )

desc

string

_updated_items

[ uuid , ... ]

_updated_category_versions
uuid

integer

linkMoveResponse † - Optional
linked_id

uuid

name

string

created_at

unixtime

parent_id

uuid

agent_id

uuid

item_id

uuid

inv_type

integer ( 022 )

type

integer ( 2425 )

desc

string

_updated_items

[ uuid , ... ]

_updated_category_versions
uuid

integer

Response Headers
Location The URL of the moved inventory.
403

Description

  • Permissions check failed.

Response Schemas:

errorInvalidPermissions † - Optional
error_line_number†

integer

error_filename†

string

error_description

string

error_function†

string

error_code

integer ( 14 )

404

Description

  • Destination category not found.

Response Schemas:

errorCategoryNotFound † - Optional
error_line_number†

integer

error_filename†

string

error_description

string

error_function†

string

category_id†

uuid

error_code

integer ( 46 )

410

Description

  • Source item gone

Response Schemas:

errorItemGone † - Optional
error_line_number†

integer

error_filename†

string

error_description

string

error_function†

string

item_id

uuid

error_code

integer ( 9 )


Item-DELETE

Implementation Status

  • COMPLETE

Description

  • Delete an item
Status Codes
200

Description

  • Item deleted successfully

Response Schemas:

itemDeleteResponse † - Optional
_attachments_removed
^[0-9]+$

uuid

_update_result†
server_response†

string

fault_code†

integer

code

integer ( 08 )

message

string

success

boolean

_active_gestures_removed

[ uuid , ... ]

_broken_links_removed

[ uuid , ... ]

_wearables_removed
^[0-9]+$

uuid

_category_items_removed

[ uuid , ... ]

_updated_category_versions
uuid

integer

410

Description

  • Item gone

Response Schemas:

errorItemGone † - Optional
error_line_number†

integer

error_filename†

string

error_description

string

error_function†

string

item_id

uuid

error_code

integer ( 9 )

Global Response Status Codes

400

Description

  • Invalid request

Response Schemas:

errorGeneral † - Optional
error_line_number†

integer

error_filename†

string

error_description

string

error_function†

string

error_code

integer ( 017 )

415

Description

  • Unsupported media type

Response Schemas:

errorGeneral † - Optional
error_line_number†

integer

error_filename†

string

error_description

string

error_function†

string

error_code

integer ( 017 )

500

Description

  • Internal Error

Response Schemas:

errorGeneral † - Optional
error_line_number†

integer

error_filename†

string

error_description

string

error_function†

string

error_code

integer ( 017 )

Global Request Headers

Content-Type (optional) Content type of request payload. Generally application/llsd+xml or application/json.
Accept-Encoding (optional) Preferred response encoding (e.g. 'gzip')
Accept (optional) Preferred response Content-Type. Generally application/llsd+xml or application/json.
Cache-Control (optional) Directives to caching mechanisms.

Global Response Headers

Vary Indicates the set of request-header fields that determines request variants. Used by caching mechanisms.
Content-Encoding (optional) Response encoding (e.g. 'gzip')
Content-Type (optional) Content type of response payload. Generally application/llsd+xml or application/json.
Content-Location (optional) Canonical location of requested resource.
Cache-Control (optional) Directives to caching mechanisms.

Error Codes

AIS_ERROR_INVALID_REQUEST 0
AIS_ERROR_INVALID_SHAPE 1
AIS_ERROR_INVALID_DEPTH 2
AIS_ERROR_BROKEN_LINK 3
AIS_ERROR_NOT_FOUND 4
AIS_ERROR_AGENT_NOT_FOUND 5
AIS_ERROR_NO_INVENTORY_ROOT 6
AIS_ERROR_METHOD_NOT_ALLOWED 7
AIS_ERROR_CONFLICT 8
AIS_ERROR_GONE 9
AIS_ERROR_CONDITION_FAILED 10
AIS_ERROR_INTERNAL_ERROR 11
AIS_ERROR_QUERY_FAILED 12
AIS_ERROR_QUERY_EXPECTATION_FAILED 13
AIS_ERROR_INVALID_PERMISSIONS 14
AIS_ERROR_NOT_SUPPORTED 15
AIS_ERROR_UNKNOWN 16
AIS_ERROR_UNSUPPORTED_MEDIA 17