FORMAT: X-1A
HOST: https://signpuddle.com/server

# SignPuddle 3 API
> 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](../src/index.txt) and [JSON objects](../src/index.json)
+ Documents: [API Blueprint](../doc/index.md) and [Stand Alone HTML](../doc/index.htm)
+ Live Page: [API Interface](../api/index.html) and [JavaScript](../api/index.js)

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


## Group user
SignPuddle 3 collections are organized by country and language codes

+ Source: [ApiTxt format](../src/user.txt) and [JSON objects](../src/user.json)
+ Documents: [API Blueprint](../doc/user.md) and [Stand Alone HTML](../doc/user.htm)
+ Live Page: [API Interface](../api/user.html) and [JavaScript](../api/user.js)

### Who uses SignWriting? [/user/who]
List of countries with size and activity.

#### Retrieve country list [GET]
The available countries where signs are available.

+ Request user-who

     + Body

            null

+ Response 200 (text/plain)

     + Body

            BR
            US

### User pass [/user/pass]
A string for accounting and validation

#### String for accounting and validation [POST]

+ Request user pass

     + Body

            null

+ Response 200 (text/plain)

     + Body

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

#### Check pass against user [PUT]

+ Request user pass verify

     + Attributes
         + username: anonymous (string) - name of the user
         + pass: af77... (string) - pass for session validation

     + Body

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

+ Response 204

### User login [/user/login]
Validation of user with validated password

#### Process log in to server [PUT]

+ Request verify user (application/json)

     + Attributes
         + username: anonymous (string) - name of the user
         + pass: af77... (string) - pass for session validation
         + validated: 2793f... (string) - validated pass mixed with password

     + Body

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

+ Response 200 (application/json)

     response text here

     + Body

            {"user-profile":""}

### User profile [/user/{name}]
User details

+ Parameters

     + name: slevinski (string) - The name of a user

#### Update user profile [PUT]
Updates the profile of the user

+ Request user-update

     + Headers

            Pass: 5ffab638bde372b4fa63bb6f8484595d

     + Body

            null

+ Response 204

#### Register new user [POST]
Creates and returns a new user

+ Request user-add

     + Headers

            Pass: 5ffab638bde372b4fa63bb6f8484595d

     + Body

            null

+ Response 200 (text/plain)

     + Body

            profile created and returned

### User password [/user/{name}/password]
User password resource

+ Parameters

     + name: slevinski (string) - The name of a user

#### Update user password [POST]
Updates the password of the user

+ Request user-update-password (plain/text)

     + Headers

            Pass: 5ffab638bde372b4fa63bb6f8484595d

     + Body

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

+ Response 204

#### Reset user password [PUT]
Creates a temporary password for the user

+ Request user-password-reset (plain/text)

     + Headers

            Pass: 5ffab638bde372b4fa63bb6f8484595d

     + Body

            null

+ Response 204

### User email requests [/user/email]
Requests for email of username or password reset

#### List of user email requests [GET]
User email requests for username or passwords

+ Request user-email-request

     + Headers

            Pass: 5ffab638bde372b4fa63bb6f8484595d

     + Body

            null

+ Response 200 (text/plain)

     + Body

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

### Username lookup [/user/email/{email}]
Forgot username email lookup

+ Parameters

     + email: slevinski@signwriting.org (string) - The email for a user

#### Lookup username [PUT]
Creates a request for email of username

+ Request user-name-lookup

     + Headers

            Pass: 5ffab638bde372b4fa63bb6f8484595d

     + Body

            null

+ Response 204

## Group collection
Resources related to collections in general

+ Source: [ApiTxt format](../src/collection.txt) and [JSON objects](../src/collection.json)
+ Documents: [API Blueprint](../doc/collection.md) and [Stand Alone HTML](../doc/collection.htm)
+ Live Page: [API Interface](../api/collection.html) and [JavaScript](../api/collection.js)

### Collections available [/collection{?name}]

+ Parameters

     + name: sp3 (string) - partial collection name

#### Get available collections [GET]

+ Response 200 (text/plain)

     + Body

            ["en-US-interface-sp3"]

### Collection resource [/collection/{name}]
Specific collection

+ Parameters

     + name: `en-US-interface-sp3` (string) - The name of a collection

#### delete collection [DELETE]

+ Request the removal of a collection

     + Headers

            Pass: 5ffab638bde372b4fa63bb6f8484595d

     + Body

            null

+ Response 204

### Collection entry image resource [/collection/{name}/entry/{ik}/image/{num}]
Specific image for collection entry

+ Parameters

     + name: `ase-US-dictionary-public` (string) - The name of an dictionary
     + ik: 11244 (string) - An id number or key string
     + num: 1 (string) - The image number of 1 thru 4

#### update image for collection entry [PUT]

+ Request an update for an existing dictionary entry (application/json)

     + Headers

            Pass: 724fd4b4438fba9d0c5ab89d0833e5c9

     + Body

            {
              "file": "name.png",
              "data": "data:image/jpeg;base64,/9j/4AAQSkZJRgABAQEASABIAAD..."
            }

+ Response 204

#### remove dictionary entry [DELETE]

+ Request the removal of a collection entry image

     + Headers

            Pass: 724fd4b4438fba9d0c5ab89d0833e5c9

     + Body

            null

+ Response 204

### Collection statistics [/collection/{name}/stats]
Statistics about the collection

+ Parameters

     + name: `ase-US-dictionary-public` (required,string) - The name of a dictionary

#### Get collection statistics [GET]

+ Request collections statistics

     + Headers

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

     + Body

            null

+ Response 200 (text/plain)

     + Body

            [{"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 [/collection/security]
Security settings for all collections

#### Get collections security [GET]

+ Request collections security

     + Headers

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

     + Body

            null

+ Response 200 (text/plain)

     + Body

            [{"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 [/collection/{name}/security]
Details about the collection security

+ Parameters

     + name: `en-US-interface-sp3` (required,string) - The name of the collection

#### retrieve collection security [GET]

+ Request interface security

     + Body

            null

+ Response 200 (text/plain)

     + Body

            {"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 [PUT]

+ Request an update for an existing entry (text/plain)

     + Headers

            Pass: 5ffab638bde372b4fa63bb6f8484595d

     + Body

            {"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 204

#### Remove security for collection [DELETE]

+ Request the deletion of collection security

     + Headers

            Pass: 5ffab638bde372b4fa63bb6f8484595d

     + Body

            null

+ Response 204

### Collection users [/collection/{name}/users]

+ Parameters

     + name: `ase-US-dictionary-public` (string) - collection name

#### Get collection users [GET]

+ Response 200 (text/plain)

     + Body

            [{"user": "test_user","security": 3}]

### Management for unknown collections [/collection/manage/unknown]

#### Get list of unknown collections with user management [GET]

+ Response 200 (text/plain)

     + Body

            ["es-US-interface-sp3"]

### Collection users management [/collection/{name}/manage]

+ Parameters

     + name: `ase-US-dictionary-public` (string) - collection name

#### Get collection management [GET]

+ Request collection management

     + Headers

            Pass: 5ffab638bde372b4fa63bb6f8484595d

     + Body

            null

+ Response 200 (text/plain)

     + Body

            [{"name": "test_user","display": "Test Editor","email": "testing@gmail.com","security": 3}]

#### Update collection management [PUT]

+ Request an update for collection management

     + Headers

            Pass: 5ffab638bde372b4fa63bb6f8484595d

     + Body

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

+ Response 204

#### Remove user management for collection [DELETE]

+ Request the removal of user management for a collection

     + Headers

            Pass: 5ffab638bde372b4fa63bb6f8484595d

     + Body

            null

+ Response 204

### Collection user [/collection/{name}/manage/{user}]

+ Parameters

     + name: `ase-US-dictionary-public` (string) - collection name
     + user: `slevinski` (string) - user name

#### Remove user from collection management [DELETE]

+ Request the removal of a user from collection management

     + Headers

            Pass: 5ffab638bde372b4fa63bb6f8484595d

     + Body

            null

+ Response 204

### Collection Request Copy [/collection/{name}/request/{source}]

+ Parameters

     + name: `es-US-interface-sp3` (required,string) - The name of the new collection
     + source: `en-US-interface-sp3` (required,string) - The name of the source collection

#### request the creation of a new collection [POST]

+ Request new collection from source

     + Headers

            Pass: 5ffab638bde372b4fa63bb6f8484595d

     + Body

            null

+ Response 204

## Group interface
Resources related to interface collections

+ Source: [ApiTxt format](../src/interface.txt) and [JSON objects](../src/interface.json)
+ Documents: [API Blueprint](../doc/interface.md) and [Stand Alone HTML](../doc/interface.htm)
+ Live Page: [API Interface](../api/interface.html) and [JavaScript](../api/interface.js)

### Interfaces available [/interface{?name}]

+ Parameters

     + name: sp3 (string) - partial interface name

#### Get available interfaces [GET]

+ Response 200 (text/plain)

     + Body

            ["en-US-interface-sp3"]

### Interface resource [/interface/{name}{?update}]
Access to available interfaces

+ Parameters

     + name: `en-US-interface-sp3` (required,string) - The name of an interface
     + update: 1 (optional,number) - Forces a rewrite of the interface for json and txt formats

#### retrieve interface [GET]

+ Request interface text

     + Headers

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

     + Body

            null

+ Response 200 (text/plain)

     + Body

            print.buttons.main   message   description   icon

### Interface keys [/interface/{name}/key]
Access to interface keys

+ Parameters

     + name: `en-US-interface-sp3` (required,string) - The name of an interface

#### retrieve interface keys [GET]

+ Request interface keys

     + Headers

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

     + Body

            null

+ Response 200 (text/plain)

     + Body

            ["print.buttons.main"]

### Interface entries search [/interface/{name}/search/{text}]
Search interface for text

+ Parameters

     + name: `en-US-interface-sp3` (required,string) - The name of an interface
     + text: `SignPuddle` (required,string) - The text for searching

#### retrieve matching entries [GET]

+ Request matching interface entries

     + Headers

            Pass: 724fd4b4438fba9d0c5ab89d0833e5c9

     + Body

            null

+ Response 200 (text/plain)

     + Body

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

### Interface entry resource [/interface/{name}/entry]
Entries for interface

+ Parameters

     + name: `en-US-interface-sp3` (string) - The name of an interface

#### add interface entry [POST]

+ Request add new interface entry (application/json)

     + Headers

            Pass: 724fd4b4438fba9d0c5ab89d0833e5c9

     + Body

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

+ Response 201 (text/plain)

     + Body

            ...

### Interface entry resource for key [/interface/{name}/entry/{key}]
Specific entries for interface

+ Parameters

     + name: `en-US-interface-sp3` (string) - The name of an interface
     + key: system.button.open (string) - The name of an interface key

#### retrieve interface entry [GET]

+ Request an interface entry

     + Headers

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

     + Body

            null

+ Response 200 (text/plain)

     + Body

            ...

#### update interface entry [PUT]

+ Request an update for an existing entry

     + Headers

            Pass: 724fd4b4438fba9d0c5ab89d0833e5c9

     + Body

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

+ Response 204

#### remove interface entry [DELETE]

+ Request the removal of an interface entry

     + Headers

            Pass: 724fd4b4438fba9d0c5ab89d0833e5c9

     + Body

            null

+ Response 204

## Group dictionary
Resources related to dictionary collections

+ Source: [ApiTxt format](../src/dictionary.txt) and [JSON objects](../src/dictionary.json)
+ Documents: [API Blueprint](../doc/dictionary.md) and [Stand Alone HTML](../doc/dictionary.htm)
+ Live Page: [API Dictionary](../api/dictionary.html) and [JavaScript](../api/dictionary.js)

### Dictionaries available [/dictionary{?name}]

+ Parameters

     + name: public (string) - partial dictionary name

#### Get available dictionaries [GET]

+ Response 200 (text/plain)

     + Body

            ["ase-US-dictionary-public"]

### Dictionary resource [/dictionary/{name}{?update}]
Access to available dictionaries

+ Parameters

     + name: `ase-US-dictionary-public` (required,string) - The name of an dictionary
     + update: 1 (optional,number) - Forces a rewrite of the dictionary for json and txt formats

#### retrieve dictionary [GET]

+ Request dictionary text

     + Headers

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

     + Body

            null

+ Response 200 (text/plain)

     + Body

            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 [/dictionary/{name}/signs]
The signs in the dictionary

+ Parameters

     + name: `ase-US-dictionary-public` (string) - The name of an dictionary

#### retrieve dictionary signs [GET]

+ Request dictionary text

     + Headers

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

     + Body

            null

+ Response 200 (text/plain)

     + Body

            𝠀񂱡񂇙񆿃𝠃𝤝𝤔񂇙𝣰𝣹񆿃𝤎𝤁񂱡𝣽𝤀

### List of dictionary signtexts [/dictionary/{name}/signtexts]
The signtexts in the dictionary

+ Parameters

     + name: `ase-US-dictionary-public` (string) - The name of an dictionary

#### retrieve dictionary signtexts [GET]

+ Request dictionary text

     + Headers

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

     + Body

            null

+ Response 200 (text/plain)

     + Body

            𝠀񂱡񂇙񆿃𝠃𝤝𝤔񂇙𝣰𝣹񆿃𝤎𝤁񂱡𝣽𝤀

### Dictionary entry resource [/dictionary/{name}/entry]
Entries for dictionary

+ Parameters

     + name: `ase-US-dictionary-public` (string) - The name of an dictionary

#### add dictionary entry [POST]

+ Request add new dictionary entry (application/json)

     + Headers

            Pass: 724fd4b4438fba9d0c5ab89d0833e5c9

     + Body

            {
              "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 201 (text/plain)

     + Body

            777

### Dictionary entry resource for id [/dictionary/{name}/entry/{id}]
Specific entries for dictionary

+ Parameters

     + name: `ase-US-dictionary-public` (string) - The name of an dictionary
     + id: 11244 (string) - An id numbers

#### update dictionary entry [PUT]

+ Request an update for an existing dictionary entry (application/json)

     + Headers

            Pass: 724fd4b4438fba9d0c5ab89d0833e5c9

     + Body

            {
              "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 204

#### remove dictionary entry [DELETE]

+ Request the removal of an dictionary entry

     + Headers

            Pass: 724fd4b4438fba9d0c5ab89d0833e5c9

     + Body

            null

+ Response 204

### Search dictionary [/dictionary/{name}/search{?offset,limit,filter,sort,results}]
Searching dictionary signs

+ Parameters

     + name: `ase-US-dictionary-public` (required,string) - The name of a dictionary
     + offset: 0 (number) - Start of search results
     + limit: 10 (number) - Number of search results
     + filter: user=Val (string) - restrict search results
     + sort: created_at (string) - Field for sorting results
     + results: sign (string) - Type of results: entries, sign, term, terms

#### retrieve dictionary results of searching [GET]

+ Request dictionary query results

     + Headers

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

     + Body

            null

+ Response 200 (text/plain)

     + Body

            {
              "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 [/dictionary/{name}/search/id/{id}{?offset,limit,filter,sort,results}]
Specific entries for dictionary

+ Parameters

     + name: `ase-US-dictionary-public` (string) - The name of an dictionary
     + id: 1-4,5 (string) - A list of one or more id numbers
     + offset: 0 (number) - Start of search results
     + limit: 10 (number) - Number of search results
     + filter: user=Val (string) - restrict search results
     + sort: created_at (string) - Field for sorting results
     + results: sign (string) - Type of results: entries, sign, term, terms

#### retrieve dictionary entry [GET]

+ Request an dictionary entry

     + Headers

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

     + Body

            null

+ Response 200 (text/plain)

     + Body

            [
              {
                "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 [/dictionary/{name}/search/sign/{query}{?offset,limit,filter,sort,results}]
Query string access to dictionary signs

+ Parameters

     + name: `ase-US-dictionary-public` (required,string) - The name of a dictionary
     + query: Q (required,string) - A query string
     + offset: 0 (number) - Start of search results
     + limit: 10 (number) - Number of search results
     + filter: user=Val (string) - restrict search results
     + sort: created_at (string) - Field for sorting results
     + results: sign (string) - Type of results: entries, sign, term, terms

#### retrieve dictionary results of searching signs with query string [GET]

+ Request dictionary query results

     + Headers

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

     + Body

            null

+ Response 200 (text/plain)

     + Body

            {
              "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 [/dictionary/{name}/search/signtext/{query}{?offset,limit,filter,sort,results}]
Query string access to dictionary signtexts

+ Parameters

     + name: `ase-US-dictionary-public` (required,string) - The name of a dictionary
     + query: Q (required,string) - A query string
     + offset: 0 (number) - Start of search results
     + limit: 10 (number) - Number of search results
     + filter: user=Val (string) - restrict search results
     + sort: created_at (string) - Field for sorting results
     + results: sign (string) - Type of results: entries, signtext, term, terms

#### retrieve dictionary results of searching signtexts with query string [GET]

+ Request dictionary query results

     + Headers

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

     + Body

            null

+ Response 200 (text/plain)

     + Body

            {
              "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 [/dictionary/{name}/search/terms/{text}{?type,case,offset,limit,filter,sort,results}]
Search dictionary terms for text

+ Parameters

     + name: `ase-US-dictionary-public` (required,string) - The name of an dictionary
     + text: `SignPuddle` (required,string) - The text for searching
     + type: exact (string) - Type of search of start, end, or exact
     + case: 0 (number) - Case sensitive search
     + offset: 0 (number) - Start of search results
     + limit: 10 (number) - Number of search results
     + filter: user=Val (string) - restrict search results
     + sort: created_at (string) - Field for sorting results
     + results: sign (string) - Type of results: entries, sign, term, terms

#### retrieve matching entries [GET]

+ Request matching dictionary entries

     + Headers

            Pass: 724fd4b4438fba9d0c5ab89d0833e5c9

     + Body

            null

+ Response 200 (text/plain)

     + Body

            {
              "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 [/dictionary/{name}/alphabet{?update}]
Create alphabet from dictionary signs

+ Parameters

     + name: `ase-US-dictionary-public` (required,string) - The name of an dictionary
     + update: 1 (optional,number) - Forces a rewrite of the alphabet

#### generate alphabet from dictionary contents [GET]

+ Request dictionary query results

     + Headers

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

     + Body

            null

+ Response 200 (text/plain)

     + Body

            {"name": "ase-US-alphabet-public","data": []}

## Group tools
Resources related to tools

+ Source: [ApiTxt format](../src/tools.txt) and [JSON objects](../src/tools.json)
+ Documents: [API Blueprint](../doc/tools.md) and [Stand Alone HTML](../doc/tools.htm)
+ Live Page: [API Interface](../api/tools.html) and [JavaScript](../api/tools.js)

### tools index [/tools/]

#### Get the tools index [GET]

+ Response 200 (text/plain)

     + Body

            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 [/tools/define]

The definition tree for character mapping

#### Get main define [GET]

+ Response 200 (text/plain;charset=utf-8)

     + Body

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

### Section definition [/tools/define/{section}]

A section of the definition tree

+ Parameters

     + section: fsw (string) - The name of section

#### Get section define [GET]

+ Response 200 (text/plain;charset=utf-8)

     + Body

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

### Part definition [/tools/define/{section}/{part}]

A part of the section definition

+ Parameters

     + section: swu (string) - The name of section
     + part: symbol (string) - The part of the definition

#### Get part define [GET]

+ Response 200 (text/plain;charset=utf-8)

     + Body

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

### Parse text [/tools/parse{?text,utf}]

A function to analyze text and parse it into individual components

+ Parameters

     + text: S10000 (string) - The text to parse
     + utf: 32 (string) - The UTF number of 8, 16, 32 or 'x'

#### Get parse results [GET]

+ Response 200 (text/plain;charset=utf-8)

     + Body

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

### Encode text [/tools/encode{?text,slash}]

A function to encode SignWriting in Unicode (SWU) as UTF-16

+ Parameters

     + text: 𝠀񆄱񈠣񍉡𝠃𝤛𝤵񍉡𝣴𝣵񆄱𝤌𝤆񈠣𝤉𝤚 (string) - The text to encode
     + slash: 1 (number) - The number of slashes for escaping

#### Get encoded query string [GET]

+ Response 200 (text/plain;charset=utf-8)

     + Body

            \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 [/tools/decode{?text}]

A function to decode SignWriting in Unicode (SWU) from UTF-16

+ Parameters

     + text: \\uD836\\uDC00 (string) - The text to decode

#### Get decoded query string [GET]

+ Response 200 (text/plain;charset=utf-8)

     + Body

            𝠀

### UTF-8 encode text [/tools/utf8{?text}]

+ Parameters

     + text: 𝠀񆄱񈠣񍉡𝠃𝤛𝤵񍉡𝣴𝣵񆄱𝤌𝤆񈠣𝤉𝤚 (string) - The text to encode

#### Get utf-8 encoded query string [GET]

+ Response 200 (text/plain;charset=utf-8)

     + Body

            %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 [/tools/test{?text,opt1,opt2}]

A general purpose function for testing

+ Parameters

     + text: S10000 (string) - Input for testing
     + opt1: AS (string) - Option one for testing
     + opt2: AS (string) - Option two for testing

#### Get test results [GET]

+ Response 200 (text/plain;charset=utf-8)

     + Body

            test output

## Group FSW
Resources related to Formal SignWriting in ASCII (FSW)

+ Source: [ApiTxt format](../src/fsw.txt) and [JSON objects](../src/fsw.json)
+ Documents: [API Blueprint](../doc/fsw.md) and [Stand Alone HTML](../doc/fsw.htm)
+ Live Page: [API Interface](../api/fsw.html) and [JavaScript](../api/fsw.js)

### FSW Word [/fsw{?text,style}]

+ Parameters

     + text: AS20310S26b02S33100M521x547S33100482x483S20310506x500S26b02503x520 (string) - The name of sign
     + style: true (boolean,optional) - Flag to include styling string

#### First FSW string [GET]

+ Request one Formal SignWriting in ASCII string

     + Body

            null

+ Response 200 (text/plain;charset=utf-8)

     + Body

            AS20310S26b02S33100M521x547S33100482x483S20310506x500S26b02503x520

### FSW Text [/fsw/all{?text,style}]

+ Parameters

     + text: AS20310S26b02S33100M521x547S33100482x483S20310506x500S26b02503x520 (string) - The name of sign
     + style: 1 (number) - Flag to include styling string

#### All FSW strings [GET]

+ Request many Formal SignWriting in ASCII string

     + Body

            null

+ Response 200 (text/plain;charset=utf-8)

     + Body

            AS20310S26b02S33100M521x547S33100482x483S20310506x500S26b02503x520

### FSW to SWU [/fsw/swu{?text}]

+ Parameters

     + text: AS20310S26b02S33100M521x547S33100482x483S20310506x500S26b02503x520 (string) - The name of sign

#### Text with FSW strings [GET]

+ Request SWU conversion of FSW string

     transformation from ASCII to Unicode characters.

     + Body

            null

+ Response 200 (text/plain;charset=utf-8)

     requires font SuttonSignWritingOneD

     + Body

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

### SVG image [/fsw/svg/{text}]

Create a stand-alone SVG image using Formal SignWriting in ASCII (FSW)

+ Parameters

     + text: AS20310S26b02S33100M521x547S33100482x483S20310506x500S26b02503x520 (string) - The name of sign

#### Retrieve stand alone SVG image [GET]

+ Request collection text

     + Body

            null

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

     + Body

            <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 [/fsw/svg/font/{text}]

Create an SVG with font using Formal SignWriting in ASCII (FSW)

+ Parameters

     + text: AS20310S26b02S33100M521x547S33100482x483S20310506x500S26b02503x520 (string) - The name of sign

#### Retrieve SVG with font [GET]

+ Request collection text

     + Body

            null

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

     + Body

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

## Group swu
Resources related to Formal SignWriting in ASCII (SWU)

+ Source: [ApiTxt format](../src/swu.txt) and [JSON objects](../src/swu.json)
+ Documents: [API Blueprint](../doc/swu.md) and [Stand Alone HTML](../doc/swu.htm)
+ Live Page: [API Interface](../api/swu.html) and [JavaScript](../api/swu.js)

### SWU Word [/swu{?text,style}]

+ Parameters

     + text: 𝠀񆄱񈠣񍉡𝠃𝤛𝤵񍉡𝣴𝣵񆄱𝤌𝤆񈠣𝤉𝤚 (string) - The name of sign
     + style: 1 (number) - Flag to include styling string

#### first SWU string [GET]

+ Request one Formal SignWriting in ASCII string

     + Body

            null

+ Response 200 (text/plain;charset=utf-8)

     + Body

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

### SWU Text [/swu/all{?text,style}]

+ Parameters

     + text: 𝠀񆄱񈠣񍉡𝠃𝤛𝤵񍉡𝣴𝣵񆄱𝤌𝤆񈠣𝤉𝤚 (string) - The name of sign
     + style: 1 (number) - Flag to include styling string

#### all SWU strings [GET]

+ Request many Formal SignWriting in ASCII string

     + Body

            null

+ Response 200 (text/plain;charset=utf-8)

     + Body

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

### SWU to FSW [/swu/fsw{?text}]

+ Parameters

     + text: 𝠀񆄱񈠣񍉡𝠃𝤛𝤵񍉡𝣴𝣵񆄱𝤌𝤆񈠣𝤉𝤚 (string) - The name of sign

#### text with SWU strings [GET]

+ Request original text with Formal SignWriting in ASCII inside

     + Body

            null

+ Response 200 (text/plain;charset=utf-8)

     + Body

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

### SVG image [/swu/svg/{text}]

Create a stand-alone SVG image using Formal SignWriting in ASCII (SWU)

+ Parameters

     + text: 𝠀񆄱񈠣񍉡𝠃𝤛𝤵񍉡𝣴𝣵񆄱𝤌𝤆񈠣𝤉𝤚 (string) - The name of sign

#### retrieve stand-alone SVG image [GET]

+ Request collection text

     + Body

            null

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

     + Body

            <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 [/swu/svg/font/{text}]

Create an SVG with font using Formal SignWriting in ASCII (SWU)

+ Parameters

     + text: 𝠀񆄱񈠣񍉡𝠃𝤛𝤵񍉡𝣴𝣵񆄱𝤌𝤆񈠣𝤉𝤚 (string) - The name of sign

#### retrieve SVG with font [GET]

+ Request collection text

     + Body

            null

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

     + Body

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

## Group apitxt
ApiTxt uses eleven types of element to define an API.

root, group, route, parameter, method, request, response, header, line, code, and body.

+ Source: [ApiTxt format](../src/apitxt.txt) and [JSON objects](../src/apitxt.json)
+ Documents: [API Blueprint](../doc/apitxt.md) and [Stand Alone HTML](../doc/apitxt.htm)
+ Live Page: [API Interface](../api/apitxt.html) and [JavaScript](../api/apitxt.js)

### root [/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


#### Get root definition [GET]
Every document should start with a root element.

**root line**

root &lt;TAB> name &lt;TAB> title &lt;TAB> host

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

**root example**

root &lt;TAB> apitxt &lt;TAB> ApiTxt &lt;TAB> https://signpuddle.com/apitxt


**root line relationships**

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

**root object**

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


+ Request the root definition

     + Body

            null

+ Response 200 (text/plain)

     + Body

            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 [/apitxt/group]

#### Get group definition [GET]
The group organizes resources into sections

**group line**

group &lt;TAB> name &lt;TAB> description

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

**group example**

group &lt;TAB> Section name &lt;TAB> an example section

**group line relationships**

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

**group object**

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


+ Request the group definition

     + Body

            null

+ Response 200 (text/plain)

     + Body

            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 [/apitxt/route]

#### Get route definition [GET]
The route element allows access to a resource

**route line**

route &lt;TAB> URI template &lt;TAB> name &lt;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 &lt;TAB> /example &lt;TAB> an example route &lt;TAB> 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": []
}
```


+ Request the route definition

     + Body

            null

+ Response 200 (text/plain)

     + Body

            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 [/apitxt/parameter]

#### Get parameter definition [GET]
The parameter element is applied to the previous route

**parameter line**

parameter &lt;TAB> name &lt;TAB> example &lt;TAB> type &lt;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 &lt;TAB> country_code &lt;TAB> US &lt;TAB> string &lt;TAB> 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]
    }
  ]
}
```


+ Request the parameter definition

     + Body

            null

+ Response 200 (text/plain)

     + Body

            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 [/apitxt/method]

#### Get method definition [GET]
The method element represents an action that can be performed on a route

**method line**

method &lt;TAB> HTTP method &lt;TAB> name &lt;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 &lt;TAB> GET &lt;TAB> Get an example &lt;TAB> 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 method definition

     + Body

            null

+ Response 200 (text/plain)

     + Body

            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 [/apitxt/request]

#### Get request definition [GET]
The request element is associated with a specific method and can be paired with multiple responses.

**request line**

request &lt;TAB> name &lt;TAB> type

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

**request example**

request &lt;TAB> matching text within request body &lt;TAB> plain/text

**request line relationships**

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

**request object**

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


+ Request the request definition

     + Body

            null

+ Response 200 (text/plain)

     + Body

            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 [/apitxt/response]

#### Get response definition [GET]
The response element is associated with a specific request, or associated with a specific method with an assumed generic request.

**response line**

response &lt;TAB> status &lt;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 &lt;TAB> 200 &lt;TAB> plain/text

**response line relationships**

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

**response object**

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


+ Request the response definition

     + Body

            null

+ Response 200 (text/plain)

     + Body

            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 [/apitxt/header]

#### Get header definition [GET]
The header element is applied to a preceding route

**header line**

header &lt;TAB> name &lt;TAB> value

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

**header example**

header &lt;TAB> X-Powered-By &lt;TAB> ApiTxt

**header object**

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


+ Request the header definition

     + Body

            null

+ Response 200 (text/plain)

     + Body

            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 [/apitxt/body]

#### Get body definition [GET]
The body element adds contents to a preceding request or response.

The text of the body is everything after the string "body &lt;TAB>".

+ Request the body definition

     + Body

            null

+ Response 200 (text/plain)

     + Body

            The body element adds contents to a preceding request or response.
            
            The text of the body is everything after the string "body <TAB>"

### line [/apitxt/line]

#### Get line definition [GET]
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 &lt;TAB>".

+ Request the line definition

     + Body

            null

+ Response 200 (text/plain)

     + Body

            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 [/apitxt/code]

#### Get code definition [GET]
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 &lt;TAB>".

+ Request the code definition

     + Body

            null

+ Response 200 (text/plain)

     + Body

            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>".