SignPuddle 3 Collection API


Collections

SignPuddle 3 organizes related data into collections. All collections are available in three different forms: database, plain text files, and JSON objects

Databases

Each collection is available as an SQLite database. These databases are the primary source and all edits are directly applied to the database.

Plain Text Files

Each collection is available as a plain text field where each entry occupies its own line. Each entry contains multiple fields that are divided by tab characters. The plain text files are designed for easy import and export from the databases.

JSON Data files

Each collection is available as a JSON data file. These files are useful for the client section for default configuration.

Collection Types

There are six types of collections: interface, dictionary, literature, alphabet, fingerspell, and keyboard.

Interface

The interface collection deals with user interface elements.

Dictionary

The dictionary collection deals with individual sign details.

Literature

The literature collection deals with segments of sign text.

Alphabet

The alphabet collection deals with subset of ISWA 2010.

Fingerspell

The fingerspell collection deals with individual letters for fingerspelling.

Keyboard

The keyboard collection deals with commands and keys for keyboarding.

collection

Resources related to collections in general

Collections available

Get available collections

REQUEST

Parameters
name string sp3

partial collection name

RESPONSE

Headers
Content-Type text/plain
200 text/plain
                        ["en-US-interface-sp3"]

                      
                        
                      
Collection resource

Specific collection

delete collection

REQUEST the removal of a collection

Parameters
name string en-US-interface-sp3

The name of a collection

Headers
Pass 5ffab638bde372b4fa63bb6f8484595d
                          null

                        
                          
                        

RESPONSE

Headers
Collection entry image resource

Specific image for collection entry

update image for collection entry

REQUEST an update for an existing dictionary entry

Parameters
name string ase-US-dictionary-public

The name of an dictionary

ik string 11244

An id number or key string

num string 1

The image number of 1 thru 4

Headers
Content-Type application/json
Pass 724fd4b4438fba9d0c5ab89d0833e5c9
application/json
                          {
  "file": "name.png",
  "data": "data:image/jpeg;base64,/9j/4AAQSkZJRgABAQEASABIAAD..."
}

                        
                          
                        

RESPONSE

Headers

remove dictionary entry

REQUEST the removal of a collection entry image

Parameters
name string ase-US-dictionary-public

The name of an dictionary

ik string 11244

An id number or key string

num string 1

The image number of 1 thru 4

Headers
Pass 724fd4b4438fba9d0c5ab89d0833e5c9
                          null

                        
                          
                        

RESPONSE

Headers
Collection statistics

Statistics about the collection

Get collection statistics

REQUEST collections statistics

Parameters
name string ase-US-dictionary-public

The name of a dictionary

Headers
If-Modified-Since 2019-01-16T16:56:19.175Z
                          null

                        
                          
                        

RESPONSE

Headers
Content-Type text/plain
200 text/plain
                        [{"name": "en-US-interface-sp3","code": "ui1","title": "English Interface for SignPuddle 3","user": "slevinski","created_at": "","view_pass": 0,"add_pass": 1,"edit_pass": 1,"register_level": 0,"upload_level": 4}]

                      
                        
                      
Collections security

Security settings for all collections

Get collections security

REQUEST collections security

Headers
If-Modified-Since 2019-01-16T16:56:19.175Z
                          null

                        
                          
                        

RESPONSE

Headers
Content-Type text/plain
200 text/plain
                        [{"name": "en-US-interface-sp3","code": "ui1","title": "English Interface for SignPuddle 3","user": "slevinski","created_at": "","view_pass": 0,"add_pass": 1,"edit_pass": 1,"register_level": 0,"upload_level": 4}]

                      
                        
                      
Collection security

Details about the collection security

retrieve collection security

REQUEST interface security

Parameters
name string en-US-interface-sp3

The name of the collection

                          null

                        
                          
                        

RESPONSE

Headers
Content-Type text/plain
200 text/plain
                        {"name": "en-US-interface-sp3","code": "ui1","title": "English Interface for SignPuddle 3","user": "slevinski","created_at": "","view_pass": 0,"add_pass": 1,"edit_pass": 1,"register_level": 0,"upload_level": 4}

                      
                        
                      

Update collection security

REQUEST an update for an existing entry

Parameters
name string en-US-interface-sp3

The name of the collection

Headers
Content-Type text/plain
Pass 5ffab638bde372b4fa63bb6f8484595d
text/plain
                          {"name": "en-US-interface-sp3","code": "ui1","title": "English Interface for SignPuddle 3","user": "slevinski","created_at": "","view_pass": 0,"add_pass": 1,"edit_pass": 1,"register_level": 0,"upload_level": 4}

                        
                          
                        

RESPONSE

Headers

Remove security for collection

REQUEST the deletion of collection security

Parameters
name string en-US-interface-sp3

The name of the collection

Headers
Pass 5ffab638bde372b4fa63bb6f8484595d
                          null

                        
                          
                        

RESPONSE

Headers
Collection users

Get collection users

REQUEST

Parameters
name string ase-US-dictionary-public

collection name

RESPONSE

Headers
Content-Type text/plain
200 text/plain
                        [{"user": "test_user","security": 3}]

                      
                        
                      
Management for unknown collections

Get list of unknown collections with user management

REQUEST

RESPONSE

Headers
Content-Type text/plain
200 text/plain
                        ["es-US-interface-sp3"]

                      
                        
                      
Collection users management

Get collection management

REQUEST collection management

Parameters
name string ase-US-dictionary-public

collection name

Headers
Pass 5ffab638bde372b4fa63bb6f8484595d
                          null

                        
                          
                        

RESPONSE

Headers
Content-Type text/plain
200 text/plain
                        [{"name": "test_user","display": "Test Editor","email": "testing@gmail.com","security": 3}]

                      
                        
                      

Update collection management

REQUEST an update for collection management

Parameters
name string ase-US-dictionary-public

collection name

Headers
Pass 5ffab638bde372b4fa63bb6f8484595d
                          {"user":"slevinski","security":4}

                        
                          
                        

RESPONSE

Headers

Remove user management for collection

REQUEST the removal of user management for a collection

Parameters
name string ase-US-dictionary-public

collection name

Headers
Pass 5ffab638bde372b4fa63bb6f8484595d
                          null

                        
                          
                        

RESPONSE

Headers
Collection user

Remove user from collection management

REQUEST the removal of a user from collection management

Parameters
name string ase-US-dictionary-public

collection name

user string slevinski

user name

Headers
Pass 5ffab638bde372b4fa63bb6f8484595d
                          null

                        
                          
                        

RESPONSE

Headers
Collection Request Copy

request the creation of a new collection

REQUEST new collection from source

Parameters
name string es-US-interface-sp3

The name of the new collection

source string en-US-interface-sp3

The name of the source collection

Headers
Pass 5ffab638bde372b4fa63bb6f8484595d
                          null

                        
                          
                        

RESPONSE

Headers