Linden Lab Official:Inventory API v3/RestDoc
Jump to navigation
Jump to search
{
"schemas" : {
"slcap://InventoryAPIv3/category" : {
"type" : "inline",
"schema" : {
"type" : "object",
"description" : "Schema for an inventory category.",
"required" : ["agent_id", "category_id", "name", "parent_id", "type_default", "version" ],
"properties" : {
"agent_id" : {
"type" : "uuid",
"readonly" : true
},
"category_id" : {
"type" : "uuid",
"readonly" : true
},
"name" : {
"type" : "string",
"maxLength" : 63,
"blank" : true
},
"parent_id" : {
"type" : "uuid",
"readonly" : true
},
"type_default" : {
"type" : "integer",
"minimum" : -1,
"maximum" : 51,
"readonly" : true
},
"version" : {
"type" : "integer",
"minimum" : 1,
"readonly" : true
}
}
}
},
"slcap://InventoryAPIv3/item" : {
"type" : "inline",
"schema" : {
"type" : "object",
"description" : "Schema for an inventory item.",
"required" : ["agent_id", "asset_id", "created_at", "desc", "flags", "inv_type", "item_id", "name", "permissions", "sale_info", "type"],
"properties" : {
"agent_id" : {
"type" : "uuid",
"readonly" : true
},
"asset_id" : {
"type" : "uuid"
},
"created_at" : {
"type" : "integer",
"format" : "unixtime",
"readonly" : true
},
"desc" : {
"type" : "string",
"maxLength" : 127,
"blank" : true
},
"flags" : {
"type" : "integer",
"minimum" : 0
},
"inv_type" : {
"type" : "integer",
"minimum" : 0,
"maximum" : 22,
"readonly" : true
},
"item_id" : {
"type" : "uuid",
"readonly" : true
},
"name" : {
"type" : "string",
"maxLength" : 63,
"blank" : true
},
"parent_id" : {
"type" : "uuid",
"readonly" : true
},
"permissions" : {
"type" : "object",
"required" : ["base_mask", "creator_id", "everyone_mask", "group_id", "group_mask", "last_owner_id", "next_owner_mask", "owner_id", "owner_mask"],
"properties" : {
"base_mask" : {
"type" : "integer",
"minimum" : 0,
"readonly" : true
},
"creator_id" : {
"type" : "uuid",
"readonly" : true
},
"everyone_mask" : {
"type" : "integer",
"minimum" : 0
},
"group_id" : {
"type" : "uuid",
"readonly" : true
},
"group_mask" : {
"type" : "integer",
"minimum" : 0
},
"last_owner_id" : {
"type" : "uuid",
"readonly" : true
},
"next_owner_mask" : {
"type" : "integer",
"minimum" : 0
},
"owner_id" : {
"type" : "uuid",
"readonly" : true
},
"owner_mask" : {
"type" : "integer",
"minimum" : 0
}
}
},
"sale_info" : {
"type" : "object",
"required" : ["sale_price", "sale_type"],
"properties" : {
"sale_price" : {
"type" : "integer",
"minimum" : 0
},
"sale_type" : {
"type" : "integer",
"minimum" : 0,
"maximum" : 3
}
}
},
"type" : {
"type" : "integer",
"minimum" : -1,
"maximum" : 51,
"readonly" : true
}
}
}
},
"slcap://InventoryAPIv3/link" : {
"type" : "inline",
"schema" : {
"type" : "object",
"description" : "Schema for an inventory link.",
"required" : [ "agent_id", "created_at", "desc", "inv_type", "item_id", "linked_id", "name", "parent_id", "type" ],
"properties" : {
"agent_id" : {
"type" : "uuid",
"readonly" : true
},
"created_at" : {
"type" : "integer",
"type" : "unixtime",
"readonly" : true
},
"desc" : {
"type" : "string",
"maxLength" : 127,
"blank" : true
},
"inv_type" : {
"type" : "integer",
"minimum" : 0,
"maximum" : 22,
"readonly" : true
},
"item_id" : {
"type" : "uuid",
"readonly" : true
},
"linked_id" : {
"type" : "uuid"
},
"name" : {
"type" : "string",
"maxLength" : 63,
"blank" : true
},
"parent_id" : {
"type" : "uuid",
"readonly" : true
},
"type" : {
"type" : "integer",
"minimum" : 24,
"maximum" : 25,
"readonly" : true
}
}
}
},
"slcap://InventoryAPIv3/metaEmbeddedLinksResolved" : {
"type" : "inline",
"schema" : {
"type" : "object",
"patternProperties": {
"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" : {
"type" : "object",
"allOf" : [
{ "$ref" : "slcap://InventoryAPIv3/metaEmbeddedResolvedLink" },
{ "$ref" : "slcap://InventoryAPIv3/metaLinkEmbedded" },
{ "$ref" : "slcap://InventoryAPIv3/link" }
]
}
}
}
},
"slcap://InventoryAPIv3/metaEmbeddedLinksUnresolved" : {
"type" : "inline",
"schema" : {
"type" : "object",
"patternProperties": {
"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" : {
"type" : "object",
"$ref" : "slcap://InventoryAPIv3/metaEmbeddedLinkUnresolved"
}
}
}
},
"slcap://InventoryAPIv3/metaEmbeddedLinkUnresolved" : {
"type" : "inline",
"schema" : {
"type" : "object",
"allOf" : [
{ "$ref" : "slcap://InventoryAPIv3/link" },
{ "$ref" : "slcap://InventoryAPIv3/metaLinkEmbedded" }
]
}
},
"slcap://InventoryAPIv3/metaEmbeddedItems" : {
"type" : "inline",
"schema" : {
"type" : "object",
"patternProperties": {
"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" : {
"type" : "object",
"$ref" : "slcap://InventoryAPIv3/metaEmbeddedItem"
}
}
}
},
"slcap://InventoryAPIv3/metaEmbeddedItem" : {
"type" : "inline",
"schema" : {
"type" : "object",
"allOf" : [
{ "$ref" : "slcap://InventoryAPIv3/item" },
{ "$ref" : "slcap://InventoryAPIv3/metaItemEmbedded" }
]
}
},
"slcap://InventoryAPIv3/metaEmbeddedCategory" : {
"type" : "inline",
"schema" : {
"type" : "object",
"allOf" : [
{ "$ref" : "slcap://InventoryAPIv3/category" },
{ "$ref" : "slcap://InventoryAPIv3/metaCategoryEmbedded" }
]
}
},
"slcap://InventoryAPIv3/metaEmbeddedCategories" : {
"type" : "inline",
"schema" : {
"type" : "object",
"patternProperties": {
"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" : {
"type" : "object",
"allOf" : [{
"$ref" : "slcap://InventoryAPIv3/metaEmbeddedCategory"
}, {
"type" : "object",
"properties" : {
"_embedded" : {
"type" : "object",
"readonly" : true,
"required" : [ "categories" ],
"properties" : {
"categories" : { "$ref" : "slcap://InventoryAPIv3/metaEmbeddedCategories" }
}
}
}
}]
}
}
}
},
"slcap://InventoryAPIv3/metaEmbeddedCategoriesWithChildren" : {
"type" : "inline",
"schema" : {
"type" : "object",
"patternProperties": {
"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" : {
"type" : "object",
"allOf" : [{
"$ref" : "slcap://InventoryAPIv3/metaEmbeddedCategory"
}, {
"type" : "object",
"properties" : {
"_embedded" : {
"type" : "object",
"readonly" : true,
"required" : [ "categories", "links", "items" ],
"properties" : {
"categories" : { "$ref" : "slcap://InventoryAPIv3/metaEmbeddedCategoriesWithChildren" },
"links" : { "$ref" : "slcap://InventoryAPIv3/metaEmbeddedLinksUnresolved" },
"items" : { "$ref" : "slcap://InventoryAPIv3/metaEmbeddedItems" }
}
}
}
}]
}
}
}
},
"slcap://InventoryAPIv3/metaEmbeddedCategoriesOnly" : {
"type" : "inline",
"schema" : {
"type" : "object",
"readonly" : true,
"required" : [ "categories" ],
"properties" : {
"categories" : { "$ref" : "slcap://InventoryAPIv3/metaEmbeddedCategories" }
}
}
},
"slcap://InventoryAPIv3/metaEmbeddedLinksOnly" : {
"type" : "inline",
"schema" : {
"type" : "object",
"readonly" : true,
"required" : [ "links" ],
"properties" : {
"links" : { "$ref" : "slcap://InventoryAPIv3/metaEmbeddedLinksResolved" }
}
}
},
"slcap://InventoryAPIv3/metaEmbeddedItemsAndLinks" : {
"type" : "inline",
"schema" : {
"type" : "object",
"readonly" : true,
"required" : [ "links", "items" ],
"properties" : {
"links" : { "$ref" : "slcap://InventoryAPIv3/metaEmbeddedLinksUnresolved" },
"items" : { "$ref" : "slcap://InventoryAPIv3/metaEmbeddedItems" }
}
}
},
"slcap://InventoryAPIv3/metaEmbeddedChildren" : {
"type" : "inline",
"schema" : {
"type" : "object",
"readonly" : true,
"required" : [ "categories", "links", "items" ],
"properties" : {
"categories" : { "$ref" : "slcap://InventoryAPIv3/metaEmbeddedCategoriesWithChildren" },
"links" : { "$ref" : "slcap://InventoryAPIv3/metaEmbeddedLinksUnresolved" },
"items" : { "$ref" : "slcap://InventoryAPIv3/metaEmbeddedItems" }
}
}
},
"slcap://InventoryAPIv3/metaEmbeddedResolvedLink" : {
"type" : "inline",
"schema" : {
"type" : "object",
"readonly" : true,
"required" : [ "_broken", "_embedded" ],
"properties" : {
"_broken" : { "type" : "boolean" },
"_embedded" : {
"type" : "object",
"oneOf" : [ {
"type" : "object",
"required" : [ "item" ],
"properties" : {
"item" : {
"type" : "object",
"$ref" : "slcap://InventoryAPIv3/metaEmbeddedItem"
}
}
}, {
"type" : "object",
"required" : [ "category" ],
"properties" : {
"category" : {
"type" : "object",
"$ref" : "slcap://InventoryAPIv3/metaEmbeddedCategory"
}
}
} ]
}
}
}
},
"slcap://InventoryAPIv3/linkResponse" : {
"type" : "inline",
"schema" : {
"type" : "object",
"allOf" : [
{ "$ref" : "slcap://InventoryAPIv3/metaLinkResponse" },
{ "$ref" : "slcap://InventoryAPIv3/metaEmbeddedResolvedLink" },
{ "$ref" : "slcap://InventoryAPIv3/link" }
]
}
},
"slcap://InventoryAPIv3/itemResponse" : {
"type" : "inline",
"schema" : {
"type" : "object",
"allOf" : [
{ "$ref" : "slcap://InventoryAPIv3/metaItemResponse" },
{ "$ref" : "slcap://InventoryAPIv3/item" }
]
}
},
"slcap://InventoryAPIv3/modifyItem" : {
"type" : "inline",
"schema" : {
"type" : "object",
"properties" : {
"asset_id" : {
"type" : "uuid"
},
"desc" : {
"type" : "string",
"maxLength" : 127,
"blank" : true
},
"flags" : {
"type" : "integer",
"minimum" : 0
},
"hash_id" : {
"type" : "uuid"
},
"name" : {
"type" : "string",
"maxLength" : 63,
"blank" : true
},
"permissions" : {
"type" : "object",
"properties" : {
"everyone_mask" : {
"type" : "integer",
"minimum" : 0
},
"group_mask" : {
"type" : "integer",
"minimum" : 0
},
"next_owner_mask" : {
"type" : "integer",
"minimum" : 0
},
"owner_mask" : {
"type" : "integer",
"minimum" : 0
}
}
},
"sale_info" : {
"type" : "object",
"properties" : {
"sale_price" : {
"type" : "integer",
"minimum" : 0
},
"sale_type" : {
"type" : "integer",
"minimum" : 0,
"maximum" : 3
}
}
}
}
}
},
"slcap://InventoryAPIv3/itemModifyResponse" : {
"type" : "inline",
"schema" : {
"type" : "object",
"allOf" : [ {
"$ref" : "slcap://InventoryAPIv3/itemResponse"
}, {
"type" : "object",
"readonly" : true,
"required" : [ "_updated_items", "_updated_category_versions" ],
"properties" : {
"_updated_items" : { "$ref" : "slcap://InventoryAPIv3/metaUuidArray" },
"_updated_category_versions": { "$ref" : "slcap://InventoryAPIv3/metaUuidIntegerMap" },
"_update_result": { "$ref" : "slcap://InventoryAPIv3/inventoryUpdateResponse" }
}
}]
}
},
"slcap://InventoryAPIv3/modifyLink" : {
"type" : "inline",
"schema" : {
"type" : "object",
"properties" : {
"desc" : {
"type" : "string",
"maxLength" : 127,
"blank" : true
},
"linked_id" : {
"type" : "uuid"
},
"name" : {
"type" : "string",
"maxLength" : 63,
"blank" : true
}
}
}
},
"slcap://InventoryAPIv3/linkModifyResponse" : {
"type" : "inline",
"schema" : {
"type" : "object",
"allOf" : [ {
"$ref" : "slcap://InventoryAPIv3/linkResponse"
}, {
"type" : "object",
"readonly" : true,
"required" : [ "_updated_items", "_updated_category_versions" ],
"properties" : {
"_updated_items" : { "$ref" : "slcap://InventoryAPIv3/metaUuidArray" },
"_updated_category_versions": { "$ref" : "slcap://InventoryAPIv3/metaUuidIntegerMap" },
"_update_result": { "$ref" : "slcap://InventoryAPIv3/inventoryUpdateResponse" }
}
}]
}
},
"slcap://InventoryAPIv3/itemCopyResponse" : {
"type" : "inline",
"schema" : {
"type" : "object",
"allOf" : [ {
"$ref" : "slcap://InventoryAPIv3/item"
}, {
"type" : "object",
"readonly" : true,
"required" : [ "_created_items", "_updated_category_versions" ],
"properties" : {
"_created_items" : { "$ref" : "slcap://InventoryAPIv3/metaUuidArray" },
"_updated_category_versions": { "$ref" : "slcap://InventoryAPIv3/metaUuidIntegerMap" }
}
}]
}
},
"slcap://InventoryAPIv3/linkCopyResponse" : {
"type" : "inline",
"schema" : {
"type" : "object",
"allOf" : [ {
"$ref" : "slcap://InventoryAPIv3/link"
}, {
"type" : "object",
"readonly" : true,
"required" : [ "_created_items", "_updated_category_versions" ],
"properties" : {
"_created_items" : { "$ref" : "slcap://InventoryAPIv3/metaUuidArray" },
"_updated_category_versions": { "$ref" : "slcap://InventoryAPIv3/metaUuidIntegerMap" }
}
}]
}
},
"slcap://InventoryAPIv3/itemMoveResponse" : {
"type" : "inline",
"schema" : {
"type" : "object",
"allOf" : [ {
"$ref" : "slcap://InventoryAPIv3/item"
}, {
"type" : "object",
"readonly" : true,
"required" : [ "_updated_items", "_updated_category_versions" ],
"properties" : {
"_updated_items" : { "$ref" : "slcap://InventoryAPIv3/metaUuidArray" },
"_updated_category_versions": { "$ref" : "slcap://InventoryAPIv3/metaUuidIntegerMap" }
}
}]
}
},
"slcap://InventoryAPIv3/linkMoveResponse" : {
"type" : "inline",
"schema" : {
"type" : "object",
"allOf" : [ {
"$ref" : "slcap://InventoryAPIv3/link"
}, {
"type" : "object",
"readonly" : true,
"required" : [ "_updated_items", "_updated_category_versions" ],
"properties" : {
"_updated_items" : { "$ref" : "slcap://InventoryAPIv3/metaUuidArray" },
"_updated_category_versions": { "$ref" : "slcap://InventoryAPIv3/metaUuidIntegerMap" }
}
}]
}
},
"slcap://InventoryAPIv3/itemDeleteResponse" : {
"type" : "inline",
"schema" : {
"type" : "object",
"readonly" : true,
"required" : [ "_active_gestures_removed", "_attachments_removed", "_broken_links_removed", "_category_items_removed", "_updated_category_versions", "_wearables_removed" ],
"properties" : {
"_active_gestures_removed": { "$ref" : "slcap://InventoryAPIv3/metaUuidArray" },
"_attachments_removed": { "$ref" : "slcap://InventoryAPIv3/metaIntegerUuidMap" },
"_broken_links_removed": { "$ref" : "slcap://InventoryAPIv3/metaUuidArray" },
"_category_items_removed": { "$ref" : "slcap://InventoryAPIv3/metaUuidArray" },
"_updated_category_versions": { "$ref" : "slcap://InventoryAPIv3/metaUuidIntegerMap" },
"_update_result": { "$ref" : "slcap://InventoryAPIv3/inventoryUpdateResponse" },
"_wearables_removed": { "$ref" : "slcap://InventoryAPIv3/metaIntegerUuidMap" }
}
}
},
"slcap://InventoryAPIv3/inventoryUpdateResponse" : {
"type" : "inline",
"schema" : {
"type" : "object",
"readonly" : true,
"required" : [ "success", "code", "message" ],
"properties" : {
"success" : { "type" : "boolean" },
"code" : {
"type" : "integer",
"minimum" : 0,
"maximum" : 8
},
"fault_code" : {
"type" : "integer"
},
"message" : { "type" : "string" },
"server_response" : { "type" : "string" }
}
}
},
"slcap://InventoryAPIv3/categoryResponse" : {
"type" : "inline",
"schema" : {
"type" : "object",
"allOf" : [
{ "$ref" : "slcap://InventoryAPIv3/metaCategoryResponse" },
{ "$ref" : "slcap://InventoryAPIv3/category" }
]
}
},
"slcap://InventoryAPIv3/replaceCategoryLinks" : {
"type" : "inline",
"schema" : {
"type" : "array",
"items" : {
"type" : "object",
"$ref" : "slcap://InventoryAPIv3/newLink"
}
}
},
"slcap://InventoryAPIv3/replaceCategoryCategories" : {
"type" : "inline",
"schema" : {
"type" : "array",
"items" : {
"type" : "object",
"required" : [ "name" ],
"properties" : {
"name" : {
"type" : "string",
"maxLength" : 63,
"blank" : true
},
"type_default" : {
"type" : "integer",
"minimum" : -1,
"maximum" : 51
},
"_embedded" : {
"type" : "object",
"$ref" : "slcap://InventoryAPIv3/newEmbeddedChildren"
}
}
}
}
},
"slcap://InventoryAPIv3/replaceCategoryItems" : {
"type" : "inline",
"schema" : {
"type" : "object",
"properties" : {
"links" : {
"type" : "array",
"items" : {
"type" : "object",
"$ref" : "slcap://InventoryAPIv3/newLink"
}
},
"items" : {
"type" : "array",
"items" : {
"type" : "object",
"$ref" : "slcap://InventoryAPIv3/newItem"
}
}
}
}
},
"slcap://InventoryAPIv3/categoryChildrenReplaceResponse" : {
"type" : "inline",
"schema" : {
"type" : "object",
"allOf" : [ {
"$ref" : "slcap://InventoryAPIv3/categoryChildrenResponse"
}, {
"type" : "object",
"readonly" : true,
"required" : [ "_active_gestures_removed", "_attachments_removed", "_broken_links_removed", "_categories_removed", "_created_categories", "_created_items", "_total_items_removed", "_updated_category_versions", "_wearables_removed" ],
"properties" : {
"_active_gestures_removed": { "$ref" : "slcap://InventoryAPIv3/metaUuidArray" },
"_attachments_removed": { "$ref" : "slcap://InventoryAPIv3/metaIntegerUuidMap" },
"_broken_links_removed": { "$ref" : "slcap://InventoryAPIv3/metaUuidArray" },
"_categories_removed": { "$ref" : "slcap://InventoryAPIv3/metaUuidArray" },
"_created_categories" : { "$ref" : "slcap://InventoryAPIv3/metaUuidArray" },
"_created_items" : { "$ref" : "slcap://InventoryAPIv3/metaUuidArray" },
"_total_items_removed": { "type" : "integer" },
"_updated_category_versions": { "$ref" : "slcap://InventoryAPIv3/metaUuidIntegerMap" },
"_wearables_removed": { "$ref" : "slcap://InventoryAPIv3/metaIntegerUuidMap" }
}
}]
}
},
"slcap://InventoryAPIv3/categoryLinksReplaceResponse" : {
"type" : "inline",
"schema" : {
"type" : "object",
"allOf" : [ {
"$ref" : "slcap://InventoryAPIv3/categoryLinksResponse"
}, {
"type" : "object",
"readonly" : true,
"required" : [ "_category_items_removed", "_created_items", "_linked_ids", "_updated_items", "_updated_category_versions" ],
"properties" : {
"_category_items_removed": { "$ref" : "slcap://InventoryAPIv3/metaUuidArray" },
"_created_items" : { "$ref" : "slcap://InventoryAPIv3/metaUuidArray" },
"_linked_ids" : { "$ref" : "slcap://InventoryAPIv3/metaUuidUuidMap" },
"_updated_items" : { "$ref" : "slcap://InventoryAPIv3/metaUuidArray" },
"_updated_category_versions": { "$ref" : "slcap://InventoryAPIv3/metaUuidIntegerMap" }
}
}]
}
},
"slcap://InventoryAPIv3/categoryItemsReplaceResponse" : {
"type" : "inline",
"schema" : {
"type" : "object",
"allOf" : [ {
"$ref" : "slcap://InventoryAPIv3/categoryItemsResponse"
}, {
"type" : "object",
"readonly" : true,
"required" : [
"_active_gestures_removed",
"_attachments_removed",
"_broken_links_removed",
"_category_items_removed",
"_created_items" ,
"_linked_ids" ,
"_updated_items" ,
"_updated_category_versions",
"_wearables_removed" ],
"properties" : {
"_active_gestures_removed": { "$ref" : "slcap://InventoryAPIv3/metaUuidArray" },
"_attachments_removed": { "$ref" : "slcap://InventoryAPIv3/metaIntegerUuidMap" },
"_broken_links_removed": { "$ref" : "slcap://InventoryAPIv3/metaUuidArray" },
"_category_items_removed": { "$ref" : "slcap://InventoryAPIv3/metaUuidArray" },
"_created_items" : { "$ref" : "slcap://InventoryAPIv3/metaUuidArray" },
"_linked_ids" : { "$ref" : "slcap://InventoryAPIv3/metaUuidUuidMap" },
"_updated_items" : { "$ref" : "slcap://InventoryAPIv3/metaUuidArray" },
"_updated_category_versions": { "$ref" : "slcap://InventoryAPIv3/metaUuidIntegerMap" },
"_wearables_removed": { "$ref" : "slcap://InventoryAPIv3/metaIntegerUuidMap" }
}
}]
}
},
"slcap://InventoryAPIv3/categoryLinksMoveResponse" : {
"type" : "inline",
"schema" : {
"type" : "object",
"allOf" : [ {
"$ref" : "slcap://InventoryAPIv3/categoryLinksResponse"
}, {
"type" : "object",
"readonly" : true,
"required" : [ "_updated_items", "_updated_category_versions" ],
"properties" : {
"_updated_items" : { "$ref" : "slcap://InventoryAPIv3/metaUuidArray" },
"_updated_category_versions": { "$ref" : "slcap://InventoryAPIv3/metaUuidIntegerMap" }
}
}]
}
},
"slcap://InventoryAPIv3/categoryItemsMoveResponse" : {
"type" : "inline",
"schema" : {
"type" : "object",
"allOf" : [ {
"$ref" : "slcap://InventoryAPIv3/categoryItemsResponse"
}, {
"type" : "object",
"readonly" : true,
"required" : [ "_updated_items", "_updated_category_versions" ],
"properties" : {
"_updated_items" : { "$ref" : "slcap://InventoryAPIv3/metaUuidArray" },
"_updated_category_versions": { "$ref" : "slcap://InventoryAPIv3/metaUuidIntegerMap" }
}
}]
}
},
"slcap://InventoryAPIv3/categoryLinksDeleteResponse" : {
"type" : "inline",
"schema" : {
"type" : "object",
"readonly" : true,
"required" : [ "_category_items_removed", "_updated_category_versions" ],
"properties" : {
"_category_items_removed": { "$ref" : "slcap://InventoryAPIv3/metaUuidArray" },
"_updated_category_versions": { "$ref" : "slcap://InventoryAPIv3/metaUuidIntegerMap" }
}
}
},
"slcap://InventoryAPIv3/categoryItemsDeleteResponse" : {
"type" : "inline",
"schema" : {
"type" : "object",
"readonly" : true,
"required" : [
"_active_gestures_removed",
"_attachments_removed",
"_broken_links_removed",
"_category_items_removed",
"_updated_category_versions",
"_wearables_removed" ],
"properties" : {
"_active_gestures_removed": { "$ref" : "slcap://InventoryAPIv3/metaUuidArray" },
"_attachments_removed": { "$ref" : "slcap://InventoryAPIv3/metaIntegerUuidMap" },
"_broken_links_removed": { "$ref" : "slcap://InventoryAPIv3/metaUuidArray" },
"_category_items_removed": { "$ref" : "slcap://InventoryAPIv3/metaUuidArray" },
"_updated_category_versions": { "$ref" : "slcap://InventoryAPIv3/metaUuidIntegerMap" },
"_wearables_removed": { "$ref" : "slcap://InventoryAPIv3/metaIntegerUuidMap" }
}
}
},
"slcap://InventoryAPIv3/categoryLinksCopyResponse" : {
"type" : "inline",
"schema" : {
"type" : "object",
"allOf" : [ {
"$ref" : "slcap://InventoryAPIv3/categoryLinksResponse"
}, {
"type" : "object",
"readonly" : true,
"required" : [ "_created_items", "_updated_category_versions" ],
"properties" : {
"_created_items" : { "$ref" : "slcap://InventoryAPIv3/metaUuidArray" },
"_updated_category_versions": { "$ref" : "slcap://InventoryAPIv3/metaUuidIntegerMap" }
}
}]
}
},
"slcap://InventoryAPIv3/categoryItemsCopyResponse" : {
"type" : "inline",
"schema" : {
"type" : "object",
"allOf" : [ {
"$ref" : "slcap://InventoryAPIv3/categoryItemsResponse"
}, {
"type" : "object",
"readonly" : true,
"required" : [ "_created_items", "_updated_category_versions" ],
"properties" : {
"_created_items" : { "$ref" : "slcap://InventoryAPIv3/metaUuidArray" },
"_updated_category_versions": { "$ref" : "slcap://InventoryAPIv3/metaUuidIntegerMap" }
}
}]
}
},
"slcap://InventoryAPIv3/categoryLinksResponse" : {
"type" : "inline",
"schema" : {
"type" : "object",
"allOf" : [ {
"$ref" : "slcap://InventoryAPIv3/metaCategoryResponse"
}, {
"$ref" : "slcap://InventoryAPIv3/category"
}, {
"type" : "object",
"required" : [ "_embedded" ],
"properties" : {
"_embedded" : {
"type" : "object",
"readonly" : true,
"$ref" : "slcap://InventoryAPIv3/metaEmbeddedLinksOnly"
}
}
}]
}
},
"slcap://InventoryAPIv3/categoryItemsResponse" : {
"type" : "inline",
"schema" : {
"type" : "object",
"allOf" : [ {
"$ref" : "slcap://InventoryAPIv3/categoryResponse"
}, {
"type" : "object",
"required" : [ "_embedded" ],
"properties" : {
"_embedded" : {
"type" : "object",
"readonly" : true,
"$ref" : "slcap://InventoryAPIv3/metaEmbeddedItemsAndLinks"
}
}
}]
}
},
"slcap://InventoryAPIv3/categoryCategoriesResponse" : {
"type" : "inline",
"schema" : {
"type" : "object",
"allOf" : [ {
"$ref" : "slcap://InventoryAPIv3/metaCategoryResponse"
}, {
"$ref" : "slcap://InventoryAPIv3/category"
}, {
"type" : "object",
"required" : [ "_embedded" ],
"properties" : {
"_embedded" : {
"type" : "object",
"readonly" : true,
"$ref" : "slcap://InventoryAPIv3/metaEmbeddedCategoriesOnly"
}
}
}]
}
},
"slcap://InventoryAPIv3/categoryChildrenResponse" : {
"type" : "inline",
"schema" : {
"type" : "object",
"allOf" : [ {
"$ref" : "slcap://InventoryAPIv3/metaCategoryResponse"
}, {
"$ref" : "slcap://InventoryAPIv3/category"
}, {
"type" : "object",
"required" : [ "_embedded" ],
"properties" : {
"_embedded" : {
"type" : "object",
"readonly" : true,
"$ref" : "slcap://InventoryAPIv3/metaEmbeddedChildren"
}
}
}]
}
},
"slcap://InventoryAPIv3/categoryNewResponse" : {
"type" : "inline",
"schema" : {
"type" : "object",
"allOf" : [ {
"$ref" : "slcap://InventoryAPIv3/categoryResponse"
}, {
"type" : "object",
"readonly" : true,
"required" : [ "_created_categories", "_updated_category_versions" ],
"properties" : {
"_created_categories" : { "$ref" : "slcap://InventoryAPIv3/metaUuidArray" },
"_updated_category_versions": { "$ref" : "slcap://InventoryAPIv3/metaUuidIntegerMap" }
}
}]
}
},
"slcap://InventoryAPIv3/categoryModifyResponse" : {
"type" : "inline",
"schema" : {
"type" : "object",
"allOf" : [ {
"$ref" : "slcap://InventoryAPIv3/categoryResponse"
}, {
"type" : "object",
"readonly" : true,
"required" : [ "_updated_categories", "_updated_category_versions" ],
"properties" : {
"_updated_categories" : { "$ref" : "slcap://InventoryAPIv3/metaUuidArray" },
"_updated_category_versions": { "$ref" : "slcap://InventoryAPIv3/metaUuidIntegerMap" },
"_update_result": { "$ref" : "slcap://InventoryAPIv3/inventoryUpdateResponse" }
}
}]
}
},
"slcap://InventoryAPIv3/categoryCopyResponse" : {
"type" : "inline",
"schema" : {
"type" : "object",
"allOf" : [ {
"$ref" : "slcap://InventoryAPIv3/categoryChildrenResponse"
}, {
"type" : "object",
"readonly" : true,
"required" : [
"_created_categories" ,
"_created_items" ,
"_moved_items" ,
"_removed_items" ,
"_top_category_id" ,
"_updated_category_versions" ],
"properties" : {
"_created_categories" : { "$ref" : "slcap://InventoryAPIv3/metaUuidArray" },
"_created_items" : { "$ref" : "slcap://InventoryAPIv3/metaUuidArray" },
"_moved_items" : { "$ref" : "slcap://InventoryAPIv3/metaUuidArray" },
"_removed_items" : { "$ref" : "slcap://InventoryAPIv3/metaUuidArray" },
"_top_category_id" : {
"type" : "uuid"
},
"_updated_category_versions": { "$ref" : "slcap://InventoryAPIv3/metaUuidIntegerMap" }
}
}]
}
},
"slcap://InventoryAPIv3/categoryChildrenMoveResponse" : {
"type" : "inline",
"schema" : {
"type" : "object",
"allOf" : [ {
"$ref" : "slcap://InventoryAPIv3/categoryChildrenResponse"
}, {
"type" : "object",
"readonly" : true,
"required" : [
"_updated_categories" ,
"_updated_items" ,
"_updated_category_versions" ],
"properties" : {
"_updated_categories" : { "$ref" : "slcap://InventoryAPIv3/metaUuidArray" },
"_updated_items" : { "$ref" : "slcap://InventoryAPIv3/metaUuidArray" },
"_updated_category_versions": { "$ref" : "slcap://InventoryAPIv3/metaUuidIntegerMap" }
}
}]
}
},
"slcap://InventoryAPIv3/categoryCategoriesMoveResponse" : {
"type" : "inline",
"schema" : {
"type" : "object",
"allOf" : [ {
"$ref" : "slcap://InventoryAPIv3/categoryCategoriesResponse"
}, {
"type" : "object",
"readonly" : true,
"required" : [
"_updated_categories" ,
"_updated_category_versions" ],
"properties" : {
"_updated_categories" : { "$ref" : "slcap://InventoryAPIv3/metaUuidArray" },
"_updated_category_versions": { "$ref" : "slcap://InventoryAPIv3/metaUuidIntegerMap" }
}
}]
}
},
"slcap://InventoryAPIv3/categoryMoveResponse" : {
"type" : "inline",
"schema" : {
"type" : "object",
"allOf" : [ {
"$ref" : "slcap://InventoryAPIv3/categoryResponse"
}, {
"type" : "object",
"readonly" : true,
"required" : [
"_updated_categories" ,
"_updated_category_versions" ],
"properties" : {
"_updated_categories" : { "$ref" : "slcap://InventoryAPIv3/metaUuidArray" },
"_updated_category_versions": { "$ref" : "slcap://InventoryAPIv3/metaUuidIntegerMap" }
}
}]
}
},
"slcap://InventoryAPIv3/categoryNewChildrenResponse" : {
"type" : "inline",
"schema" : {
"type" : "object",
"allOf" : [ {
"type" : "object",
"oneOf" : [
{ "$ref" : "slcap://InventoryAPIv3/categoryChildrenResponse" },
{ "$ref" : "slcap://InventoryAPIv3/categoryLinksResponse" }
]
}, {
"type" : "object",
"readonly" : true,
"required" : [
"_created_categories" ,
"_created_items" ,
"_updated_category_versions" ],
"properties" : {
"_created_categories" : { "$ref" : "slcap://InventoryAPIv3/metaUuidArray" },
"_created_items" : { "$ref" : "slcap://InventoryAPIv3/metaUuidArray" },
"_updated_category_versions": { "$ref" : "slcap://InventoryAPIv3/metaUuidIntegerMap" }
}
}]
}
},
"slcap://InventoryAPIv3/newEmbeddedChildren" : {
"type" : "inline",
"schema" : {
"type" : "object",
"properties" : {
"categories" : {
"type" : "array",
"items" : {
"type" : "object",
"$ref" : "slcap://InventoryAPIv3/newCategory"
}
},
"links" : {
"type" : "array",
"items" : {
"type" : "object",
"$ref" : "slcap://InventoryAPIv3/newLink"
}
},
"items" : {
"type" : "array",
"items" : {
"type" : "object",
"$ref" : "slcap://InventoryAPIv3/newItem"
}
}
}
}
},
"slcap://InventoryAPIv3/newCategory" : {
"type" : "inline",
"schema" : {
"type" : "object",
"required" : [ "name" ],
"properties" : {
"name" : {
"type" : "string",
"maxLength" : 63,
"blank" : true
},
"type_default" : {
"type" : "integer",
"minimum" : -1,
"maximum" : 51
},
"_embedded" : {
"type" : "object",
"$ref" : "slcap://InventoryAPIv3/newEmbeddedChildren"
}
}
}
},
"slcap://InventoryAPIv3/modifyCategory" : {
"type" : "inline",
"schema" : {
"type" : "object",
"required" : [ "name" ],
"properties" : {
"name" : {
"type" : "string",
"maxLength" : 63,
"blank" : true
}
}
}
},
"slcap://InventoryAPIv3/newLink" : {
"type" : "inline",
"schema" : {
"type" : "object",
"required" : [ "linked_id", "type" ],
"properties" : {
"desc" : {
"type" : "string",
"maxLength" : 127,
"blank" : true
},
"linked_id" : {
"type" : "uuid"
},
"name" : {
"type" : "string",
"maxLength" : 63,
"blank" : true
},
"type" : {
"type" : "integer",
"minimum" : 24,
"maximum" : 25
}
}
}
},
"slcap://InventoryAPIv3/newItem" : {
"type" : "inline",
"schema" : {
"type" : "object",
"required" : [ "asset_id", "name", "inv_type", "type" ],
"properties" : {
"asset_id" : {
"type" : "uuid"
},
"desc" : {
"type" : "string",
"maxLength" : 127,
"blank" : true
},
"flags" : {
"type" : "integer",
"minimum" : 0
},
"inv_type" : {
"type" : "integer",
"minimum" : 0,
"maximum" : 22
},
"name" : {
"type" : "string",
"maxLength" : 63,
"blank" : true
},
"permissions" : {
"type" : "object",
"properties" : {
"base_mask" : {
"type" : "integer",
"minimum" : 0
},
"everyone_mask" : {
"type" : "integer",
"minimum" : 0
},
"group_mask" : {
"type" : "integer",
"minimum" : 0
},
"next_owner_mask" : {
"type" : "integer",
"minimum" : 0
},
"owner_mask" : {
"type" : "integer",
"minimum" : 0
}
}
},
"sale_info" : {
"type" : "object",
"properties" : {
"sale_price" : {
"type" : "integer",
"minimum" : 0
},
"sale_type" : {
"type" : "integer",
"minimum" : 0,
"maximum" : 3
}
}
},
"type" : {
"type" : "integer",
"minimum" : -1,
"maximum" : 51
}
}
}
},
"slcap://InventoryAPIv3/categoryDeleteResponse" : {
"type" : "inline",
"schema" : {
"type" : "object",
"readonly" : true,
"required" : [
"_active_gestures_removed",
"_attachments_removed",
"_broken_links_removed",
"_categories_removed",
"_category_items_removed",
"_total_items_removed",
"_updated_category_versions",
"_wearables_removed" ],
"properties" : {
"_active_gestures_removed": { "$ref" : "slcap://InventoryAPIv3/metaUuidArray" },
"_attachments_removed": { "$ref" : "slcap://InventoryAPIv3/metaIntegerUuidMap" },
"_broken_links_removed": { "$ref" : "slcap://InventoryAPIv3/metaUuidArray" },
"_categories_removed": { "$ref" : "slcap://InventoryAPIv3/metaUuidArray" },
"_category_items_removed": { "$ref" : "slcap://InventoryAPIv3/metaUuidArray" },
"_total_items_removed": { "type" : "integer" },
"_updated_category_versions": { "$ref" : "slcap://InventoryAPIv3/metaUuidIntegerMap" },
"_wearables_removed": { "$ref" : "slcap://InventoryAPIv3/metaIntegerUuidMap" },
"_update_result": { "$ref" : "slcap://InventoryAPIv3/inventoryUpdateResponse" }
}
}
},
"slcap://InventoryAPIv3/metaUuidArray" : {
"type" : "inline",
"schema" : {
"type" : "array",
"items" : { "type" : "uuid" },
"uniqueItems" : true
}
},
"slcap://InventoryAPIv3/metaUuidUuidMap" : {
"type" : "inline",
"schema" : {
"type" : "object",
"patternProperties": {
"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" : {
"type" : "uuid"
}
},
"additionalProperties" : false
}
},
"slcap://InventoryAPIv3/metaUuidIntegerMap" : {
"type" : "inline",
"schema" : {
"type" : "object",
"patternProperties": {
"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" : {
"type" : "integer"
}
},
"additionalProperties" : false
}
},
"slcap://InventoryAPIv3/metaIntegerUuidMap" : {
"type" : "inline",
"schema" : {
"type" : "object",
"patternProperties": {
"^[0-9]+$": {
"type" : "uuid"
}
},
"additionalProperties" : false
}
},
"slcap://InventoryAPIv3/metaLinkEmbedded" : {
"type" : "inline",
"schema" : {
"type" : "object",
"description" : "Embedded link meta information.",
"required" : [ "_links" ],
"properties" : {
"_links" : {
"type" : "object",
"allOf" : [ {
"type" : "object",
"oneOf" : [ {
"type" : "object",
"readonly" : true,
"required" : [ "item" ],
"properties" : {
"item" : { "$ref" : "slcap://InventoryAPIv3/metaLink" }
}
}, {
"type" : "object",
"readonly" : true,
"required" : [ "category" ],
"properties" : {
"category" : { "$ref" : "slcap://InventoryAPIv3/metaLink" }
}
} ]
}, {
"type" : "object",
"readonly" : true,
"required" : [ "parent", "self" ],
"properties" : {
"parent" : { "$ref" : "slcap://InventoryAPIv3/metaLink" },
"self" : { "$ref" : "slcap://InventoryAPIv3/metaLink" }
}
} ]
}
}
}
},
"slcap://InventoryAPIv3/metaItemEmbedded" : {
"type" : "inline",
"schema" : {
"type" : "object",
"description" : "Embedded item meta information.",
"required" : [ "_links" ],
"properties" : {
"_links" : {
"type" : "object",
"readonly" : true,
"required" : [ "parent", "self" ],
"properties" : {
"parent" : { "$ref" : "slcap://InventoryAPIv3/metaLink" },
"self" : { "$ref" : "slcap://InventoryAPIv3/metaLink" }
}
}
}
}
},
"slcap://InventoryAPIv3/metaLinkResponse" : {
"type" : "inline",
"schema" : {
"type" : "object",
"description" : "Link meta information.",
"allOf" : [ {
"type" : "object",
"required" : [ "_base_uri" ],
"properties" : {
"_base_uri" : {
"type" : "string",
"format" : "uri",
"readonly" : true
}
}
}, {
"$ref" : "slcap://InventoryAPIv3/metaLinkEmbedded"
} ]
}
},
"slcap://InventoryAPIv3/metaItemResponse" : {
"type" : "inline",
"schema" : {
"type" : "object",
"description" : "Item meta information.",
"required" : [ "_base_uri", "_links" ],
"properties" : {
"_base_uri" : {
"type" : "string",
"format" : "uri",
"readonly" : true
},
"_links" : {
"type" : "object",
"readonly" : true,
"required" : [ "parent", "self" ],
"properties" : {
"parent" : { "$ref" : "slcap://InventoryAPIv3/metaLink" },
"self" : { "$ref" : "slcap://InventoryAPIv3/metaLink" }
}
}
}
}
},
"slcap://InventoryAPIv3/metaEmbeddedCategoryLinks" : {
"type" : "inline",
"schema" : {
"type" : "object",
"description" : "Embedded category meta information.",
"readonly" : true,
"required" : [ "parent", "self" ],
"properties" : {
"parent" : { "$ref" : "slcap://InventoryAPIv3/metaLink" },
"self" : { "$ref" : "slcap://InventoryAPIv3/metaLink" }
}
}
},
"slcap://InventoryAPIv3/metaCategoryEmbedded" : {
"type" : "inline",
"schema" : {
"type" : "object",
"description" : "Embedded category meta information.",
"required" : [ "_links" ],
"properties" : {
"_links" : {
"$ref" : "slcap://InventoryAPIv3/metaEmbeddedCategoryLinks"
}
}
}
},
"slcap://InventoryAPIv3/metaCategoryResponse" : {
"type" : "inline",
"schema" : {
"type" : "object",
"description" : "Category response meta information.",
"required" : ["_base_uri", "_links"],
"properties" : {
"_base_uri" : {
"type" : "string",
"format" : "uri",
"readonly" : true
},
"_links" : {
"type" : "object",
"readonly" : true,
"allOf" : [{
"$ref" : "slcap://InventoryAPIv3/metaEmbeddedCategoryLinks"
}, {
"type" : "object",
"readonly" : true,
"required" : [ "self", "children", "items", "links", "parent" ],
"properties" : {
"categories" : { "$ref" : "slcap://InventoryAPIv3/metaLink" },
"category" : { "$ref" : "slcap://InventoryAPIv3/metaLink" },
"children" : { "$ref" : "slcap://InventoryAPIv3/metaLink" },
"items" : { "$ref" : "slcap://InventoryAPIv3/metaLink" },
"links" : { "$ref" : "slcap://InventoryAPIv3/metaLink" },
"parent" : { "$ref" : "slcap://InventoryAPIv3/metaLink" },
"self" : { "$ref" : "slcap://InventoryAPIv3/metaLink" }
}
}]
}
}
}
},
"slcap://InventoryAPIv3/metaLink" : {
"type" : "inline",
"schema" : {
"type" : "object",
"description" : "Link reference to another resource.",
"required" : [ "href" ],
"properties" : {
"href" : {
"type" : "string",
"format" : "uri"
},
"name" : { "enum" : [ "self", "link" ] }
}
}
},
"slcap://InventoryAPIv3/empty" : {
"type" : "inline",
"schema" : {
"type" : "string",
"blank" : true,
"maxLength" : 0
}
},
"slcap://InventoryAPIv3/errorInvalidPermissions" : {
"type" : "inline",
"schema" : {
"type" : "object",
"description" : "Permissions check failed.",
"allOf" : [{
"$ref" : "slcap://InventoryAPIv3/errorDescription"
}, {
"type" : "object",
"required" : [ "error_code" ],
"properties" : {
"error_code" : {
"type" : "integer",
"minimum" : 14,
"maximum" : 14
}
}
}]
}
},
"slcap://InventoryAPIv3/errorDuplicateTransaction" : {
"type" : "inline",
"schema" : {
"type" : "object",
"description" : "Duplication transaction.",
"allOf" : [{
"$ref" : "slcap://InventoryAPIv3/errorDescription"
}, {
"type" : "object",
"required" : [ "error_code", "transaction_id" ],
"properties" : {
"error_code" : {
"type" : "integer",
"minimum" : 8,
"maximum" : 8
},
"transaction_id" : {
"type" : "string"
}
}
}]
}
},
"slcap://InventoryAPIv3/errorPreconditionFailed" : {
"type" : "inline",
"schema" : {
"type" : "object",
"description" : "Precondition failed.",
"allOf" : [{
"$ref" : "slcap://InventoryAPIv3/errorDescription"
}, {
"type" : "object",
"required" : [ "error_code", "etag", "etags", "condition" ],
"properties" : {
"error_code" : {
"type" : "integer",
"minimum" : 10,
"maximum" : 10
},
"etag" : {
"type" : "string"
},
"etags" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"condition" : {
"type" : "string"
}
}
}]
}
},
"slcap://InventoryAPIv3/errorResourceNotFound" : {
"type" : "inline",
"schema" : {
"type" : "object",
"description" : "Item not found error response.",
"allOf" : [{
"$ref" : "slcap://InventoryAPIv3/errorDescription"
}, {
"type" : "object",
"required" : [ "error_code" ],
"properties" : {
"error_code" : {
"type" : "integer",
"minimum" : 4,
"maximum" : 4
}
}
}]
}
},
"slcap://InventoryAPIv3/errorItemNotFound" : {
"type" : "inline",
"schema" : {
"type" : "object",
"description" : "Item not found error response.",
"allOf" : [{
"$ref" : "slcap://InventoryAPIv3/errorDescription"
}, {
"type" : "object",
"required" : [ "error_code" ],
"properties" : {
"error_code" : {
"type" : "integer",
"minimum" : 4,
"maximum" : 4
},
"item_id" : {
"type" : "uuid"
}
}
}]
}
},
"slcap://InventoryAPIv3/errorItemGone" : {
"type" : "inline",
"schema" : {
"type" : "object",
"description" : "Item gone error response.",
"allOf" : [{
"$ref" : "slcap://InventoryAPIv3/errorDescription"
}, {
"type" : "object",
"required" : [ "error_code", "item_id" ],
"properties" : {
"error_code" : {
"type" : "integer",
"minimum" : 9,
"maximum" : 9
},
"item_id" : {
"type" : "uuid"
}
}
}]
}
},
"slcap://InventoryAPIv3/errorCategoryGone" : {
"type" : "inline",
"schema" : {
"type" : "object",
"description" : "Category gone error response.",
"allOf" : [{
"$ref" : "slcap://InventoryAPIv3/errorDescription"
}, {
"type" : "object",
"required" : [ "error_code" ],
"properties" : {
"error_code" : {
"type" : "integer",
"minimum" : 9,
"maximum" : 9
},
"category_id" : {
"type" : "uuid"
}
}
}]
}
},
"slcap://InventoryAPIv3/errorCategoryNotFound" : {
"type" : "inline",
"schema" : {
"type" : "object",
"description" : "Category not found error response.",
"allOf" : [{
"$ref" : "slcap://InventoryAPIv3/errorDescription"
}, {
"type" : "object",
"required" : [ "error_code" ],
"properties" : {
"error_code" : {
"type" : "integer",
"minimum" : 4,
"maximum" : 6
},
"category_id" : {
"type" : "uuid"
}
}
}]
}
},
"slcap://InventoryAPIv3/errorInvalidItemRequest" : {
"type" : "inline",
"schema" : {
"type" : "object",
"description" : "Invalid request on item resource.",
"allOf" : [{
"$ref" : "slcap://InventoryAPIv3/errorDescription"
}, {
"type" : "object",
"required" : [ "error_code" ],
"properties" : {
"error_code" : {
"type" : "integer",
"minimum" : 0,
"maximum" : 0
},
"item_id" : {
"type" : "uuid"
}
}
}]
}
},
"slcap://InventoryAPIv3/errorInvalidLinksShape" : {
"type" : "inline",
"schema" : {
"type" : "object",
"description" : "Invalid links body shape.",
"allOf" : [{
"$ref" : "slcap://InventoryAPIv3/errorDescription"
}, {
"type" : "object",
"required" : [ "error_code" ],
"properties" : {
"error_code" : {
"type" : "integer",
"minimum" : 1,
"maximum" : 1
},
"invalid_linked_ids" : {
"$ref" : "slcap://InventoryAPIv3/metaUuidArray"
}
}
}]
}
},
"slcap://InventoryAPIv3/errorInvalidRequest" : {
"type" : "inline",
"schema" : {
"type" : "object",
"description" : "Invalid request.",
"allOf" : [{
"$ref" : "slcap://InventoryAPIv3/errorDescription"
}, {
"type" : "object",
"required" : [ "error_code" ],
"properties" : {
"error_code" : {
"type" : "integer",
"minimum" : 0,
"maximum" : 0
}
}
}]
}
},
"slcap://InventoryAPIv3/errorInvalidCategoryRequest" : {
"type" : "inline",
"schema" : {
"type" : "object",
"description" : "Invalid request on category resource.",
"allOf" : [{
"$ref" : "slcap://InventoryAPIv3/errorDescription"
}, {
"type" : "object",
"required" : [ "error_code" ],
"properties" : {
"error_code" : {
"type" : "integer",
"minimum" : 0,
"maximum" : 0
},
"category_id" : {
"type" : "uuid"
}
}
}]
}
},
"slcap://InventoryAPIv3/errorDescription" : {
"type" : "inline",
"schema" : {
"type" : "object",
"description" : "Error response description.",
"required" : [ "error_description" ],
"properties" : {
"error_description" : {
"type" : "string"
},
"error_filename" : {
"type" : "string"
},
"error_function" : {
"type" : "string"
},
"error_line_number" : {
"type" : "integer"
}
}
}
},
"slcap://InventoryAPIv3/errorGeneral" : {
"type" : "inline",
"schema" : {
"type" : "object",
"description" : "General error response.",
"allOf" : [{
"$ref" : "slcap://InventoryAPIv3/errorDescription"
}, {
"type" : "object",
"required" : [ "error_code" ],
"properties" : {
"error_code" : {
"type" : "integer",
"minimum" : 0,
"maximum" : 17
}
}
}]
}
}
},
"statusCodes" : {
"400" : {
"description" : "Invalid request",
"response" : {
"types" : [{
"type" : "application/llsd+xml",
"schema" : "slcap://InventoryAPIv3/errorGeneral"
}
]
}
},
"415" : {
"description" : "Unsupported media type",
"response" : {
"types" : [{
"type" : "application/llsd+xml",
"schema" : "slcap://InventoryAPIv3/errorGeneral"
}
]
}
},
"500" : {
"description" : "Internal Error",
"response" : {
"types" : [{
"type" : "application/llsd+xml",
"schema" : "slcap://InventoryAPIv3/errorGeneral"
}
]
}
}
},
"headers" : {
"request" : {
"Accept" : {
"description" : "Preferred response Content-Type. Generally <code>application/llsd+xml</code> or <code>application/json</code>."
},
"Accept-Encoding" : {
"description" : "Preferred response encoding (e.g. 'gzip')"
},
"Cache-Control" : {
"description" : "Directives to caching mechanisms."
},
"Content-Type" : {
"description" : "Content type of request payload. Generally <code>application/llsd+xml</code> or <code>application/json</code>."
}
},
"response" : {
"Cache-Control" : {
"description" : "Directives to caching mechanisms."
},
"Content-Encoding" : {
"description" : "Response encoding (e.g. 'gzip')"
},
"Content-Location" : {
"description" : "Canonical location of requested resource."
},
"Content-Type" : {
"description" : "Content type of response payload. Generally <code>application/llsd+xml</code> or <code>application/json</code>."
},
"Vary" : {
"description" : "Indicates the set of request-header fields that determines request variants. Used by caching mechanisms.",
"required" : true
}
}
},
"resources" : [{
"id" : "Category",
"description" : "An inventory category.",
"path" : "/category/{category}{?tid,depth,simulate}",
"params" : {
"category" : {
"description" : "Category UUID or 'special' category name, e.g. \"current\".",
"validations" : [{
"type" : "match",
"pattern" : "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"
}, {
"type" : "match",
"pattern" : "^(animatn|bodypart|clothing|current|favorite|gesture|inbox|landmark|lsltext)$"
}, {
"type" : "match",
"pattern" : "^(lstndfnd|my_otfts|notecard|object|outbox|root|snapshot|sound|texture|trash)$"
}
]
},
"tid" : {
"description" : "Transaction ID."
},
"depth" : {
"description" : "Category child depth to retrieve.",
"default" : 0,
"validations" : [{
"type" : "match",
"pattern" : "^(\\*|[0-9]+)?$"
}]
},
"simulate" : {
"description" : "Whether or not to skip writing back results.",
"default" : 0,
"validations" : [{
"type" : "match",
"pattern" : "^(0|1|true|false)?$"
}]
}
},
"methods" : {
"GET" : {
"description" : "Retrieve a category",
"statusCodes" : {
"200" : {
"description" : "Category retrieved successfully",
"response" : {
"types" : [{
"type" : "application/llsd+xml",
"schema" : "slcap://InventoryAPIv3/categoryResponse"
}, {
"type" : "application/llsd+xml",
"schema" : "slcap://InventoryAPIv3/categoryChildrenResponse"
}
],
"headers" : {
"ETag" : {
"description" : "Current value of the entity tag for the requested variant.",
"required" : true
}
}
}
},
"304" : {
"description" : "Not modified",
"response" : {
"types" : [{
"type" : "application/llsd+xml",
"schema" : "slcap://InventoryAPIv3/empty"
}],
"headers" : {
"ETag" : {
"description" : "Current value of the entity tag for the requested variant.",
"required" : true
}
}
}
},
"404" : {
"description" : "Category not found",
"response" : {
"types" : [{
"type" : "application/llsd+xml",
"schema" : "slcap://InventoryAPIv3/errorCategoryNotFound"
}
]
}
},
"412" : {
"description" : "Precondition failed",
"response" : {
"types" : [{
"type" : "application/llsd+xml",
"schema" : "slcap://InventoryAPIv3/errorPreconditionFailed"
}
],
"headers" : {
"ETag" : {
"description" : "Current value of the entity tag for the requested variant.",
"required" : true
}
}
}
}
},
"headers" : {
"If-Match" : {
"description" : "Only process request if any supplied entity tags matches resource."
},
"If-None-Match" : {
"description" : "Only process request if none of the supplied entity tags matches resource."
}
}
},
"POST" : {
"description" : "Create inventory in category.",
"statusCodes" : {
"201" : {
"description" : "Inventory created",
"response" : {
"types" : [{
"type" : "application/llsd+xml",
"schema" : "slcap://InventoryAPIv3/categoryNewChildrenResponse"
}
],
"headers" : {
"Location" : {
"description" : "The URL of the category children containing the created inventory.",
"required" : true
}
}
}
},
"400" : {
"description" : "Invalid request",
"response" : {
"types" : [{
"type" : "application/llsd+xml",
"schema" : "slcap://InventoryAPIv3/errorInvalidLinksShape"
}, {
"type" : "application/llsd+xml",
"schema" : "slcap://InventoryAPIv3/errorInvalidRequest"
}
]
}
},
"404" : {
"description" : "Category not found",
"response" : {
"types" : [{
"type" : "application/llsd+xml",
"schema" : "slcap://InventoryAPIv3/errorCategoryNotFound"
}
]
}
},
"409" : {
"description" : "Duplicate transaction.",
"response" : {
"types" : [{
"type" : "application/llsd+xml",
"schema" : "slcap://InventoryAPIv3/errorDuplicateTransaction"
}
]
}
},
"412" : {
"description" : "Precondition failed",
"response" : {
"types" : [{
"type" : "application/llsd+xml",
"schema" : "slcap://InventoryAPIv3/errorPreconditionFailed"
}
],
"headers" : {
"ETag" : {
"description" : "Current value of the entity tag for the requested variant.",
"required" : true
}
}
}
}
},
"headers" : {
"If-Match" : {
"description" : "Only process request if any supplied entity tags matches resource."
},
"If-None-Match" : {
"description" : "Only process request if none of the supplied entity tags matches resource."
}
},
"accepts" : [{
"type" : "application/llsd+xml",
"schema" : "slcap://InventoryAPIv3/newEmbeddedChildren"
}
]
},
"PUT" : {
"description" : "Create and retrieve a 'special' category.",
"statusCodes" : {
"201" : {
"description" : "Category created",
"response" : {
"types" : [{
"type" : "application/llsd+xml",
"schema" : "slcap://InventoryAPIv3/categoryNewResponse"
}
],
"headers" : {
"Location" : {
"description" : "The URL of the created category",
"required" : true
}
}
}
},
"404" : {
"description" : "Category not found",
"response" : {
"types" : [{
"type" : "application/llsd+xml",
"schema" : "slcap://InventoryAPIv3/errorCategoryNotFound"
}
]
}
},
"409" : {
"description" : "Category already exists",
"response" : {
"types" : [{
"type" : "application/llsd+xml",
"schema" : "slcap://InventoryAPIv3/categoryResponse"
}
]
}
},
"412" : {
"description" : "Precondition failed",
"response" : {
"types" : [{
"type" : "application/llsd+xml",
"schema" : "slcap://InventoryAPIv3/errorPreconditionFailed"
}
],
"headers" : {
"ETag" : {
"description" : "Current value of the entity tag for the requested variant.",
"required" : true
}
}
}
}
},
"headers" : {
"If-Match" : {
"description" : "Only process request if any supplied entity tags matches resource."
},
"If-None-Match" : {
"description" : "Only process request if none of the supplied entity tags matches resource."
}
}
},
"PATCH" : {
"description" : "Modify a category",
"statusCodes" : {
"200" : {
"description" : "Category modified successfully",
"response" : {
"types" : [{
"type" : "application/llsd+xml",
"schema" : "slcap://InventoryAPIv3/categoryModifyResponse"
}
],
"headers" : {
"ETag" : {
"description" : "Current value of the entity tag for the requested variant.",
"required" : true
}
}
}
},
"400" : {
"description" : "Invalid request",
"response" : {
"types" : [{
"type" : "application/llsd+xml",
"schema" : "slcap://InventoryAPIv3/errorInvalidCategoryRequest"
}
]
}
},
"404" : {
"description" : "Category not found",
"response" : {
"types" : [{
"type" : "application/llsd+xml",
"schema" : "slcap://InventoryAPIv3/errorCategoryNotFound"
}
]
}
},
"412" : {
"description" : "Precondition failed",
"response" : {
"types" : [{
"type" : "application/llsd+xml",
"schema" : "slcap://InventoryAPIv3/errorPreconditionFailed"
}
],
"headers" : {
"ETag" : {
"description" : "Current value of the entity tag for the requested variant.",
"required" : true
}
}
}
}
},
"headers" : {
"If-Match" : {
"description" : "Only process request if any supplied entity tags matches resource."
},
"If-None-Match" : {
"description" : "Only process request if none of the supplied entity tags matches resource."
}
},
"accepts" : [{
"type" : "application/llsd+xml",
"schema" : "slcap://InventoryAPIv3/modifyCategory"
}
],
"examples" : [{
"path" : "/category/60195d06-7f16-4927-a642-e18bd50fe4e7",
"headers" : {
"Content-Type" : "application/llsd+xml"
},
"body" : "<llsd>\n <map>\n <key>name</key>\n <string>New Category Name</string>\n </map>\n</llsd>"
}
]
},
"COPY" : {
"description" : "Copy a category",
"statusCodes" : {
"201" : {
"description" : "Category copied successfully",
"response" : {
"types" : [{
"type" : "application/llsd+xml",
"schema" : "slcap://InventoryAPIv3/categoryCopyResponse"
}
],
"headers" : {
"ETag" : {
"description" : "Current value of the entity tag for the requested variant.",
"required" : true
},
"Location" : {
"description" : "The URL of the copied inventory.",
"required" : true
}
}
}
},
"403" : {
"description" : "Permissions check failed.",
"response" : {
"types" : [{
"type" : "application/llsd+xml",
"schema" : "slcap://InventoryAPIv3/errorInvalidPermissions"
}
]
}
},
"404" : {
"description" : "Destination category not found.",
"response" : {
"types" : [{
"type" : "application/llsd+xml",
"schema" : "slcap://InventoryAPIv3/errorCategoryNotFound"
}
]
}
},
"409" : {
"description" : "Duplicate transaction.",
"response" : {
"types" : [{
"type" : "application/llsd+xml",
"schema" : "slcap://InventoryAPIv3/errorDuplicateTransaction"
}
]
}
},
"410" : {
"description" : "Source category gone",
"response" : {
"types" : [{
"type" : "application/llsd+xml",
"schema" : "slcap://InventoryAPIv3/errorCategoryGone"
}
]
}
},
"412" : {
"description" : "Precondition failed",
"response" : {
"types" : [{
"type" : "application/llsd+xml",
"schema" : "slcap://InventoryAPIv3/errorPreconditionFailed"
}
],
"headers" : {
"ETag" : {
"description" : "Current value of the entity tag for the requested variant.",
"required" : true
}
}
}
}
},
"headers" : {
"Destination" : {
"description" : "Destination category_id or 'special' category.",
"required" : true
},
"If-Match" : {
"description" : "Only process request if any supplied entity tags matches resource."
},
"If-None-Match" : {
"description" : "Only process request if none of the supplied entity tags matches resource."
}
}
},
"MOVE" : {
"description" : "Move a category",
"statusCodes" : {
"200" : {
"description" : "Category moved successfully",
"response" : {
"types" : [{
"type" : "application/llsd+xml",
"schema" : "slcap://InventoryAPIv3/categoryMoveResponse"
}
],
"headers" : {
"ETag" : {
"description" : "Current value of the entity tag for the requested variant.",
"required" : true
},
"Location" : {
"description" : "The URL of the moved inventory.",
"required" : true
}
}
}
},
"403" : {
"description" : "Permissions check failed.",
"response" : {
"types" : [{
"type" : "application/llsd+xml",
"schema" : "slcap://InventoryAPIv3/errorInvalidPermissions"
}
]
}
},
"404" : {
"description" : "Destination category not found.",
"response" : {
"types" : [{
"type" : "application/llsd+xml",
"schema" : "slcap://InventoryAPIv3/errorCategoryNotFound"
}
]
}
},
"410" : {
"description" : "Source category gone",
"response" : {
"types" : [{
"type" : "application/llsd+xml",
"schema" : "slcap://InventoryAPIv3/errorCategoryGone"
}
]
}
},
"412" : {
"description" : "Precondition failed",
"response" : {
"types" : [{
"type" : "application/llsd+xml",
"schema" : "slcap://InventoryAPIv3/errorPreconditionFailed"
}
],
"headers" : {
"ETag" : {
"description" : "Current value of the entity tag for the requested variant.",
"required" : true
}
}
}
}
},
"headers" : {
"If-Match" : {
"description" : "Only process request if any supplied entity tags matches resource."
},
"If-None-Match" : {
"description" : "Only process request if none of the supplied entity tags matches resource."
},
"Destination" : {
"description" : "Destination category_id.",
"required" : true
}
}
},
"DELETE" : {
"description" : "Delete a category",
"statusCodes" : {
"200" : {
"description" : "Category deleted successfully",
"response" : {
"types" : [{
"type" : "application/llsd+xml",
"schema" : "slcap://InventoryAPIv3/categoryDeleteResponse"
}
]
}
},
"410" : {
"description" : "Category gone",
"response" : {
"types" : [{
"type" : "application/llsd+xml",
"schema" : "slcap://InventoryAPIv3/errorCategoryGone"
}
]
}
},
"412" : {
"description" : "Precondition failed",
"response" : {
"types" : [{
"type" : "application/llsd+xml",
"schema" : "slcap://InventoryAPIv3/errorPreconditionFailed"
}
],
"headers" : {
"ETag" : {
"description" : "Current value of the entity tag for the requested variant.",
"required" : true
}
}
}
}
},
"headers" : {
"If-Match" : {
"description" : "Only process request if any supplied entity tags matches resource."
},
"If-None-Match" : {
"description" : "Only process request if none of the supplied entity tags matches resource."
}
}
}
}
}, {
"id" : "CategoryChildren",
"description" : "Children in an inventory category.",
"path" : "/category/{category}/children{?tid,depth,simulate}",
"params" : {
"category" : {
"description" : "Category UUID or 'special' category name, e.g. \"current\".",
"validations" : [{
"type" : "match",
"pattern" : "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"
}, {
"type" : "match",
"pattern" : "^(animatn|bodypart|clothing|current|favorite|gesture|inbox|landmark|lsltext)$"
}, {
"type" : "match",
"pattern" : "^(lstndfnd|my_otfts|notecard|object|outbox|root|snapshot|sound|texture|trash)$"
}
]
},
"tid" : {
"description" : "Transaction ID."
},
"depth" : {
"description" : "Category child depth to retrieve.",
"default" : 0,
"validations" : [{
"type" : "match",
"pattern" : "^(\\*|[0-9]+)?$"
}]
},
"simulate" : {
"description" : "Whether or not to skip writing back results.",
"default" : 0,
"validations" : [{
"type" : "match",
"pattern" : "^(0|1|true|false)?$"
}]
}
},
"methods" : {
"GET" : {
"description" : "Retrieve children in a category",
"statusCodes" : {
"200" : {
"description" : "Category children retrieved successfully",
"response" : {
"types" : [{
"type" : "application/llsd+xml",
"schema" : "slcap://InventoryAPIv3/categoryChildrenResponse"
}
],
"headers" : {
"ETag" : {
"description" : "Current value of the entity tag for the requested variant.",
"required" : true
}
}
}
},
"304" : {
"description" : "Not modified",
"response" : {
"types" : [{
"type" : "application/llsd+xml",
"schema" : "slcap://InventoryAPIv3/empty"
}],
"headers" : {
"ETag" : {
"description" : "Current value of the entity tag for the requested variant.",
"required" : true
}
}
}
},
"404" : {
"description" : "Category not found",
"response" : {
"types" : [{
"type" : "application/llsd+xml",
"schema" : "slcap://InventoryAPIv3/errorCategoryNotFound"
}
]
}
},
"412" : {
"description" : "Precondition failed",
"response" : {
"types" : [{
"type" : "application/llsd+xml",
"schema" : "slcap://InventoryAPIv3/errorPreconditionFailed"
}
],
"headers" : {
"ETag" : {
"description" : "Current value of the entity tag for the requested variant.",
"required" : true
}
}
}
}
},
"headers" : {
"If-Match" : {
"description" : "Only process request if any supplied entity tags matches resource."
},
"If-None-Match" : {
"description" : "Only process request if none of the supplied entity tags matches resource."
}
}
},
"PUT" : {
"description" : "Replace category children.",
"statusCodes" : {
"201" : {
"description" : "Category children replaced",
"response" : {
"types" : [{
"type" : "application/llsd+xml",
"schema" : "slcap://InventoryAPIv3/categoryChildrenReplaceResponse"
}
],
"headers" : {
"ETag" : {
"description" : "Current value of the entity tag for the requested variant.",
"required" : true
},
"Location" : {
"description" : "The URL of the replaced category children.",
"required" : true
}
}
}
},
"404" : {
"description" : "Category not found",
"response" : {
"types" : [{
"type" : "application/llsd+xml",
"schema" : "slcap://InventoryAPIv3/errorCategoryNotFound"
}
]
}
},
"412" : {
"description" : "Precondition failed",
"response" : {
"types" : [{
"type" : "application/llsd+xml",
"schema" : "slcap://InventoryAPIv3/errorPreconditionFailed"
}
],
"headers" : {
"ETag" : {
"description" : "Current value of the entity tag for the requested variant.",
"required" : true
}
}
}
}
},
"headers" : {
"If-Match" : {
"description" : "Only process request if any supplied entity tags matches resource."
},
"If-None-Match" : {
"description" : "Only process request if none of the supplied entity tags matches resource."
}
},
"accepts" : [{
"type" : "application/llsd+xml",
"schema" : "slcap://InventoryAPIv3/newEmbeddedChildren"
}
]
},
"COPY" : {
"description" : "Copy category children",
"statusCodes" : {
"201" : {
"description" : "Category children copied successfully",
"response" : {
"types" : [{
"type" : "application/llsd+xml",
"schema" : "slcap://InventoryAPIv3/categoryCopyResponse"
}
],
"headers" : {
"ETag" : {
"description" : "Current value of the entity tag for the requested variant.",
"required" : true
},
"Location" : {
"description" : "The URL of the copied inventory.",
"required" : true
}
}
}
},
"403" : {
"description" : "Permissions check failed.",
"response" : {
"types" : [{
"type" : "application/llsd+xml",
"schema" : "slcap://InventoryAPIv3/errorInvalidPermissions"
}
]
}
},
"404" : {
"description" : "Destination category not found.",
"response" : {
"types" : [{
"type" : "application/llsd+xml",
"schema" : "slcap://InventoryAPIv3/errorCategoryNotFound"
}
]
}
},
"410" : {
"description" : "Source category gone",
"response" : {
"types" : [{
"type" : "application/llsd+xml",
"schema" : "slcap://InventoryAPIv3/errorCategoryGone"
}
]
}
},
"412" : {
"description" : "Precondition failed",
"response" : {
"types" : [{
"type" : "application/llsd+xml",
"schema" : "slcap://InventoryAPIv3/errorPreconditionFailed"
}
],
"headers" : {
"ETag" : {
"description" : "Current value of the entity tag for the requested variant.",
"required" : true
}
}
}
}
},
"headers" : {
"If-Match" : {
"description" : "Only process request if any supplied entity tags matches resource."
},
"If-None-Match" : {
"description" : "Only process request if none of the supplied entity tags matches resource."
},
"Destination" : {
"description" : "Destination category_id or 'special' category.",
"required" : true
}
}
},
"MOVE" : {
"description" : "Move category children",
"statusCodes" : {
"200" : {
"description" : "Category children moved successfully",
"response" : {
"types" : [{
"type" : "application/llsd+xml",
"schema" : "slcap://InventoryAPIv3/categoryChildrenMoveResponse"
}
],
"headers" : {
"ETag" : {
"description" : "Current value of the entity tag for the requested variant.",
"required" : true
},
"Location" : {
"description" : "The URL of the moved inventory.",
"required" : true
}
}
}
},
"403" : {
"description" : "Permissions check failed.",
"response" : {
"types" : [{
"type" : "application/llsd+xml",
"schema" : "slcap://InventoryAPIv3/errorInvalidPermissions"
}
]
}
},
"404" : {
"description" : "Destination category not found.",
"response" : {
"types" : [{
"type" : "application/llsd+xml",
"schema" : "slcap://InventoryAPIv3/errorCategoryNotFound"
}
]
}
},
"410" : {
"description" : "Source category gone",
"response" : {
"types" : [{
"type" : "application/llsd+xml",
"schema" : "slcap://InventoryAPIv3/errorCategoryGone"
}
]
}
},
"412" : {
"description" : "Precondition failed",
"response" : {
"types" : [{
"type" : "application/llsd+xml",
"schema" : "slcap://InventoryAPIv3/errorPreconditionFailed"
}
],
"headers" : {
"ETag" : {
"description" : "Current value of the entity tag for the requested variant.",
"required" : true
}
}
}
}
},
"headers" : {
"If-Match" : {
"description" : "Only process request if any supplied entity tags matches resource."
},
"If-None-Match" : {
"description" : "Only process request if none of the supplied entity tags matches resource."
},
"Destination" : {
"description" : "Destination category_id.",
"required" : true
}
}
},
"DELETE" : {
"description" : "Delete category children",
"statusCodes" : {
"200" : {
"description" : "Category children deleted successfully",
"response" : {
"types" : [{
"type" : "application/llsd+xml",
"schema" : "slcap://InventoryAPIv3/categoryDeleteResponse"
}
]
}
},
"410" : {
"description" : "Category gone",
"response" : {
"types" : [{
"type" : "application/llsd+xml",
"schema" : "slcap://InventoryAPIv3/errorCategoryGone"
}
]
}
},
"412" : {
"description" : "Precondition failed",
"response" : {
"types" : [{
"type" : "application/llsd+xml",
"schema" : "slcap://InventoryAPIv3/errorPreconditionFailed"
}
],
"headers" : {
"ETag" : {
"description" : "Current value of the entity tag for the requested variant.",
"required" : true
}
}
}
}
},
"headers" : {
"If-Match" : {
"description" : "Only process request if any supplied entity tags matches resource."
},
"If-None-Match" : {
"description" : "Only process request if none of the supplied entity tags matches resource."
}
}
}
}
}, {
"id" : "CategoryLinks",
"description" : "Links in an inventory category.",
"path" : "/category/{category}/links{?tid,simulate}",
"params" : {
"category" : {
"description" : "Category UUID or 'special' category name, e.g. \"current\".",
"validations" : [{
"type" : "match",
"pattern" : "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"
}, {
"type" : "match",
"pattern" : "^(animatn|bodypart|clothing|current|favorite|gesture|inbox|landmark|lsltext)$"
}, {
"type" : "match",
"pattern" : "^(lstndfnd|my_otfts|notecard|object|outbox|root|snapshot|sound|texture|trash)$"
}
]
},
"tid" : {
"description" : "Transaction ID."
},
"simulate" : {
"description" : "Whether or not to skip writing back results.",
"default" : 0,
"validations" : [{
"type" : "match",
"pattern" : "^(0|1|true|false)?$"
}]
}
},
"methods" : {
"GET" : {
"description" : "Retrieve links in a category",
"statusCodes" : {
"200" : {
"description" : "Category links retrieved successfully",
"response" : {
"types" : [{
"type" : "application/llsd+xml",
"schema" : "slcap://InventoryAPIv3/categoryLinksResponse"
}
]
}
},
"404" : {
"description" : "Category not found",
"response" : {
"types" : [{
"type" : "application/llsd+xml",
"schema" : "slcap://InventoryAPIv3/errorCategoryNotFound"
}
]
}
}
}
},
"PUT" : {
"description" : "Replace category links.",
"statusCodes" : {
"201" : {
"description" : "Category links replaced",
"response" : {
"types" : [{
"type" : "application/llsd+xml",
"schema" : "slcap://InventoryAPIv3/categoryLinksReplaceResponse"
}
],
"headers" : {
"Location" : {
"description" : "The URL of the replaced category links.",
"required" : true
}
}
}
},
"400" : {
"description" : "Invalid request",
"response" : {
"types" : [{
"type" : "application/llsd+xml",
"schema" : "slcap://InventoryAPIv3/errorInvalidLinksShape"
}, {
"type" : "application/llsd+xml",
"schema" : "slcap://InventoryAPIv3/errorInvalidRequest"
}
]
}
},
"404" : {
"description" : "Category not found",
"response" : {
"types" : [{
"type" : "application/llsd+xml",
"schema" : "slcap://InventoryAPIv3/errorCategoryNotFound"
}
]
}
}
},
"accepts" : [{
"type" : "application/llsd+xml",
"schema" : "slcap://InventoryAPIv3/replaceCategoryLinks"
}
]
},
"COPY" : {
"description" : "Copy category links",
"statusCodes" : {
"201" : {
"description" : "Category links copied successfully",
"response" : {
"types" : [{
"type" : "application/llsd+xml",
"schema" : "slcap://InventoryAPIv3/categoryLinksCopyResponse"
}
],
"headers" : {
"Location" : {
"description" : "The URL of the copied inventory.",
"required" : true
}
}
}
},
"403" : {
"description" : "Permissions check failed.",
"response" : {
"types" : [{
"type" : "application/llsd+xml",
"schema" : "slcap://InventoryAPIv3/errorInvalidPermissions"
}
]
}
},
"404" : {
"description" : "Destination category not found.",
"response" : {
"types" : [{
"type" : "application/llsd+xml",
"schema" : "slcap://InventoryAPIv3/errorCategoryNotFound"
}
]
}
},
"410" : {
"description" : "Source category gone",
"response" : {
"types" : [{
"type" : "application/llsd+xml",
"schema" : "slcap://InventoryAPIv3/errorCategoryGone"
}
]
}
}
},
"headers" : {
"Destination" : {
"description" : "Destination category_id or 'special' category.",
"required" : true
}
}
},
"MOVE" : {
"description" : "Move category links",
"statusCodes" : {
"200" : {
"description" : "Category links moved successfully",
"response" : {
"types" : [{
"type" : "application/llsd+xml",
"schema" : "slcap://InventoryAPIv3/categoryLinksMoveResponse"
}
],
"headers" : {
"Location" : {
"description" : "The URL of the moved inventory.",
"required" : true
}
}
}
},
"403" : {
"description" : "Permissions check failed.",
"response" : {
"types" : [{
"type" : "application/llsd+xml",
"schema" : "slcap://InventoryAPIv3/errorInvalidPermissions"
}
]
}
},
"404" : {
"description" : "Destination category not found.",
"response" : {
"types" : [{
"type" : "application/llsd+xml",
"schema" : "slcap://InventoryAPIv3/errorCategoryNotFound"
}
]
}
},
"410" : {
"description" : "Source category gone",
"response" : {
"types" : [{
"type" : "application/llsd+xml",
"schema" : "slcap://InventoryAPIv3/errorCategoryGone"
}
]
}
}
},
"headers" : {
"Destination" : {
"description" : "Destination category_id.",
"required" : true
}
}
},
"DELETE" : {
"description" : "Delete category links",
"statusCodes" : {
"200" : {
"description" : "Category links deleted successfully",
"response" : {
"types" : [{
"type" : "application/llsd+xml",
"schema" : "slcap://InventoryAPIv3/categoryLinksDeleteResponse"
}
]
}
},
"410" : {
"description" : "Category gone",
"response" : {
"types" : [{
"type" : "application/llsd+xml",
"schema" : "slcap://InventoryAPIv3/errorCategoryGone"
}
]
}
}
}
}
}
}, {
"id" : "CategoryItems",
"description" : "Items in an inventory category.",
"path" : "/category/{category}/items{?tid,simulate}",
"params" : {
"category" : {
"description" : "Category UUID or 'special' category name, e.g. \"current\".",
"validations" : [{
"type" : "match",
"pattern" : "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"
}, {
"type" : "match",
"pattern" : "^(animatn|bodypart|clothing|current|favorite|gesture|inbox|landmark|lsltext)$"
}, {
"type" : "match",
"pattern" : "^(lstndfnd|my_otfts|notecard|object|outbox|root|snapshot|sound|texture|trash)$"
}
]
},
"tid" : {
"description" : "Transaction ID."
},
"simulate" : {
"description" : "Whether or not to skip writing back results.",
"default" : 0,
"validations" : [{
"type" : "match",
"pattern" : "^(0|1|true|false)?$"
}]
}
},
"methods" : {
"GET" : {
"description" : "Retrieve items in a category",
"statusCodes" : {
"200" : {
"description" : "Category items retrieved successfully",
"response" : {
"types" : [{
"type" : "application/llsd+xml",
"schema" : "slcap://InventoryAPIv3/categoryItemsResponse"
}
],
"headers" : {
"ETag" : {
"description" : "Current value of the entity tag for the requested variant.",
"required" : true
}
}
}
},
"304" : {
"description" : "Not modified",
"response" : {
"types" : [{
"type" : "application/llsd+xml",
"schema" : "slcap://InventoryAPIv3/empty"
}],
"headers" : {
"ETag" : {
"description" : "Current value of the entity tag for the requested variant.",
"required" : true
}
}
}
},
"404" : {
"description" : "Category not found",
"response" : {
"types" : [{
"type" : "application/llsd+xml",
"schema" : "slcap://InventoryAPIv3/errorCategoryNotFound"
}
]
}
},
"412" : {
"description" : "Precondition failed",
"response" : {
"types" : [{
"type" : "application/llsd+xml",
"schema" : "slcap://InventoryAPIv3/errorPreconditionFailed"
}
],
"headers" : {
"ETag" : {
"description" : "Current value of the entity tag for the requested variant.",
"required" : true
}
}
}
}
}
},
"PUT" : {
"description" : "Replace category items.",
"statusCodes" : {
"201" : {
"description" : "Category items replaced",
"response" : {
"types" : [{
"type" : "application/llsd+xml",
"schema" : "slcap://InventoryAPIv3/categoryItemsReplaceResponse"
}
],
"headers" : {
"ETag" : {
"description" : "Current value of the entity tag for the requested variant.",
"required" : true
},
"Location" : {
"description" : "The URL of the replaced category items.",
"required" : true
}
}
}
},
"404" : {
"description" : "Category not found",
"response" : {
"types" : [{
"type" : "application/llsd+xml",
"schema" : "slcap://InventoryAPIv3/errorCategoryNotFound"
}
]
}
},
"412" : {
"description" : "Precondition failed",
"response" : {
"types" : [{
"type" : "application/llsd+xml",
"schema" : "slcap://InventoryAPIv3/errorPreconditionFailed"
}
],
"headers" : {
"ETag" : {
"description" : "Current value of the entity tag for the requested variant.",
"required" : true
}
}
}
}
},
"headers" : {
"If-Match" : {
"description" : "Only process request if any supplied entity tags matches resource."
},
"If-None-Match" : {
"description" : "Only process request if none of the supplied entity tags matches resource."
}
},
"accepts" : [{
"type" : "application/llsd+xml",
"schema" : "slcap://InventoryAPIv3/replaceCategoryItems"
}
]
},
"COPY" : {
"description" : "Copy category items",
"statusCodes" : {
"201" : {
"description" : "Category items copied successfully",
"response" : {
"types" : [{
"type" : "application/llsd+xml",
"schema" : "slcap://InventoryAPIv3/categoryItemsCopyResponse"
}
],
"headers" : {
"ETag" : {
"description" : "Current value of the entity tag for the requested variant.",
"required" : true
},
"Location" : {
"description" : "The URL of the copied inventory.",
"required" : true
}
}
}
},
"403" : {
"description" : "Permissions check failed.",
"response" : {
"types" : [{
"type" : "application/llsd+xml",
"schema" : "slcap://InventoryAPIv3/errorInvalidPermissions"
}
]
}
},
"404" : {
"description" : "Destination category not found.",
"response" : {
"types" : [{
"type" : "application/llsd+xml",
"schema" : "slcap://InventoryAPIv3/errorCategoryNotFound"
}
]
}
},
"410" : {
"description" : "Source category gone",
"response" : {
"types" : [{
"type" : "application/llsd+xml",
"schema" : "slcap://InventoryAPIv3/errorCategoryGone"
}
]
}
},
"412" : {
"description" : "Precondition failed",
"response" : {
"types" : [{
"type" : "application/llsd+xml",
"schema" : "slcap://InventoryAPIv3/errorPreconditionFailed"
}
],
"headers" : {
"ETag" : {
"description" : "Current value of the entity tag for the requested variant.",
"required" : true
}
}
}
}
},
"headers" : {
"If-Match" : {
"description" : "Only process request if any supplied entity tags matches resource."
},
"If-None-Match" : {
"description" : "Only process request if none of the supplied entity tags matches resource."
},
"Destination" : {
"description" : "Destination category_id or 'special' category.",
"required" : true
}
}
},
"MOVE" : {
"description" : "Move category items",
"statusCodes" : {
"200" : {
"description" : "Category items moved successfully",
"response" : {
"types" : [{
"type" : "application/llsd+xml",
"schema" : "slcap://InventoryAPIv3/categoryItemsMoveResponse"
}
],
"headers" : {
"ETag" : {
"description" : "Current value of the entity tag for the requested variant.",
"required" : true
},
"Location" : {
"description" : "The URL of the moved inventory.",
"required" : true
}
}
}
},
"403" : {
"description" : "Permissions check failed.",
"response" : {
"types" : [{
"type" : "application/llsd+xml",
"schema" : "slcap://InventoryAPIv3/errorInvalidPermissions"
}
]
}
},
"404" : {
"description" : "Destination category not found.",
"response" : {
"types" : [{
"type" : "application/llsd+xml",
"schema" : "slcap://InventoryAPIv3/errorCategoryNotFound"
}
]
}
},
"410" : {
"description" : "Source category gone",
"response" : {
"types" : [{
"type" : "application/llsd+xml",
"schema" : "slcap://InventoryAPIv3/errorCategoryGone"
}
]
}
},
"412" : {
"description" : "Precondition failed",
"response" : {
"types" : [{
"type" : "application/llsd+xml",
"schema" : "slcap://InventoryAPIv3/errorPreconditionFailed"
}
],
"headers" : {
"ETag" : {
"description" : "Current value of the entity tag for the requested variant.",
"required" : true
}
}
}
}
},
"headers" : {
"If-Match" : {
"description" : "Only process request if any supplied entity tags matches resource."
},
"If-None-Match" : {
"description" : "Only process request if none of the supplied entity tags matches resource."
},
"Destination" : {
"description" : "Destination category_id.",
"required" : true
}
}
},
"DELETE" : {
"description" : "Delete category items",
"statusCodes" : {
"200" : {
"description" : "Category items deleted successfully",
"response" : {
"types" : [{
"type" : "application/llsd+xml",
"schema" : "slcap://InventoryAPIv3/categoryItemsDeleteResponse"
}
]
}
},
"410" : {
"description" : "Category gone",
"response" : {
"types" : [{
"type" : "application/llsd+xml",
"schema" : "slcap://InventoryAPIv3/errorCategoryGone"
}
]
}
},
"412" : {
"description" : "Precondition failed",
"response" : {
"types" : [{
"type" : "application/llsd+xml",
"schema" : "slcap://InventoryAPIv3/errorPreconditionFailed"
}
],
"headers" : {
"ETag" : {
"description" : "Current value of the entity tag for the requested variant.",
"required" : true
}
}
}
}
},
"headers" : {
"If-Match" : {
"description" : "Only process request if any supplied entity tags matches resource."
},
"If-None-Match" : {
"description" : "Only process request if none of the supplied entity tags matches resource."
}
}
}
}
}, {
"id" : "CategoryCategories",
"description" : "Categories in an inventory category.",
"path" : "/category/{category}/categories{?tid,depth,simulate}",
"params" : {
"category" : {
"description" : "Category UUID or 'special' category name, e.g. \"current\".",
"validations" : [{
"type" : "match",
"pattern" : "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"
}, {
"type" : "match",
"pattern" : "^(animatn|bodypart|clothing|current|favorite|gesture|inbox|landmark|lsltext)$"
}, {
"type" : "match",
"pattern" : "^(lstndfnd|my_otfts|notecard|object|outbox|root|snapshot|sound|texture|trash)$"
}
]
},
"tid" : {
"description" : "Transaction ID."
},
"depth" : {
"description" : "Category child depth to retrieve.",
"default" : 0,
"validations" : [{
"type" : "match",
"pattern" : "^(\\*|[0-9]+)?$"
}]
},
"simulate" : {
"description" : "Whether or not to skip writing back results.",
"default" : 0,
"validations" : [{
"type" : "match",
"pattern" : "^(0|1|true|false)?$"
}]
}
},
"methods" : {
"GET" : {
"description" : "Retrieve categories in a category",
"statusCodes" : {
"200" : {
"description" : "Category categories retrieved successfully",
"response" : {
"types" : [{
"type" : "application/llsd+xml",
"schema" : "slcap://InventoryAPIv3/categoryCategoriesResponse"
}
],
"headers" : {
"ETag" : {
"description" : "Current value of the entity tag for the requested variant.",
"required" : true
}
}
}
},
"304" : {
"description" : "Not modified",
"response" : {
"types" : [{
"type" : "application/llsd+xml",
"schema" : "slcap://InventoryAPIv3/empty"
}],
"headers" : {
"ETag" : {
"description" : "Current value of the entity tag for the requested variant.",
"required" : true
}
}
}
},
"404" : {
"description" : "Category not found",
"response" : {
"types" : [{
"type" : "application/llsd+xml",
"schema" : "slcap://InventoryAPIv3/errorCategoryNotFound"
}
]
}
},
"412" : {
"description" : "Precondition failed",
"response" : {
"types" : [{
"type" : "application/llsd+xml",
"schema" : "slcap://InventoryAPIv3/errorPreconditionFailed"
}
],
"headers" : {
"ETag" : {
"description" : "Current value of the entity tag for the requested variant.",
"required" : true
}
}
}
}
},
"headers" : {
"If-Match" : {
"description" : "Only process request if any supplied entity tags matches resource."
},
"If-None-Match" : {
"description" : "Only process request if none of the supplied entity tags matches resource."
}
}
},
"PUT" : {
"description" : "Replace category categories.",
"statusCodes" : {
"201" : {
"description" : "Category categories replaced",
"response" : {
"types" : [{
"type" : "application/llsd+xml",
"schema" : "slcap://InventoryAPIv3/categoryChildrenReplaceResponse"
}
],
"headers" : {
"ETag" : {
"description" : "Current value of the entity tag for the requested variant.",
"required" : true
},
"Location" : {
"description" : "The URL of the replaced category categories.",
"required" : true
}
}
}
},
"404" : {
"description" : "Category not found",
"response" : {
"types" : [{
"type" : "application/llsd+xml",
"schema" : "slcap://InventoryAPIv3/errorCategoryNotFound"
}
]
}
},
"412" : {
"description" : "Precondition failed",
"response" : {
"types" : [{
"type" : "application/llsd+xml",
"schema" : "slcap://InventoryAPIv3/errorPreconditionFailed"
}
],
"headers" : {
"ETag" : {
"description" : "Current value of the entity tag for the requested variant.",
"required" : true
}
}
}
}
},
"headers" : {
"If-Match" : {
"description" : "Only process request if any supplied entity tags matches resource."
},
"If-None-Match" : {
"description" : "Only process request if none of the supplied entity tags matches resource."
}
},
"accepts" : [{
"type" : "application/llsd+xml",
"schema" : "slcap://InventoryAPIv3/replaceCategoryCategories"
}
]
},
"COPY" : {
"description" : "Copy category categories",
"statusCodes" : {
"201" : {
"description" : "Category categories copied successfully",
"response" : {
"types" : [{
"type" : "application/llsd+xml",
"schema" : "slcap://InventoryAPIv3/categoryCopyResponse"
}
],
"headers" : {
"ETag" : {
"description" : "Current value of the entity tag for the requested variant.",
"required" : true
},
"Location" : {
"description" : "The URL of the copied inventory.",
"required" : true
}
}
}
},
"403" : {
"description" : "Permissions check failed.",
"response" : {
"types" : [{
"type" : "application/llsd+xml",
"schema" : "slcap://InventoryAPIv3/errorInvalidPermissions"
}
]
}
},
"404" : {
"description" : "Destination category not found.",
"response" : {
"types" : [{
"type" : "application/llsd+xml",
"schema" : "slcap://InventoryAPIv3/errorCategoryNotFound"
}
]
}
},
"410" : {
"description" : "Source category gone",
"response" : {
"types" : [{
"type" : "application/llsd+xml",
"schema" : "slcap://InventoryAPIv3/errorCategoryGone"
}
]
}
},
"412" : {
"description" : "Precondition failed",
"response" : {
"types" : [{
"type" : "application/llsd+xml",
"schema" : "slcap://InventoryAPIv3/errorPreconditionFailed"
}
],
"headers" : {
"ETag" : {
"description" : "Current value of the entity tag for the requested variant.",
"required" : true
}
}
}
}
},
"headers" : {
"If-Match" : {
"description" : "Only process request if any supplied entity tags matches resource."
},
"If-None-Match" : {
"description" : "Only process request if none of the supplied entity tags matches resource."
},
"Destination" : {
"description" : "Destination category_id or 'special' category.",
"required" : true
}
}
},
"MOVE" : {
"description" : "Move category categories",
"statusCodes" : {
"200" : {
"description" : "Category categories moved successfully",
"response" : {
"types" : [{
"type" : "application/llsd+xml",
"schema" : "slcap://InventoryAPIv3/categoryCategoriesMoveResponse"
}
],
"headers" : {
"ETag" : {
"description" : "Current value of the entity tag for the requested variant.",
"required" : true
},
"Location" : {
"description" : "The URL of the moved inventory.",
"required" : true
}
}
}
},
"403" : {
"description" : "Permissions check failed.",
"response" : {
"types" : [{
"type" : "application/llsd+xml",
"schema" : "slcap://InventoryAPIv3/errorInvalidPermissions"
}
]
}
},
"404" : {
"description" : "Destination category not found.",
"response" : {
"types" : [{
"type" : "application/llsd+xml",
"schema" : "slcap://InventoryAPIv3/errorCategoryNotFound"
}
]
}
},
"410" : {
"description" : "Source category gone",
"response" : {
"types" : [{
"type" : "application/llsd+xml",
"schema" : "slcap://InventoryAPIv3/errorCategoryGone"
}
]
}
},
"412" : {
"description" : "Precondition failed",
"response" : {
"types" : [{
"type" : "application/llsd+xml",
"schema" : "slcap://InventoryAPIv3/errorPreconditionFailed"
}
],
"headers" : {
"ETag" : {
"description" : "Current value of the entity tag for the requested variant.",
"required" : true
}
}
}
}
},
"headers" : {
"If-Match" : {
"description" : "Only process request if any supplied entity tags matches resource."
},
"If-None-Match" : {
"description" : "Only process request if none of the supplied entity tags matches resource."
},
"Destination" : {
"description" : "Destination category_id.",
"required" : true
}
}
},
"DELETE" : {
"description" : "Delete category categories",
"statusCodes" : {
"200" : {
"description" : "Category categories deleted successfully",
"response" : {
"types" : [{
"type" : "application/llsd+xml",
"schema" : "slcap://InventoryAPIv3/categoryDeleteResponse"
}
]
}
},
"410" : {
"description" : "Category gone",
"response" : {
"types" : [{
"type" : "application/llsd+xml",
"schema" : "slcap://InventoryAPIv3/errorCategoryGone"
}
]
}
},
"412" : {
"description" : "Precondition failed",
"response" : {
"types" : [{
"type" : "application/llsd+xml",
"schema" : "slcap://InventoryAPIv3/errorPreconditionFailed"
}
],
"headers" : {
"ETag" : {
"description" : "Current value of the entity tag for the requested variant.",
"required" : true
}
}
}
}
},
"headers" : {
"If-Match" : {
"description" : "Only process request if any supplied entity tags matches resource."
},
"If-None-Match" : {
"description" : "Only process request if none of the supplied entity tags matches resource."
}
}
}
}
}, {
"id" : "Item",
"description" : "An inventory item.",
"path" : "/item/{item}{?tid,simulate}",
"params" : {
"item" : {
"description" : "Item UUID",
"validations" : [{
"type" : "match",
"pattern" : "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"
}
]
},
"tid" : {
"description" : "Transaction ID."
},
"simulate" : {
"description" : "Whether or not to skip writing back results.",
"default" : 0,
"validations" : [{
"type" : "match",
"pattern" : "^(0|1|true|false)?$"
}]
}
},
"methods" : {
"GET" : {
"description" : "Retrieve an item",
"statusCodes" : {
"200" : {
"description" : "Item retrieved successfully",
"response" : {
"types" : [{
"type" : "application/llsd+xml",
"schema" : "slcap://InventoryAPIv3/itemResponse"
}, {
"type" : "application/llsd+xml",
"schema" : "slcap://InventoryAPIv3/linkResponse"
}
]
}
},
"404" : {
"description" : "Item not found",
"response" : {
"types" : [{
"type" : "application/llsd+xml",
"schema" : "slcap://InventoryAPIv3/errorItemNotFound"
}
]
}
}
}
},
"PATCH" : {
"description" : "Modify an item",
"statusCodes" : {
"200" : {
"description" : "Item modified successfully",
"response" : {
"types" : [{
"type" : "application/llsd+xml",
"schema" : "slcap://InventoryAPIv3/itemModifyResponse"
}, {
"type" : "application/llsd+xml",
"schema" : "slcap://InventoryAPIv3/linkModifyResponse"
}
]
}
},
"400" : {
"description" : "Invalid request",
"response" : {
"types" : [{
"type" : "application/llsd+xml",
"schema" : "slcap://InventoryAPIv3/errorInvalidItemRequest"
}
]
}
},
"404" : {
"description" : "Item not found",
"response" : {
"types" : [{
"type" : "application/llsd+xml",
"schema" : "slcap://InventoryAPIv3/errorItemNotFound"
}
]
}
}
},
"accepts" : [{
"type" : "application/llsd+xml",
"schema" : "slcap://InventoryAPIv3/modifyItem"
}, {
"type" : "application/llsd+xml",
"schema" : "slcap://InventoryAPIv3/modifyLink"
}
],
"examples" : [{
"path" : "/item/b07ec4b2-b5b8-4be4-bbd5-25d23cd215d1",
"headers" : {
"Content-Type" : "application/llsd+xml"
},
"body" : "<llsd>\n <map>\n <key>name</key>\n <string>New Item Name</string>\n </map>\n</llsd>"
}
]
},
"COPY" : {
"description" : "Copy an item",
"statusCodes" : {
"201" : {
"description" : "Item copied successfully",
"response" : {
"types" : [{
"type" : "application/llsd+xml",
"schema" : "slcap://InventoryAPIv3/itemCopyResponse"
}, {
"type" : "application/llsd+xml",
"schema" : "slcap://InventoryAPIv3/linkCopyResponse"
}
],
"headers" : {
"Location" : {
"description" : "The URL of the copied inventory.",
"required" : true
}
}
}
},
"403" : {
"description" : "Permissions check failed.",
"response" : {
"types" : [{
"type" : "application/llsd+xml",
"schema" : "slcap://InventoryAPIv3/errorInvalidPermissions"
}
]
}
},
"404" : {
"description" : "Destination category not found.",
"response" : {
"types" : [{
"type" : "application/llsd+xml",
"schema" : "slcap://InventoryAPIv3/errorCategoryNotFound"
}
]
}
},
"410" : {
"description" : "Source item gone",
"response" : {
"types" : [{
"type" : "application/llsd+xml",
"schema" : "slcap://InventoryAPIv3/errorItemGone"
}
]
}
}
},
"headers" : {
"Destination" : {
"description" : "Destination category_id or 'special' category.",
"required" : true
}
}
},
"MOVE" : {
"description" : "Move an item",
"statusCodes" : {
"200" : {
"description" : "Item moved successfully",
"response" : {
"types" : [{
"type" : "application/llsd+xml",
"schema" : "slcap://InventoryAPIv3/itemMoveResponse"
}, {
"type" : "application/llsd+xml",
"schema" : "slcap://InventoryAPIv3/linkMoveResponse"
}
],
"headers" : {
"Location" : {
"description" : "The URL of the moved inventory.",
"required" : true
}
}
}
},
"403" : {
"description" : "Permissions check failed.",
"response" : {
"types" : [{
"type" : "application/llsd+xml",
"schema" : "slcap://InventoryAPIv3/errorInvalidPermissions"
}
]
}
},
"404" : {
"description" : "Destination category not found.",
"response" : {
"types" : [{
"type" : "application/llsd+xml",
"schema" : "slcap://InventoryAPIv3/errorCategoryNotFound"
}
]
}
},
"410" : {
"description" : "Source item gone",
"response" : {
"types" : [{
"type" : "application/llsd+xml",
"schema" : "slcap://InventoryAPIv3/errorItemGone"
}
]
}
}
},
"headers" : {
"Destination" : {
"description" : "Destination category_id or 'special' category.",
"required" : true
}
}
},
"DELETE" : {
"description" : "Delete an item",
"statusCodes" : {
"200" : {
"description" : "Item deleted successfully",
"response" : {
"types" : [{
"type" : "application/llsd+xml",
"schema" : "slcap://InventoryAPIv3/itemDeleteResponse"
}
]
}
},
"410" : {
"description" : "Item gone",
"response" : {
"types" : [{
"type" : "application/llsd+xml",
"schema" : "slcap://InventoryAPIv3/errorItemGone"
}
]
}
}
}
}
}
}
]
}