SignPuddle 3 Dictionary API


Dictionary

SignPuddle 3 organizes user dictionary elements into dictionary collections. Dictionary 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.

table entry

  • id

  • sign

  • terms

  • lower

  • signtext

  • text

  • source

  • detail

  • user

  • created_at

  • updated_at

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.

id /t sign /t terms /t lower /t signtext /t text /t source /t detail /t user /t updated_at

JSON Data files

The dictionary JSON data file is an object. Each key contains an object with three properties: message, description, icon, and updated_at.

{
“name”: “xml-MY-dictionary-public”,
“data”: [
{
“id”: “2”,
“sign”: “\ud836\udc03\ud836\udd44\ud836\udd19\ud8ef\udfa1\ud836\udcf4\ud836\udcf4\ud8dd\udc54\ud836\udcc8\ud836\udcfc\ud8dd\udc42\ud836\udd26\ud836\udcfa\ud8c8\uddd2\ud836\udd15\ud836\udcee\ud8c8\uddda\ud836\udce0\ud836\udcef”,
“terms”: [
“Malaysia”
],
“lower”: [
“malaysia”
],
“signtext”: “”,
“text”: “”,
“source”: “Conference Maastricht”,
“detail”: ,
“user”: “admin”,
“created_at”: “2007-03-29T19:09:37Z”,
“updated_at”: “2007-03-29T19:09:37Z”
}
]
}

dictionary

Resources related to dictionary collections

Dictionaries available

Get available dictionaries

REQUEST

Parameters
name string public

partial dictionary name

RESPONSE

Headers
Content-Type text/plain
200 text/plain
                        ["ase-US-dictionary-public"]

                      
                        
                      
Dictionary resource

Access to available dictionaries

retrieve dictionary

REQUEST dictionary text

Parameters
name string ase-US-dictionary-public

The name of an dictionary

update number 1

Forces a rewrite of the dictionary for json and txt formats

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

                        
                          
                        

RESPONSE

Headers
Content-Type text/plain
200 text/plain
                        1   𝠀񂱡񂇙񆿃𝠃𝤝𝤔񂇙𝣰𝣹񆿃𝤎𝤁񂱡𝣽𝤀   test zero   test zero   we are testing SignPuddle 1.6   Val ;-)   {"video":"<iframe width=\"425\" height=\"349\" src=\"http:\/\/www.youtube.com\/embed\/RTniYA1lTDM\" frameborder=\"0\" allowfullscreen><\/iframe>"}   Val   2011-07-20T17:39:02Z   2011-07-20T17:42:09Z

                      
                        
                      
List of dictionary signs

The signs in the dictionary

retrieve dictionary signs

REQUEST dictionary text

Parameters
name string ase-US-dictionary-public

The name of an dictionary

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

                        
                          
                        

RESPONSE

Headers
Content-Type text/plain
200 text/plain
                        𝠀񂱡񂇙񆿃𝠃𝤝𝤔񂇙𝣰𝣹񆿃𝤎𝤁񂱡𝣽𝤀

                      
                        
                      
List of dictionary signtexts

The signtexts in the dictionary

retrieve dictionary signtexts

REQUEST dictionary text

Parameters
name string ase-US-dictionary-public

The name of an dictionary

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

                        
                          
                        

RESPONSE

Headers
Content-Type text/plain
200 text/plain
                        𝠀񂱡񂇙񆿃𝠃𝤝𝤔񂇙𝣰𝣹񆿃𝤎𝤁񂱡𝣽𝤀

                      
                        
                      
Dictionary entry resource

Entries for dictionary

add dictionary entry

REQUEST add new dictionary entry

Parameters
name string ase-US-dictionary-public

The name of an dictionary

Headers
Content-Type application/json
Pass 724fd4b4438fba9d0c5ab89d0833e5c9
application/json
                          {
  "sign": "\ud836\udc03\ud836\udd44\ud836\udd19\ud8ef\udfa1\ud836\udcf4\ud836\udcf4\ud8dd\udc54\ud836\udcc8\ud836\udcfc\ud8dd\udc42\ud836\udd26\ud836\udcfa\ud8c8\uddd2\ud836\udd15\ud836\udcee\ud8c8\uddda\ud836\udce0\ud836\udcef",
  "terms": [
    "Malaysia"
  ],
  "signtext": "",
  "text": "",
  "source": "Conference Maastricht",
  "detail": {}
}  

                        
                          
                        

RESPONSE

Headers
Content-Type text/plain
201 text/plain
                        777

                      
                        
                      
Dictionary entry resource for id

Specific entries for dictionary

update dictionary entry

REQUEST an update for an existing dictionary entry

Parameters
name string ase-US-dictionary-public

The name of an dictionary

id string 11244

An id numbers

Headers
Content-Type application/json
Pass 724fd4b4438fba9d0c5ab89d0833e5c9
application/json
                          {
  "sign": "\ud836\udc03\ud836\udd44\ud836\udd19\ud8ef\udfa1\ud836\udcf4\ud836\udcf4\ud8dd\udc54\ud836\udcc8\ud836\udcfc\ud8dd\udc42\ud836\udd26\ud836\udcfa\ud8c8\uddd2\ud836\udd15\ud836\udcee\ud8c8\uddda\ud836\udce0\ud836\udcef",
  "terms": [
    "Malaysia"
  ],
  "signtext": "",
  "text": "",
  "source": "Conference Maastricht",
  "detail": {}
}  

                        
                          
                        

RESPONSE

Headers

remove dictionary entry

REQUEST the removal of an dictionary entry

Parameters
name string ase-US-dictionary-public

The name of an dictionary

id string 11244

An id numbers

Headers
Pass 724fd4b4438fba9d0c5ab89d0833e5c9
                          null

                        
                          
                        

RESPONSE

Headers
Search dictionary

Searching dictionary signs

retrieve dictionary results of searching

REQUEST dictionary query results

Parameters
name string ase-US-dictionary-public

The name of a dictionary

offset number 0

Start of search results

limit number 10

Number of search results

filter string user=Val

restrict search results

sort string created_at

Field for sorting results

results string sign

Type of results: entries, sign, term, terms

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

                        
                          
                        

RESPONSE

Headers
Content-Type text/plain
200 text/plain
                        {
  "total": 1,
  "data": [
    [
      "1",
      "\ud836\udc00\ud8cb\udc61\ud8c8\uddd9\ud8db\udfc3\ud836\udc03\ud836\udd1d\ud836\udd14\ud8c8\uddd9\ud836\udcf0\ud836\udcf9\ud8db\udfc3\ud836\udd0e\ud836\udd01\ud8cb\udc61\ud836\udcfd\ud836\udd00"
    ]
  ]
}

                      
                        
                      
Search dictionary with ids

Specific entries for dictionary

retrieve dictionary entry

REQUEST an dictionary entry

Parameters
name string ase-US-dictionary-public

The name of an dictionary

id 1

4,5 (string) - A list of one or more id numbers

offset number 0

Start of search results

limit number 10

Number of search results

filter string user=Val

restrict search results

sort string created_at

Field for sorting results

results string sign

Type of results: entries, sign, term, terms

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

                        
                          
                        

RESPONSE

Headers
Content-Type text/plain
200 text/plain
                        [
  {
    "id": "1",
    "sign": "\ud836\udc00\ud8cb\udc61\ud8c8\uddd9\ud8db\udfc3\ud836\udc03\ud836\udd1d\ud836\udd14\ud8c8\uddd9\ud836\udcf0\ud836\udcf9\ud8db\udfc3\ud836\udd0e\ud836\udd01\ud8cb\udc61\ud836\udcfd\ud836\udd00",
    "terms": [
      "test zero"
    ],
    "lower": [
      "test zero"
    ],
    "signtext": "",
    "text": "we are testing SignPuddle 1.6",
    "source": "Val ;-)",
    "detail": {
      "video": "<iframe width=\"425\" height=\"349\" src=\"http:\/\/www.youtube.com\/embed\/RTniYA1lTDM\" frameborder=\"0\" allowfullscreen><\/iframe>"
    },
    "user": "Val",
    "created_at": "2011-07-20T17:39:02Z",
    "updated_at": "2011-07-20T17:42:09Z"
  }
]

                      
                        
                      
Search signs with query string

Query string access to dictionary signs

retrieve dictionary results of searching signs with query string

REQUEST dictionary query results

Parameters
name string ase-US-dictionary-public

The name of a dictionary

query string Q

A query string

offset number 0

Start of search results

limit number 10

Number of search results

filter string user=Val

restrict search results

sort string created_at

Field for sorting results

results string sign

Type of results: entries, sign, term, terms

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

                        
                          
                        

RESPONSE

Headers
Content-Type text/plain
200 text/plain
                        {
  "total": 1,
  "data": [
    [
      "1",
      "\ud836\udc00\ud8cb\udc61\ud8c8\uddd9\ud8db\udfc3\ud836\udc03\ud836\udd1d\ud836\udd14\ud8c8\uddd9\ud836\udcf0\ud836\udcf9\ud8db\udfc3\ud836\udd0e\ud836\udd01\ud8cb\udc61\ud836\udcfd\ud836\udd00"
    ]
  ]
}

                      
                        
                      
Search signtexts with query string

Query string access to dictionary signtexts

retrieve dictionary results of searching signtexts with query string

REQUEST dictionary query results

Parameters
name string ase-US-dictionary-public

The name of a dictionary

query string Q

A query string

offset number 0

Start of search results

limit number 10

Number of search results

filter string user=Val

restrict search results

sort string created_at

Field for sorting results

results string sign

Type of results: entries, signtext, term, terms

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

                        
                          
                        

RESPONSE

Headers
Content-Type text/plain
200 text/plain
                        {
  "total": 1,
  "data": [
    [
      "1",
      "\ud836\udc00\ud8cb\udc61\ud8c8\uddd9\ud8db\udfc3\ud836\udc03\ud836\udd1d\ud836\udd14\ud8c8\uddd9\ud836\udcf0\ud836\udcf9\ud8db\udfc3\ud836\udd0e\ud836\udd01\ud8cb\udc61\ud836\udcfd\ud836\udd00"
    ]
  ]
}

                      
                        
                      
Dictionary terms search

Search dictionary terms for text

retrieve matching entries

REQUEST matching dictionary entries

Parameters
name string ase-US-dictionary-public

The name of an dictionary

text string SignPuddle

The text for searching

type string exact

Type of search of start, end, or exact

case number 0

Case sensitive search

offset number 0

Start of search results

limit number 10

Number of search results

filter string user=Val

restrict search results

sort string created_at

Field for sorting results

results string sign

Type of results: entries, sign, term, terms

Headers
Pass 724fd4b4438fba9d0c5ab89d0833e5c9
                          null

                        
                          
                        

RESPONSE

Headers
Content-Type text/plain
200 text/plain
                        {
  "total": 1,
  "data": [
    [
      "1",
      "\ud836\udc00\ud8cb\udc61\ud8c8\uddd9\ud8db\udfc3\ud836\udc03\ud836\udd1d\ud836\udd14\ud8c8\uddd9\ud836\udcf0\ud836\udcf9\ud8db\udfc3\ud836\udd0e\ud836\udd01\ud8cb\udc61\ud836\udcfd\ud836\udd00"
    ]
  ]
}

                      
                        
                      
Dictionary symbol subset

Create alphabet from dictionary signs

generate alphabet from dictionary contents

REQUEST dictionary query results

Parameters
name string ase-US-dictionary-public

The name of an dictionary

update number 1

Forces a rewrite of the alphabet

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

                        
                          
                        

RESPONSE

Headers
Content-Type text/plain
200 text/plain
                        {"name": "ase-US-alphabet-public","data": []}