SignPuddle 3 organizes related data into collections. All collections are available in three different forms: database, plain text files, and JSON objects
Each collection is available as an SQLite database. These databases are the primary source and all edits are directly applied to the database.
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.
Each collection is available as a JSON data file. These files are useful for the client section for default configuration.
There are six types of collections: interface, dictionary, literature, alphabet, fingerspell, and keyboard.
The interface collection deals with user interface elements.
The dictionary collection deals with individual sign details.
The literature collection deals with segments of sign text.
The alphabet collection deals with subset of ISWA 2010.
The fingerspell collection deals with individual letters for fingerspelling.
The keyboard collection deals with commands and keys for keyboarding.
Resources related to collections in general
Source: ApiTxt format and JSON objects
Documents: API Blueprint and Stand Alone HTML
Live Page: API Interface and JavaScript
| Parameters | |||
|---|---|---|---|
name |
string
sp3
|
partial collection name |
|
| Headers | |
|---|---|
| Content-Type | text/plain |
text/plain
["en-US-interface-sp3"]
Specific collection
| Parameters | |||
|---|---|---|---|
name |
string
en-US-interface-sp3
|
The name of a collection |
|
| Headers | |
|---|---|
| Pass | 5ffab638bde372b4fa63bb6f8484595d |
null
| Headers |
|---|
Specific image for collection 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..."
}
| Headers |
|---|
| 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
| Headers |
|---|
Statistics about the collection
| Parameters | |||
|---|---|---|---|
name |
string
ase-US-dictionary-public
|
The name of a dictionary |
|
| Headers | |
|---|---|
| If-Modified-Since | 2019-01-16T16:56:19.175Z |
null
| Headers | |
|---|---|
| Content-Type | text/plain |
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}]
Security settings for all collections
| Headers | |
|---|---|
| If-Modified-Since | 2019-01-16T16:56:19.175Z |
null
| Headers | |
|---|---|
| Content-Type | text/plain |
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}]
Details about the collection security
| Parameters | |||
|---|---|---|---|
name |
string
en-US-interface-sp3
|
The name of the collection |
|
null
| Headers | |
|---|---|
| Content-Type | text/plain |
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}
| 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}
| Headers |
|---|
| Parameters | |||
|---|---|---|---|
name |
string
en-US-interface-sp3
|
The name of the collection |
|
| Headers | |
|---|---|
| Pass | 5ffab638bde372b4fa63bb6f8484595d |
null
| Headers |
|---|
| Parameters | |||
|---|---|---|---|
name |
string
ase-US-dictionary-public
|
collection name |
|
| Headers | |
|---|---|
| Content-Type | text/plain |
text/plain
[{"user": "test_user","security": 3}]
| Headers | |
|---|---|
| Content-Type | text/plain |
text/plain
["es-US-interface-sp3"]
| Parameters | |||
|---|---|---|---|
name |
string
ase-US-dictionary-public
|
collection name |
|
| Headers | |
|---|---|
| Pass | 5ffab638bde372b4fa63bb6f8484595d |
null
| Headers | |
|---|---|
| Content-Type | text/plain |
text/plain
[{"name": "test_user","display": "Test Editor","email": "testing@gmail.com","security": 3}]
| Parameters | |||
|---|---|---|---|
name |
string
ase-US-dictionary-public
|
collection name |
|
| Headers | |
|---|---|
| Pass | 5ffab638bde372b4fa63bb6f8484595d |
{"user":"slevinski","security":4}
| Headers |
|---|
| Parameters | |||
|---|---|---|---|
name |
string
ase-US-dictionary-public
|
collection name |
|
| Headers | |
|---|---|
| Pass | 5ffab638bde372b4fa63bb6f8484595d |
null
| Headers |
|---|
| Parameters | |||
|---|---|---|---|
name |
string
ase-US-dictionary-public
|
collection name |
|
user |
string
slevinski
|
user name |
|
| Headers | |
|---|---|
| Pass | 5ffab638bde372b4fa63bb6f8484595d |
null
| Headers |
|---|
| 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
| Headers |
|---|