Skip to content
Bert Spaan edited this page Feb 24, 2015 · 3 revisions

URI structure: Owners

The following request are allowed on the /owners endpoint. The data column specifies the object expected in the request's body data. All PUT, POST, PATCH and DELETE operations require authentication.

URI Data Description
GET /owners Return all owners
POST /owners Owner Create new owner
GET /owners/:owner Get a single owner
PATCH /owners/:owner Owner Edit an owner
DELETE /owners/:owner Delete owner - and all layers and data belonging to this owner
GET /owners/:owner/layers Return all layers belonging to a single owner

Data

Owner

Field Optional Type Description
name String Owner's username - must be alphanumeric
email String E-mail address
fullname String Full name
organization String Organization
website String Website
domains Array of strings Layer domains on which owner can create new layers - ["test"] means the owner can only create layers starting with test.
password String Password
admin Yes Boolean Only admins can create layers and owners - default is false

Example:

{
  "name": "bert",
  "email": "[email protected]",
  "website": "http://bertspaan.nl/",
  "fullname": "Bert Spaan",
  "domains": ["bert", "test"],
  "organization": "Waag Society",
  "password": "abcABC123",
  "admin": true
}
Clone this wiki locally