Skip to content

Latest commit

 

History

History
251 lines (242 loc) · 6.53 KB

categories.md

File metadata and controls

251 lines (242 loc) · 6.53 KB
Raw

Categories API

Categories are actually called "collections"...

Available methods

  • GET /collections.ws lists collection types.
  • GET /collections/[type-id].ws lists collections of the given type.
  • GET /collections/[type-id]/[collection-id].ws fetches the collection with the given ID.
  • POST /collections/[type-id].ws creates a collection of the given type.
  • PUT /collections/[type-id]/[collection-id].ws updates the collection with the given ID.
  • DELETE /collections/[type-id]/[collection-id].ws deletes the collection with the given ID.
  • GET /collections/items/[collection-id].ws fetch the list of items within the given collection.
  • PUT /collections/items/[collection-id].ws update the list of items within the given collection.
  • GET /templates/collection/[type-id].ws fetch a blank template for a collection of the given type.

Details

List collection types

GET /collections.ws

{
   "types":[
      {
         "id":1,
         "name":"Images",
         "nameSingular":"image",
         "itemTypeClassId":1
      },
      {
         "id":2,
         "name":"Categories",
         "nameSingular":"category",
         "itemTypeClassId":2
      }
   ]
}

List collections

GET /collections/2.ws

{
   "listing":{
      "totalItems":3,
      "start":0,
      "limit":30,
      "currentMax":3,
      "totalPages":1,
      "currentPage":1,
      "items":[
         {
            "resource":{
               "resourceId":22,
               "identifier":"our-products",
               "resourceTypeId":4,
               "resourceTypeName":"Categories",
               "languageId":1,
               "languageActive":true,
               "name":"Our Products",
               "created":"1970-01-01T01:00:01+01:00",
               "structural":true
            },
            "metaInfo":{
               "title":"",
               "description":""
            },
            "revision":{
               "revisionId":14,
               "created":"2012-06-18T14:40:36+01:00",
               "comment":null,
               "author":{
                  "id":16,
                  "name":"a-user",
                  "gravatarUrl":"http://www.gravatar.com/avatar/947f2d5d2e15fb8d6da7a40521b36e05"
               }
            },
            "parentId":-1
         },
         {
            "resource":{
               "resourceId":21,
               "identifier":"construction",
               "resourceTypeId":4,
               "resourceTypeName":"Categories",
               "languageId":1,
               "languageActive":true,
               "name":"Construction",
               "created":"1970-01-01T01:00:01+01:00",
               "structural":true
            },
            "metaInfo":{
               "title":"Industrial",
               "description":""
            },
            "revision":{
               "revisionId":8,
               "created":"2012-06-26T12:05:47+01:00",
               "comment":null,
               "author":{
                  "id":15,
                  "name":"a-user",
                  "gravatarUrl":"http://www.gravatar.com/avatar/947f2d5d2e15fb8d6da7a40521b36e05"
               }
            },
            "parentId":22
         },
         {
            "resource":{
               "resourceId":20,
               "identifier":"agricultural",
               "resourceTypeId":4,
               "resourceTypeName":"Categories",
               "languageId":1,
               "languageActive":true,
               "name":"Agricultural",
               "created":"1970-01-01T01:00:01+01:00",
               "structural":true
            },
            "metaInfo":{
               "title":"",
               "description":""
            },
            "revision":{
               "revisionId":18,
               "created":"2012-08-28T12:10:05+01:00",
               "comment":null,
               "author":{
                  "id":18,
                  "name":"a-user",
                  "gravatarUrl":"http://www.gravatar.com/avatar/947f2d5d2e15fb8d6da7a40521b36e05"
               }
            },
            "parentId":22
         }
      ]
   }
}

Fetch an individual collection

GET /collections/4/20.ws

{
   "item":{
      "resource":{
         "resourceId":20,
         "identifier":"agricultural",
         "resourceTypeId":4,
         "resourceTypeName":"Categories",
         "languageId":1,
         "languageActive":true,
         "name":"Agricultural",
         "created":"1970-01-01T01:00:01+01:00",
         "structural":true
      },
      "metaInfo":{
         "title":"Category title",
         "description":"Category description"
      },
      "revision":{
         "revisionId":18,
         "created":"2012-08-28T12:10:05+01:00",
         "comment":null,
         "author":{
            "id":18,
            "name":"a-user",
            "gravatarUrl":"http://www.gravatar.com/avatar/947f2d5d2e15fb8d6da7a40521b36e05"
         }
      },
      "properties":{
         "Name":{
            "id":1,
            "dataType":"string",
            "value":"Agricultural"
         },
         "Tooltip_text":{
            "id":2,
            "dataType":"string",
            "value":null
         }
      },
      "assets":{
         "Category_Image":[
            {
               "altText":"Agricultural",
               "url":"",
               "item":{
                  "resourceId":5399,
                  "identifier":"agriculturecategory",
                  "resourceTypeId":3,
                  "resourceTypeName":"Images",
                  "languageId":1,
                  "languageActive":true,
                  "name":"agriculturecategory",
                  "created":"2012-06-26T12:06:21+01:00",
                  "fileExtension":"jpg",
                  "fileSize":0,
                  "iconUrl":"/labeled/images/icons/fileTypes/jpg.png",
                  "urlPath":false,
                  "commentCount":0,
                  "isImage":true
               },
               "properties":{
                  "Search_tags":{
                     "id":2,
                     "dataType":"string",
                     "value":null
                  }
               }
            }
         ]
      },
      "parentId":22
   }
}

List items within a collection

GET /collections/items/20.ws

This will return a list of IDs for items within the collection.

{
   "items":[
      85,
      1793
   ]
}

Update the list of items within a collection

PUT /collections/items/20.ws

{
   "items":[
      85,
      1793
   ]
}

You'll receive a 200 OK if the update was a success.