Skip to content

API

Jump to bottom
jimsafley edited this page Apr 14, 2013 · 78 revisions

This documentation is a work in progress and subject to change. Assume that resources (records) must be accessible to the consumer, public or via authentication.

URL

yourdomain.com/api[/:version]

Requests

Generic Requests

Return data about records:

GET /:record-types

Parameters

  • page: integer
  • per_page: integer

Return data about the specified record:

GET /:record-types/:id

Record Types

Return available records (must be registered) and HTTP methods for each record (GET, POST, PUT, DELETE):

GET /record-types

Response

[
  {
    "name": "collections",
    "methods": ["GET", "POST", "PUT", "DELETE"]
  },
  {
    "name": "items",
    "methods": ["GET", "POST", "PUT", "DELETE"]
  },
  {
    "name": "files",
    "methods": ["GET", "POST", "PUT", "DELETE"]
  },
  {
    "name": "item-types",
    "methods": ["GET", "POST", "PUT", "DELETE"]
  }
]

Collections

Return data about collections:

GET /collections

Parameters

  • public: boolean
  • featured: boolean
  • added_since: string (timestamp)
  • modified_since: string (timestamp)
  • owner (user): integer

Return data about the specified collection:

GET /collections/:id

Response

[
  {
    "id": "1",
    "public": true,
    "featured": false,
    "added": "2013-02-13 11:24:34",
    "modified": "2013-02-18 11:09:50", 
    "owner_id": 1
  }
]

Items

Return data about items:

GET /items

Parameters

  • collection: integer
  • item_type: integer
  • featured: boolean
  • public: boolean
  • added_since: string (timestamp)
  • modified_since: string (timestamp)
  • owner (user): integer

Return data about the specified item:

GET /items/:id

Files

Return data about files:

GET /files

Parameters

  • item: integer
  • order: integer
  • size_greater_than: integer
  • has_derivative_image: boolean
  • mime_type: string
  • added_since: string (timestamp)
  • modified_since: string (timestamp)

Return data about the specified item:

GET /files/:id

Item Types

GET /item-types

GET /item-types/:id

Element Sets

GET /element-sets

GET /element-sets/:id

Elements

GET /elements

GET /elements/:id

Users

GET /users

GET /users/:id

Tags

GET /tags

Plugins

GET /plugins

GET /plugins/:name

Clone this wiki locally