SignPuddle 3 API

Introduction

user

Who uses SignWriting?

User pass

User login

User profile

User password

User email requests

Username lookup

collection

Collections available

Collection resource

Collection entry image resource

Collection statistics

Collections security

Collection security

Collection users

Management for unknown collections

Collection users management

Collection user

Collection Request Copy

interface

Interfaces available

Interface resource

Interface keys

Interface entries search

Interface entry resource

Interface entry resource for key

dictionary

Dictionaries available

Dictionary resource

List of dictionary signs

List of dictionary signtexts

Dictionary entry resource

Dictionary entry resource for id

Search dictionary

Search dictionary with ids

Search signs with query string

Search signtexts with query string

Dictionary terms search

Dictionary symbol subset

tools

tools index

Character definition tree

Section definition

Part definition

Parse text

Encode text

Decode text

UTF-8 encode text

Test with input

FSW

FSW Word

FSW Text

FSW to SWU

SVG image

SVG with font

swu

SWU Word

SWU Text

SWU to FSW

SVG image

SVG with font

apitxt

root

group

route

parameter

method

request

response

header

body

line

code

v3.0.0

Welcome to the SignPuddle 3 API. The API is defined with two types of source, two types of documentation, and a live page of HTML and JavaScript.

Source: ApiTxt format and JSON objects
Documents: API Blueprint and Stand Alone HTML
Live Page: API Interface and JavaScript

The API is divided into several sections. This main document includes all of the sections. Each section is available separately as well.

HTTP Request Methods

The SignPuddle 3 server accepts HTTP request methods of GET, POST, PUT, and DELETE.

GET - retrieve information without altering the server
POST - add information to the server with each request
PUT - update information on the server
DELETE - remove information on the server.

HTTP Response Statuses

The SignPuddle 3 server responds with status codes.

Success Codes

200 OK
201 Created
202 Accepted
204 No Content

Redirect Codes

300 Multiple Choices
304 No Modified
307 Temporary Redirect
308 Permanent Redirect

Client Error Codes

400 Bad Request
403 Forbidden
404 Not Found
409 Conflict
429 Too Many Requests

Server Error Codes

500 Internal Server Error
501 Not Implemented
503 Service Unavailable

HTTP Headers

Headers pass additional information about the request or response.

Headers

Content-Type - the MIME type of the response
ETag - an entity tag used to validate cached values
Expires - date after which response is stale
Location - used for redirect or for newly created resource
If-None-Match - request header compared to ETag value, response status 304 if matching
If-Modified-Since - request header, causes response status 304 if unmodified
Last-Modified - response header, used with If-Modified-Since request header

user

Who uses SignWriting?

The available countries where signs are available.

REQUEST user-who

GET

https://signpuddle.com/server/user/who

                          null

RESPONSE

Headers
Content-Type	`text/plain`

200 text/plain

                        BR
US

User pass

REQUEST user pass

POST

https://signpuddle.com/server/user/pass

                          null

RESPONSE

Headers
Content-Type	`text/plain`

200 text/plain

                        {"pass": "90c19ce2076db097c75b3406e966a6b6","ip": "192.168.254.2"}

REQUEST user pass verify

PUT

https://signpuddle.com/server/user/pass

                          {"username":"anonymous","pass":"af77..."}

RESPONSE

Headers

204

User login

REQUEST verify user

PUT

https://signpuddle.com/server/user/login

Headers
Content-Type	`application/json`

application/json

                          {"username":"anonymous","pass":"af77...","validated":"2793f..."}

                          {
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "username": {
      "type": "string",
      "description": "name of the user"
    },
    "pass": {
      "type": "string",
      "description": "pass for session validation"
    },
    "validated": {
      "type": "string",
      "description": "validated pass mixed with password"
    }
  }
}

RESPONSE

response text here

Headers
Content-Type	`application/json`

200 application/json

                        {"user-profile":""}

User profile

Updates the profile of the user

REQUEST user-update

PUT

https://signpuddle.com/server/user/{name}

Parameters
	`name`	`string` `slevinski`	The name of a user

Headers
Pass	`5ffab638bde372b4fa63bb6f8484595d`

                          null

RESPONSE

Headers

204

Creates and returns a new user

REQUEST user-add

POST

https://signpuddle.com/server/user/{name}

Parameters
	`name`	`string` `slevinski`	The name of a user

Headers
Pass	`5ffab638bde372b4fa63bb6f8484595d`

                          null

RESPONSE

Headers
Content-Type	`text/plain`

200 text/plain

                        profile created and returned

User password

Updates the password of the user

REQUEST user-update-password

POST

https://signpuddle.com/server/user/{name}/password

Parameters
	`name`	`string` `slevinski`	The name of a user

Headers
Content-Type	`plain/text`
Pass	`5ffab638bde372b4fa63bb6f8484595d`

plain/text

                          {"old":"149603e6c03516362a8da23f624db945","new":"22af645d1859cb5ca6da0c484f1f37ea"}

RESPONSE

Headers

204

Creates a temporary password for the user

REQUEST user-password-reset

PUT

https://signpuddle.com/server/user/{name}/password

Parameters
	`name`	`string` `slevinski`	The name of a user

Headers
Content-Type	`plain/text`
Pass	`5ffab638bde372b4fa63bb6f8484595d`

plain/text

                          null

RESPONSE

Headers

204

User email requests

User email requests for username or passwords

REQUEST user-email-request

GET

https://signpuddle.com/server/user/email

Headers
Pass	`5ffab638bde372b4fa63bb6f8484595d`

                          null

RESPONSE

Headers
Content-Type	`text/plain`

200 text/plain

                        [{"name":"slevinski","email":"slevinski@signwriting.org","temp":"username"}]

Username lookup

Creates a request for email of username

REQUEST user-name-lookup

PUT

https://signpuddle.com/server/user/email/{email}

Parameters
	`email`	`string` `slevinski@signwriting.org`	The email for a user

Headers
Pass	`5ffab638bde372b4fa63bb6f8484595d`

                          null

RESPONSE

Headers

204

collection

Collections available

REQUEST

GET

https://signpuddle.com/server/collection{?name}

Parameters
	`name`	`string` `sp3`	partial collection name

RESPONSE

Headers
Content-Type	`text/plain`

200 text/plain

                        ["en-US-interface-sp3"]

Collection resource

REQUEST the removal of a collection

DELETE

https://signpuddle.com/server/collection/{name}

Parameters
	`name`	`string` `en-US-interface-sp3`	The name of a collection

Headers
Pass	`5ffab638bde372b4fa63bb6f8484595d`

                          null

RESPONSE

Headers

204

Collection entry image resource

update image for collection entry

REQUEST an update for an existing dictionary entry

PUT

https://signpuddle.com/server/collection/{name}/entry/{ik}/image/{num}


`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

204

remove dictionary entry

REQUEST the removal of a collection entry image

DELETE

https://signpuddle.com/server/collection/{name}/entry/{ik}/image/{num}


`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

204

Collection statistics

REQUEST collections statistics

GET

https://signpuddle.com/server/collection/{name}/stats

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

REQUEST collections security

GET

https://signpuddle.com/server/collection/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

REQUEST interface security

GET

https://signpuddle.com/server/collection/{name}/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}

REQUEST an update for an existing entry

PUT

https://signpuddle.com/server/collection/{name}/security

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

204

REQUEST the deletion of collection security

DELETE

https://signpuddle.com/server/collection/{name}/security

Parameters
	`name`	`string` `en-US-interface-sp3`	The name of the collection

Headers
Pass	`5ffab638bde372b4fa63bb6f8484595d`

                          null

RESPONSE

Headers

204

Collection users

REQUEST

GET

https://signpuddle.com/server/collection/{name}/users

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

REQUEST

GET

https://signpuddle.com/server/collection/manage/unknown

RESPONSE

Headers
Content-Type	`text/plain`

200 text/plain

                        ["es-US-interface-sp3"]

Collection users management

REQUEST collection management

GET

https://signpuddle.com/server/collection/{name}/manage

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}]

REQUEST an update for collection management

PUT

https://signpuddle.com/server/collection/{name}/manage

Parameters
	`name`	`string` `ase-US-dictionary-public`	collection name

Headers
Pass	`5ffab638bde372b4fa63bb6f8484595d`

                          {"user":"slevinski","security":4}

RESPONSE

Headers

204

REQUEST the removal of user management for a collection

DELETE

https://signpuddle.com/server/collection/{name}/manage

Parameters
	`name`	`string` `ase-US-dictionary-public`	collection name

Headers
Pass	`5ffab638bde372b4fa63bb6f8484595d`

                          null

RESPONSE

Headers

204

Collection user

REQUEST the removal of a user from collection management

DELETE

https://signpuddle.com/server/collection/{name}/manage/{user}

Parameters
	`name`	`string` `ase-US-dictionary-public`	collection name
	`user`	`string` `slevinski`	user name

Headers
Pass	`5ffab638bde372b4fa63bb6f8484595d`

                          null

RESPONSE

Headers

204

Collection Request Copy

REQUEST new collection from source

POST

https://signpuddle.com/server/collection/{name}/request/{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

204

interface

Interfaces available

REQUEST

GET

https://signpuddle.com/server/interface{?name}

Parameters
	`name`	`string` `sp3`	partial interface name

RESPONSE

Headers
Content-Type	`text/plain`

200 text/plain

                        ["en-US-interface-sp3"]

Interface resource

REQUEST interface text

GET

https://signpuddle.com/server/interface/{name}{?update}

Parameters
	`name`	`string` `en-US-interface-sp3`	The name of an interface
	`update`	`number` `1`	Forces a rewrite of the interface 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

                        print.buttons.main   message   description   icon

Interface keys

REQUEST interface keys

GET

https://signpuddle.com/server/interface/{name}/key

Parameters
	`name`	`string` `en-US-interface-sp3`	The name of an interface

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

                          null

RESPONSE

Headers
Content-Type	`text/plain`

200 text/plain

                        ["print.buttons.main"]

Interface entries search

REQUEST matching interface entries

GET

https://signpuddle.com/server/interface/{name}/search/{text}

Parameters
	`name`	`string` `en-US-interface-sp3`	The name of an interface
	`text`	`string` `SignPuddle`	The text for searching

Headers
Pass	`724fd4b4438fba9d0c5ab89d0833e5c9`

                          null

RESPONSE

Headers
Content-Type	`text/plain`

200 text/plain

                        [
  {
    "key": "print.buttons.main",
    "message": "Print it!"
  }
]

Interface entry resource

add interface entry

REQUEST add new interface entry

POST

https://signpuddle.com/server/interface/{name}/entry

Parameters
	`name`	`string` `en-US-interface-sp3`	The name of an interface

Headers
Content-Type	`application/json`
Pass	`724fd4b4438fba9d0c5ab89d0833e5c9`

application/json

                          {"key":"new.key.one", "message":"UI text","description":"about the text","icon":"search"}

RESPONSE

Headers
Content-Type	`text/plain`

201 text/plain

...

Interface entry resource for key

retrieve interface entry

REQUEST an interface entry

GET

https://signpuddle.com/server/interface/{name}/entry/{key}

Parameters
	`name`	`string` `en-US-interface-sp3`	The name of an interface
	`key`	`string` `system.button.open`	The name of an interface key

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

                          null

RESPONSE

Headers
Content-Type	`text/plain`

200 text/plain

...

update interface entry

REQUEST an update for an existing entry

PUT

https://signpuddle.com/server/interface/{name}/entry/{key}

Parameters
	`name`	`string` `en-US-interface-sp3`	The name of an interface
	`key`	`string` `system.button.open`	The name of an interface key

Headers
Pass	`724fd4b4438fba9d0c5ab89d0833e5c9`

                          {"key":"new.key.one", "message":"UI text","description":"about the text","icon":"search"}

RESPONSE

Headers

204

remove interface entry

REQUEST the removal of an interface entry

DELETE

https://signpuddle.com/server/interface/{name}/entry/{key}

Parameters
	`name`	`string` `en-US-interface-sp3`	The name of an interface
	`key`	`string` `system.button.open`	The name of an interface key

Headers
Pass	`724fd4b4438fba9d0c5ab89d0833e5c9`

                          null

RESPONSE

Headers

204

dictionary

Dictionaries available

REQUEST

GET

https://signpuddle.com/server/dictionary{?name}

Parameters
	`name`	`string` `public`	partial dictionary name

RESPONSE

Headers
Content-Type	`text/plain`

200 text/plain

                        ["ase-US-dictionary-public"]

Dictionary resource

REQUEST dictionary text

GET

https://signpuddle.com/server/dictionary/{name}{?update}

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

REQUEST dictionary text

GET

https://signpuddle.com/server/dictionary/{name}/signs

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

retrieve dictionary signtexts

REQUEST dictionary text

GET

https://signpuddle.com/server/dictionary/{name}/signtexts

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

add dictionary entry

REQUEST add new dictionary entry

POST

https://signpuddle.com/server/dictionary/{name}/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

Dictionary entry resource for id

update dictionary entry

REQUEST an update for an existing dictionary entry

PUT

https://signpuddle.com/server/dictionary/{name}/entry/{id}

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

204

remove dictionary entry

REQUEST the removal of an dictionary entry

DELETE

https://signpuddle.com/server/dictionary/{name}/entry/{id}

Parameters
	`name`	`string` `ase-US-dictionary-public`	The name of an dictionary
	`id`	`string` `11244`	An id numbers

Headers
Pass	`724fd4b4438fba9d0c5ab89d0833e5c9`

                          null

RESPONSE

Headers

204

Search dictionary

REQUEST dictionary query results

GET

https://signpuddle.com/server/dictionary/{name}/search{?offset,limit,filter,sort,results}


`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

retrieve dictionary entry

REQUEST an dictionary entry

GET

https://signpuddle.com/server/dictionary/{name}/search/id/{id}{?offset,limit,filter,sort,results}


`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

REQUEST dictionary query results

GET

https://signpuddle.com/server/dictionary/{name}/search/sign/{query}{?offset,limit,filter,sort,results}


`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

retrieve dictionary results of searching signtexts with query string

REQUEST dictionary query results

GET

https://signpuddle.com/server/dictionary/{name}/search/signtext/{query}{?offset,limit,filter,sort,results}


`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

REQUEST matching dictionary entries

GET

https://signpuddle.com/server/dictionary/{name}/search/terms/{text}{?type,case,offset,limit,filter,sort,results}


`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

generate alphabet from dictionary contents

REQUEST dictionary query results

GET

https://signpuddle.com/server/dictionary/{name}/alphabet{?update}

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": []}

tools

tools index

REQUEST

GET

https://signpuddle.com/server/tools/

RESPONSE

Headers
Content-Type	`text/plain`

200 text/plain

                        Available routes:

/tools/
/tools/test{?text}
/tools/define
/tools/define/{section}
/tools/define/{section}/{part}
/tools/parse{?text,utf}
/tools/encode{?text,slash}
/tools/decode{?text}
/tools/utf8{?text}

Character definition tree

Get main define

REQUEST

GET

https://signpuddle.com/server/tools/define

RESPONSE

Headers
Content-Type	`text/plain;charset=utf-8`

200 text/plain;charset=utf-8

                        {
  "utf-8": {},
  "utf-16": {},
  "utf-32": {},
  "fsw": {},
  "swu": {},
  "style": {}
}

Section definition

REQUEST

GET

https://signpuddle.com/server/tools/define/{section}

Parameters
	`section`	`string` `fsw`	The name of section

RESPONSE

Headers
Content-Type	`text/plain;charset=utf-8`

200 text/plain;charset=utf-8

                        {
  "sign": [],
  "spatial": [],
  "symbol": [],
  "coord": [],
  "prefix": [],
  "box": [],
  "query": []
}

Part definition

REQUEST

GET

https://signpuddle.com/server/tools/define/{section}/{part}

Parameters
	`section`	`string` `swu`	The name of section
	`part`	`string` `symbol`	The part of the definition

RESPONSE

Headers
Content-Type	`text/plain;charset=utf-8`

200 text/plain;charset=utf-8

                        [
  "individual symbol",
  "S10000",
  "[\\x{40000}-\\x{4F428}]"
]

Parse text

Get parse results

REQUEST

GET

https://signpuddle.com/server/tools/parse{?text,utf}

Parameters
	`text`	`string` `S10000`	The text to parse
	`utf`	`string` `32`	The UTF number of 8, 16, 32 or ‘x’

RESPONSE

Headers
Content-Type	`text/plain;charset=utf-8`

200 text/plain;charset=utf-8

                        {
  "fsw": {
    "symbol": [
      "S10000"
    ]
  },
  "query": {
    "base": [
      100
    ],
    "symbol": [
      "S10000"
    ]
  }
}

Encode text

Get encoded query string

REQUEST

GET

https://signpuddle.com/server/tools/encode{?text,slash}

Parameters
	`text`	`string` `𝠀񆄱񈠣񍉡𝠃𝤛𝤵񍉡𝣴𝣵񆄱𝤌𝤆񈠣𝤉𝤚`	The text to encode
	`slash`	`number` `1`	The number of slashes for escaping

RESPONSE

Headers
Content-Type	`text/plain;charset=utf-8`

200 text/plain;charset=utf-8

                        \uD836\uDC00\uD8D8\uDD31\uD8E2\uDC23\uD8F4\uDE61\uD836\uDC03\uD836\uDD1B\uD836\uDD35\uD8F4\uDE61\uD836\uDCF4\uD836\uDCF5\uD8D8\uDD31\uD836\uDD0C\uD836\uDD06\uD8E2\uDC23\uD836\uDD09\uD836\uDD1A

Decode text

Get decoded query string

REQUEST

GET

https://signpuddle.com/server/tools/decode{?text}

Parameters
	`text`	`string` `\uD836\uDC00`	The text to decode

RESPONSE

Headers
Content-Type	`text/plain;charset=utf-8`

200 text/plain;charset=utf-8

                        𝠀

UTF-8 encode text

Get utf-8 encoded query string

REQUEST

GET

https://signpuddle.com/server/tools/utf8{?text}

Parameters
	`text`	`string` `𝠀񆄱񈠣񍉡𝠃𝤛𝤵񍉡𝣴𝣵񆄱𝤌𝤆񈠣𝤉𝤚`	The text to encode

RESPONSE

Headers
Content-Type	`text/plain;charset=utf-8`

200 text/plain;charset=utf-8

                        %F0%9D%A0%80%F1%86%84%B1%F1%88%A0%A3%F1%8D%89%A1%F0%9D%A0%83%F0%9D%A4%9B%F0%9D%A4%B5%F1%8D%89%A1%F0%9D%A3%B4%F0%9D%A3%B5%F1%86%84%B1%F0%9D%A4%8C%F0%9D%A4%86%F1%88%A0%A3%F0%9D%A4%89%F0%9D%A4%9A

Test with input

REQUEST

GET

https://signpuddle.com/server/tools/test{?text,opt1,opt2}


`text`	`string` `S10000`	Input for testing
`opt1`	`string` `AS`	Option one for testing
`opt2`	`string` `AS`	Option two for testing

RESPONSE

Headers
Content-Type	`text/plain;charset=utf-8`

200 text/plain;charset=utf-8

                        test output

FSW

FSW Word

REQUEST one Formal SignWriting in ASCII string

GET

https://signpuddle.com/server/fsw{?text,style}

Parameters
	`text`	`string` `AS20310S26b02S33100M521x547S33100482x483S20310506x500S26b02503x520`	The name of sign
	`style`	`boolean` `true`	Flag to include styling string

                          null

RESPONSE

Headers
Content-Type	`text/plain;charset=utf-8`

200 text/plain;charset=utf-8

                        AS20310S26b02S33100M521x547S33100482x483S20310506x500S26b02503x520

FSW Text

All FSW strings

REQUEST many Formal SignWriting in ASCII string

GET

https://signpuddle.com/server/fsw/all{?text,style}

Parameters
	`text`	`string` `AS20310S26b02S33100M521x547S33100482x483S20310506x500S26b02503x520`	The name of sign
	`style`	`number` `1`	Flag to include styling string

                          null

RESPONSE

Headers
Content-Type	`text/plain;charset=utf-8`

200 text/plain;charset=utf-8

                        AS20310S26b02S33100M521x547S33100482x483S20310506x500S26b02503x520

FSW to SWU

Text with FSW strings

REQUEST SWU conversion of FSW string

transformation from ASCII to Unicode characters.

GET

https://signpuddle.com/server/fsw/swu{?text}

Parameters
	`text`	`string` `AS20310S26b02S33100M521x547S33100482x483S20310506x500S26b02503x520`	The name of sign

                          null

RESPONSE

requires font SuttonSignWritingOneD

Headers
Content-Type	`text/plain;charset=utf-8`

200 text/plain;charset=utf-8

                        𝠀񆄱񈠣񍉡𝠃𝤛𝤵񍉡𝣴𝣵񆄱𝤌𝤆񈠣𝤉𝤚

SVG image

REQUEST collection text

GET

https://signpuddle.com/server/fsw/svg/{text}

Parameters
	`text`	`string` `AS20310S26b02S33100M521x547S33100482x483S20310506x500S26b02503x520`	The name of sign

                          null

RESPONSE

Headers
Content-Type	`image/svg+xml;charset=utf-8`

200 image/svg+xml;charset=utf-8

                        <svg version="1.1" xmlns="http://www.w3.org/2000/svg" width="39" height="64" viewBox="482 483 39 64">
  <text style="font-size:0%;">AS20310S26b02S33100M521x547S33100482x483S20310506x500S26b02503x520</text>
  <svg x='482' y='483'><g transform="translate(0.149874875465,34.7500790925) scale(0.00988906872676,-0.00988956850125)"><path class="sym-line" fill="black" d="M1528 3484 c-592 -92 -1088 -447 -1348 -963 -125 -249 -180 -485 -180 -771 0 -480 183 -911 529 -1242 350 -336 780 -508 1271 -508 451 0 864 150 1193 434 326 281 517 620 591 1051 21 121 21 409 0 530 -43 252 -114 444 -237 639 -282 453 -741 750 -1284 831 -127 19 -413 18 -535 -1z m607 -173 c583 -126 1038 -523 1224 -1069 59 -173 75 -277 75 -492 0 -165 -3 -211 -22 -300 -71 -327 -228 -611 -458 -829 -186 -177 -381 -295 -614 -374 -176 -60 -282 -78 -490 -84 -247 -7 -416 19 -628 97 -549 201 -944 674 -1043 1250 -17 97 -17 383 0 480 99 576 495 1050 1043 1250 105 38 177 58 303 81 143 26 467 21 610 -10z M1720 1800 l0 -600 80 0 80 0 0 600 0 600 -80 0 -80 0 0 -600z"/></g></svg>
  <svg x='506' y='500'><g transform="translate(0.0,15.0) scale(0.01,-0.01)"><path class="sym-fill" fill="white" d="M200 750 l0 -550 300 0 300 0 0 550 0 550 -300 0 -300 0 0 -550z"/><path class="sym-line" fill="black" d="M0 750 l0 -750 750 0 750 0 0 750 0 750 -750 0 -750 0 0 -750z m800 0 l0 -550 -300 0 -300 0 0 550 0 550 300 0 300 0 0 -550z"/></g></svg>
  <svg x='503' y='520'><g transform="translate(0.196840829729,26.6999810561) scale(0.00975214136907,-0.00983390502079)"><path class="sym-line" fill="black" d="M345 2350 l-350 -350 325 -325 325 -325 -325 -325 -325 -325 353 -353 352 -352 0 303 0 302 350 0 350 0 0 100 0 100 -350 0 -350 0 0 550 0 550 350 0 350 0 0 100 0 100 -350 0 -350 0 -2 300 -3 300 -350 -350z M1600 1350 l0 -1350 100 0 100 0 0 1350 0 1350 -100 0 -100 0 0 -1350z"/></g></svg>
</svg>

SVG with font

REQUEST collection text

GET

https://signpuddle.com/server/fsw/svg/font/{text}

Parameters
	`text`	`string` `AS20310S26b02S33100M521x547S33100482x483S20310506x500S26b02503x520`	The name of sign

                          null

RESPONSE

Headers
Content-Type	`image/svg+xml;charset=utf-8`

200 image/svg+xml;charset=utf-8

                        <svg version="1.1" xmlns="http://www.w3.org/2000/svg" width="49" height="69" viewBox="476 466 49 69">
  <text font-size="0">AS10011S10019S2e704S2e748M525x535S2e748483x510S10011501x466S2e704510x500S10019476x475</text>
  <g transform="translate(483,510)"><text class="sym-fill" style="pointer-events:none;font-family:'SuttonSignWritingFill';font-size:30px;fill:white;">􋛩</text><text class="sym-line" style="pointer-events:none;font-family:'SuttonSignWritingLine';font-size:30px;fill:black;">󻛩</text></g>
  <g transform="translate(501,466)"><text class="sym-fill" style="pointer-events:none;font-family:'SuttonSignWritingFill';font-size:30px;fill:white;">􀀒</text><text class="sym-line" style="pointer-events:none;font-family:'SuttonSignWritingLine';font-size:30px;fill:black;">󰀒</text></g>
  <g transform="translate(510,500)"><text class="sym-fill" style="pointer-events:none;font-family:'SuttonSignWritingFill';font-size:30px;fill:white;">􋚥</text><text class="sym-line" style="pointer-events:none;font-family:'SuttonSignWritingLine';font-size:30px;fill:black;">󻚥</text></g>
  <g transform="translate(476,475)"><text class="sym-fill" style="pointer-events:none;font-family:'SuttonSignWritingFill';font-size:30px;fill:white;">􀀚</text><text class="sym-line" style="pointer-events:none;font-family:'SuttonSignWritingLine';font-size:30px;fill:black;">󰀚</text></g>
</svg>

swu

SWU Word

REQUEST one Formal SignWriting in ASCII string

GET

https://signpuddle.com/server/swu{?text,style}

Parameters
	`text`	`string` `𝠀񆄱񈠣񍉡𝠃𝤛𝤵񍉡𝣴𝣵񆄱𝤌𝤆񈠣𝤉𝤚`	The name of sign
	`style`	`number` `1`	Flag to include styling string

                          null

RESPONSE

Headers
Content-Type	`text/plain;charset=utf-8`

200 text/plain;charset=utf-8

                        𝠀񆄱񈠣񍉡𝠃𝤛𝤵񍉡𝣴𝣵񆄱𝤌𝤆񈠣𝤉𝤚

SWU Text

all SWU strings

REQUEST many Formal SignWriting in ASCII string

GET

https://signpuddle.com/server/swu/all{?text,style}

Parameters
	`text`	`string` `𝠀񆄱񈠣񍉡𝠃𝤛𝤵񍉡𝣴𝣵񆄱𝤌𝤆񈠣𝤉𝤚`	The name of sign
	`style`	`number` `1`	Flag to include styling string

                          null

RESPONSE

Headers
Content-Type	`text/plain;charset=utf-8`

200 text/plain;charset=utf-8

                        𝠀񆄱񈠣񍉡𝠃𝤛𝤵񍉡𝣴𝣵񆄱𝤌𝤆񈠣𝤉𝤚

SWU to FSW

text with SWU strings

REQUEST original text with Formal SignWriting in ASCII inside

GET

https://signpuddle.com/server/swu/fsw{?text}

Parameters
	`text`	`string` `𝠀񆄱񈠣񍉡𝠃𝤛𝤵񍉡𝣴𝣵񆄱𝤌𝤆񈠣𝤉𝤚`	The name of sign

                          null

RESPONSE

Headers
Content-Type	`text/plain;charset=utf-8`

200 text/plain;charset=utf-8

                        𝠀񆄱񈠣񍉡𝠃𝤛𝤵񍉡𝣴𝣵񆄱𝤌𝤆񈠣𝤉𝤚

SVG image

REQUEST collection text

GET

https://signpuddle.com/server/swu/svg/{text}

Parameters
	`text`	`string` `𝠀񆄱񈠣񍉡𝠃𝤛𝤵񍉡𝣴𝣵񆄱𝤌𝤆񈠣𝤉𝤚`	The name of sign

                          null

RESPONSE

Headers
Content-Type	`image/svg+xml;charset=utf-8`

200 image/svg+xml;charset=utf-8

                        <svg version="1.1" xmlns="http://www.w3.org/2000/svg" width="39" height="64" viewBox="482 483 39 64">
  <text style="font-size:0%;">𝠀񆄱񈠣񍉡𝠃𝤛𝤵񍉡𝣴𝣵񆄱𝤌𝤆񈠣𝤉𝤚</text>
  <svg x='482' y='483'><g transform="translate(0.149874875465,34.7500790925) scale(0.00988906872676,-0.00988956850125)"><path class="sym-line" fill="black" d="M1528 3484 c-592 -92 -1088 -447 -1348 -963 -125 -249 -180 -485 -180 -771 0 -480 183 -911 529 -1242 350 -336 780 -508 1271 -508 451 0 864 150 1193 434 326 281 517 620 591 1051 21 121 21 409 0 530 -43 252 -114 444 -237 639 -282 453 -741 750 -1284 831 -127 19 -413 18 -535 -1z m607 -173 c583 -126 1038 -523 1224 -1069 59 -173 75 -277 75 -492 0 -165 -3 -211 -22 -300 -71 -327 -228 -611 -458 -829 -186 -177 -381 -295 -614 -374 -176 -60 -282 -78 -490 -84 -247 -7 -416 19 -628 97 -549 201 -944 674 -1043 1250 -17 97 -17 383 0 480 99 576 495 1050 1043 1250 105 38 177 58 303 81 143 26 467 21 610 -10z M1720 1800 l0 -600 80 0 80 0 0 600 0 600 -80 0 -80 0 0 -600z"/></g></svg>
  <svg x='506' y='500'><g transform="translate(0.0,15.0) scale(0.01,-0.01)"><path class="sym-fill" fill="white" d="M200 750 l0 -550 300 0 300 0 0 550 0 550 -300 0 -300 0 0 -550z"/><path class="sym-line" fill="black" d="M0 750 l0 -750 750 0 750 0 0 750 0 750 -750 0 -750 0 0 -750z m800 0 l0 -550 -300 0 -300 0 0 550 0 550 300 0 300 0 0 -550z"/></g></svg>
  <svg x='503' y='520'><g transform="translate(0.196840829729,26.6999810561) scale(0.00975214136907,-0.00983390502079)"><path class="sym-line" fill="black" d="M345 2350 l-350 -350 325 -325 325 -325 -325 -325 -325 -325 353 -353 352 -352 0 303 0 302 350 0 350 0 0 100 0 100 -350 0 -350 0 0 550 0 550 350 0 350 0 0 100 0 100 -350 0 -350 0 -2 300 -3 300 -350 -350z M1600 1350 l0 -1350 100 0 100 0 0 1350 0 1350 -100 0 -100 0 0 -1350z"/></g></svg>
</svg>

SVG with font

REQUEST collection text

GET

https://signpuddle.com/server/swu/svg/font/{text}

Parameters
	`text`	`string` `𝠀񆄱񈠣񍉡𝠃𝤛𝤵񍉡𝣴𝣵񆄱𝤌𝤆񈠣𝤉𝤚`	The name of sign

                          null

RESPONSE

Headers
Content-Type	`image/svg+xml;charset=utf-8`

200 image/svg+xml;charset=utf-8

                        <svg version="1.1" xmlns="http://www.w3.org/2000/svg" width="49" height="69" viewBox="476 466 49 69">
  <text font-size="0">𝠀񆄱񈠣񍉡𝠃𝤛𝤵񍉡𝣴𝣵񆄱𝤌𝤆񈠣𝤉𝤚</text>
  <g transform="translate(483,510)"><text class="sym-fill" style="pointer-events:none;font-family:'SuttonSignWritingFill';font-size:30px;fill:white;">􋛩</text><text class="sym-line" style="pointer-events:none;font-family:'SuttonSignWritingLine';font-size:30px;fill:black;">󻛩</text></g>
  <g transform="translate(501,466)"><text class="sym-fill" style="pointer-events:none;font-family:'SuttonSignWritingFill';font-size:30px;fill:white;">􀀒</text><text class="sym-line" style="pointer-events:none;font-family:'SuttonSignWritingLine';font-size:30px;fill:black;">󰀒</text></g>
  <g transform="translate(510,500)"><text class="sym-fill" style="pointer-events:none;font-family:'SuttonSignWritingFill';font-size:30px;fill:white;">􋚥</text><text class="sym-line" style="pointer-events:none;font-family:'SuttonSignWritingLine';font-size:30px;fill:black;">󻚥</text></g>
  <g transform="translate(476,475)"><text class="sym-fill" style="pointer-events:none;font-family:'SuttonSignWritingFill';font-size:30px;fill:white;">􀀚</text><text class="sym-line" style="pointer-events:none;font-family:'SuttonSignWritingLine';font-size:30px;fill:black;">󰀚</text></g>
</svg>

apitxt

root

Every document should start with a root element. After the root, the other elements are used to quickly create complex website APIs. The order of the lines matters and will effect the structure of the JSON objects.

There are two groups of elements, the frame elements and the detail elements. The frame elements structure a website api and the detail elements attach to a previous frame element.

Frame elements

There are six frame elements: root, group, route, method, request, and response. The lines are written in a specific order to create an array of JSON objects.

route organization

An ApiTxt document starts with a root, or an assumed root. Any route that occur before a group element, will be associated with the root. Groups are always associated with the root. Group elements can contain routes.

    root
      | - routes
      | - groups
            | - routes

route structure

A route can be associated with a variety of HTTP methods. Each method can have several requests and responses. Any response before a request will assume a generic request. Any response after a request will be associated with that request.

    route
      | - methods
        | - responses
        | - requests
              | - responses

Detail elements

There are five detail elements: line, parameter, code, header, and body. The detail lines attach to a previous frame element if correctly structured.

single line elements

lines for all frame elements
parameters for route
code for method
body for request and response
headers for request and response

Every document should start with a root element.

root line

root <TAB> name <TAB> title <TAB> host

field 1 - name - uniquely identifies a document
field 2 - title - name of the document
field 3 - host - website URL

root example

root <TAB> apitxt <TAB> ApiTxt <TAB> https://signpuddle.com/apitxt

root line relationships

    root
     | - lines
     | - routes
     | - groups

root object

{
  "root" : field[1],
  "title" : field[2],
  "host" : field[3],
  "lines" : []
}

REQUEST the root definition

GET

https://signpuddle.com/server/apitxt/root

                          null

RESPONSE

Headers
Content-Type	`text/plain`

200 text/plain

                        Every document should start with a root element.

**root line**

root   name   title   host

+ field 1 - name - uniquely identifies a document
+ field 2 - title - name of the document
+ field 3 - host - website URL

**example**

root   apitxt   ApiTxt   https://signpuddle.com/apitxt

**root line relationships**

```
    root
     | - lines
     | - routes
     | - groups
```

**root object**

```json
{
  "root" : field[1],
  "title" : field[2],
  "host" : field[3],
  "lines" : []
}
```

group

The group organizes resources into sections

group line

group <TAB> name <TAB> description

field 1 - name - the short name used for sections
field 2 - description - information about the group

group example

group <TAB> Section name <TAB> an example section

group line relationships

    group
     | - lines
     | - routes

group object

{
  "group" : field[1],
  "description" : field[2],
  "lines": []
}

REQUEST the group definition

GET

https://signpuddle.com/server/apitxt/group

                          null

RESPONSE

Headers
Content-Type	`text/plain`

200 text/plain

                        The group organizes resources into sections

**group line**

group   name   description

+ field 1 - name - the short name used for sections
+ field 2 - description - information about the group

**group example**

group   Section name   an example section

**group line relationships**

```
    group
     | - lines
     | - routes
```

**group object**

```json
{
  "group" : field[1],
  "description" : field[2],
  "lines": []
}
```

route

The route element allows access to a resource

route line

route <TAB> URI template <TAB> name <TAB> description

field 1 - URI template - a resource pattern with parameters
field 2 - name - the route name must be unique
field 3 - description - information about the resource

route example

route <TAB> /example <TAB> an example route <TAB> a description of the route

route line relationships

    route
     | - lines
     | - parameters
     | - methods

route object

{
  "route" : field[1],
  "name" : field[2],
  "description" : field[3],
  "lines": [],
  "parameters": []
}

REQUEST the route definition

GET

https://signpuddle.com/server/apitxt/route

                          null

RESPONSE

Headers
Content-Type	`text/plain`

200 text/plain

                        The route element allows access to a resource

**route line**

route   URI template   name   description

+ field 1 - URI template - a resource pattern with parameters
+ field 2 - name - the route name must be unique
+ field 3 - description - information about the resource

**route example**

route   /example   an example route   a description of the route

**route line relationships**

```
    route
     | - lines
     | - parameters
     | - methods
```

**route object**

```json
{
  "route" : field[1],
  "name" : field[2],
  "description" : field[3],
  "lines": [],
  "parameters": []
}
```

parameter

The parameter element is applied to the previous route

parameter line

parameter <TAB> name <TAB> example <TAB> type <TAB> description

field 1 - name - the name of a parameter for a route
field 2 - example - an example value for the parameter
field 3 - type - the parameter type, such as “string”, “number”, “boolean”, “string, optional”, “string, required”
field 4 - description - information about the parameter

parameter example

parameter <TAB> country_code <TAB> US <TAB> string <TAB> the country code of interest

parameter line relationships

parameter lines are added to a parameters array

parameters array

{"parameters":
  [
    {
      "name" : " field[1],
      "example" : field[2],
      "type" : field[3],
      "description" : field[4]
    }
  ]
}

REQUEST the parameter definition

GET

https://signpuddle.com/server/apitxt/parameter

                          null

RESPONSE

Headers
Content-Type	`text/plain`

200 text/plain

                        The parameter element is applied to the previous route

**parameter line**

parameter   name   example   type   description

+ field 1 - name - the name of a parameter for a route
+ field 2 - example - an example value for the parameter
+ field 3 - type - the parameter type, such as "string", "number", "boolean", "string, optional", "string, required"
+ field 4 - description - information about the parameter

**parameter example**

parameter   country_code   US   string   the country code of interest

**parameter line relationships**

parameter lines are added to a parameters array

**parameters array**

```json
{"parameters":
  [
    {
      "name" : " field[1],
      "example" : field[2],
      "type" : field[3],
      "description" : field[4]
    }
  ]
}
```

method

The method element represents an action that can be performed on a route

method line

method <TAB> HTTP method <TAB> name <TAB> description

field 1 - HTTP method - the type of action to perform: GET, POST, PUT, DELETE
field 2 - name - the name of the action
field 3 - description - information about the method

method example

method <TAB> GET <TAB> Get an example <TAB> This method retrieves an example document

method line relationships

    method
     | - lines
     | - code
     | - requests
     | - responses

method object

{
  "method" : field[1],
  "name" : field[2],
  "description" : field[3],
  "lines" : [],
  "code" : [],
  "dialog" : [
    {
      "request" : {},
      "responses" : []
    }
  ]
}

REQUEST the method definition

GET

https://signpuddle.com/server/apitxt/method

                          null

RESPONSE

Headers
Content-Type	`text/plain`

200 text/plain

                        The method element represents an action that can be performed on a route

**method line**

method   HTTP method   name   description

+ field 1 - HTTP method - the type of action to perform: GET, POST, PUT, DELETE
+ field 2 - name - the name of the action
+ field 3 - description - information about the method

**method example**

method   GET   Get an example   This method retrieves an example document

**method line relationships**

```
    method
     | - lines
     | - code
     | - requests
     | - responses
```

**method object**

```json
{
  "method" : field[1],
  "name" : field[2],
  "description" : field[3],
  "lines" : [],
  "code" : [],
  "dialog" : [
    {
      "request" : {},
      "responses" : []
    }
  ]
}
```

request

The request element is associated with a specific method and can be paired with multiple responses.

request line

request <TAB> name <TAB> type

field 1 - name - uniquely identifies a request
field 2 - type - the content type of the request body

request example

request <TAB> matching text within request body <TAB> plain/text

request line relationships

    request
     | - lines
     | - headers
     | - body

request object

{
  "name" : field[1],
  "type" : field[2],
  "lines" : [],
  "headers" : {},
  "body" : []
}

REQUEST the request definition

GET

https://signpuddle.com/server/apitxt/request

                          null

RESPONSE

Headers
Content-Type	`text/plain`

200 text/plain

                        The request element is associated with a specific method and can be paired with multiple responses.

**request line**

request   name   type

+ field 1 - name - uniquely identifies a request
+ field 2 - type - the content type of the request body

**request example**

request   matching text within request body   plain/text

**request line relationships**

```
    request
     | - lines
     | - headers
     | - body
```

**request object**

```json
{
  "name" : field[1],
  "type" : field[2],
  "lines" : [],
  "headers" : {},
  "body" : []
}
```

response

The response element is associated with a specific request, or associated with a specific method with an assumed generic request.

response line

response <TAB> status <TAB> type

field 1 - status - an HTTP response code indicating the status of the request
field 2 - type - the content type of the response body

response example

response <TAB> 200 <TAB> plain/text

response line relationships

    response
     | - lines
     | - headers
     | - body

response object

{
  "status" : field[1],
  "type" : field[2],
  "lines" : [],
  "headers" : {},
  "body" : []
}

REQUEST the response definition

GET

https://signpuddle.com/server/apitxt/response

                          null

RESPONSE

Headers
Content-Type	`text/plain`

200 text/plain

                        The response element is associated with a specific request, or associated with a specific method with an assumed generic request.

**response line**

response   status   type

+ field 1 - status - an HTTP response code indicating the status of the request
+ field 2 - type - the content type of the response body

**response example**

response   200   plain/text

**response line relationships**

```
    response
     | - lines
     | - headers
     | - body
```

**response object**

```json
{
  "status" : field[1],
  "type" : field[2],
  "lines" : [],
  "headers" : {},
  "body" : []
}
```

header

The header element is applied to a preceding route

header line

header <TAB> name <TAB> value

field 1 - name - the header variable name
field 2 - value - the header variable value

header example

header <TAB> X-Powered-By <TAB> ApiTxt

header object

{ field[1] : field[2] }

REQUEST the header definition

GET

https://signpuddle.com/server/apitxt/header

                          null

RESPONSE

Headers
Content-Type	`text/plain`

200 text/plain

                        The header element is applied to a preceding request or response

**header line**

header   name   value

+ field 1 - name - the header variable name
+ field 2 - value - the header variable value

**header example**

header   X-Powered-By   ApiTxt

**header object**

```json
{ field[1] : field[2] }
```

body

Get body definition

The body element adds contents to a preceding request or response.

The text of the body is everything after the string “body <TAB>“.

REQUEST the body definition

GET

https://signpuddle.com/server/apitxt/body

                          null

RESPONSE

Headers
Content-Type	`text/plain`

200 text/plain

                        The body element adds contents to a preceding request or response.

The text of the body is everything after the string "body <TAB>"

line

The line element adds additional text to frame elements.

For the root, group, route, method, request, and response, the lines add details to an element.

The text of the line is everything after the string “line <TAB>“.

REQUEST the line definition

GET

https://signpuddle.com/server/apitxt/line

                          null

RESPONSE

Headers
Content-Type	`text/plain`

200 text/plain

                        The line element adds additional text to frame elements.

For the root, group, route, method, request, and response, the lines add details to an element.

The text of the line is everything after the string "line <TAB>".

code

The code element adds functionality to the method element.

The code element contains programming text. ApiTxt comes integrated with the PHP project the Slim Framework v2. The conversion to working PHP adds boilerplate details for routes and method, with named parameters and query parameters available as functional variables.

The text of the code is everything after the string “code <TAB>“.

REQUEST the code definition

GET

https://signpuddle.com/server/apitxt/code

                          null

RESPONSE

Headers
Content-Type	`text/plain`

200 text/plain

                        The code element adds functionality to the method element.

The code element contains programming text.  ApiTxt comes integrated with the PHP project the Slim Framework v2.  The conversion to working PHP adds boilerplate details for routes and method, with named parameters and query parameters available as functional variables.

The text of the code is everything after the string "code <TAB>".

SignPuddle 3 API

HTTP Request Methods

HTTP Response Statuses

Success Codes

Redirect Codes

Client Error Codes

Server Error Codes

HTTP Headers

Headers

Retrieve country list

REQUEST user-who

GET

RESPONSE

String for accounting and validation

REQUEST user pass

POST

RESPONSE

Check pass against user

REQUEST user pass verify

PUT

RESPONSE

Process log in to server

REQUEST verify user

PUT

RESPONSE

Update user profile

REQUEST user-update

PUT

RESPONSE

Register new user

REQUEST user-add

POST

RESPONSE

Update user password

REQUEST user-update-password

POST

RESPONSE

Reset user password

REQUEST user-password-reset

PUT

RESPONSE

List of user email requests

REQUEST user-email-request

GET

RESPONSE

Lookup username

REQUEST user-name-lookup

PUT

RESPONSE

Get available collections

REQUEST

GET

RESPONSE

delete collection

REQUEST the removal of a collection

DELETE

RESPONSE

update image for collection entry

REQUEST an update for an existing dictionary entry

PUT

RESPONSE

remove dictionary entry

REQUEST the removal of a collection entry image

DELETE

RESPONSE

Get collection statistics

REQUEST collections statistics

GET

RESPONSE

Get collections security

REQUEST collections security

GET

RESPONSE

retrieve collection security

REQUEST interface security

GET

RESPONSE

Update collection security

REQUEST an update for an existing entry

PUT