SignPuddle Network Guide

Available API resources: descriptions and parameters.

server

Server communication uses HTTP request methods and response statuses

GET /

The root response from the SignWriting Server is an HTML version of README.md.

GET /Guide.html

Guide.html documents the available API resources: descriptions and parameters.

GET /Example.html

Example.html contains example requests and documented responses.

GET /Run.html

Run.html contains example requests and real-time responses.

GET /README.md

The Readme file contains information about the SignWriting Server project.

GET /Guide.md

The Markdown version of the API Blueprint for the SignWriting Server.

GET /Example.md

The Example API calls using curl from the command line and collated into a document.

GET /Example.json

The Example API calls documented with JSON data.

GET /db/swserver

Download the main SignWriting Server database

GET /notFound

When a location is not found, a JSON error is returned.

svg

The svg groups creates SVG images that are stand-alone or that require the SignWriting 2010 fonts.

GET /svg/{text}

Individual signs and symbols are displayed in stand-alone SVG. An optional styling string can be used to adjust the output image.

  • Parameters
  • text
    (required) string text of symbol key or FSW string, with optional styling string.
GET /svg/font/{text}

Individual signs and symbols are displayed in SVG using TrueType fonts. An optional styling string can be used to adjust the output image.

  • Parameters
  • text
    (required) string text of symbol key or FSW string, with optional styling string.

regex

Query string to regular expression transformation.

GET /regex/{query}

Query strings can be transformed into regular expressions.

  • Parameters
  • query
    (required) string Formal SignWriting query string.
GET /regex/{flags}/{fsw}

Formal SignWriting can be transformed into regular expressions, depending on the flags supplied.

  • Parameters
  • flags
    (required) string Flags for FSW convertion to query string. 'A' - sorted by the same exact symbols. 'a' - sorted by the same general symbols. 'S' - spatial arrangement contains the same exact symbols. 's' - spatial arrangement contains the same general symbols. 'L' - location of spatial arrangement is similar.
    fsw
    (required) string Formal SignWriting string.

world

Interact with the countries of the world.

GET /world/svg

SVG for countries of the world.

GET /world/flag

Country Code and Flag image

GET /world/info

Languages and puddles by country.

GET /world/country/{code}

Country info by code

  • Parameters
  • code
    (required) string country code.
GET /world/country/{code}/other

Country info by code for other languages

  • Parameters
  • code
    (required) string country code.

puddle

Interact with collections of signs.

GET /puddle

A listing of all puddle collections available.

GET /puddle/language/{iso639}

A listing of all puddle collections available for specific sign language.

  • Parameters
  • iso639
    (required) string ISO 639-3 code for sign language.
GET /puddle/{puddle}

Information about a specific puddle by code or alternate

  • Parameters
  • puddle
    (required) string puddle code for collections or ISO 639-3 code for public ditionary.
GET /puddle/db/{puddle}

Download database for a specific puddle

  • Parameters
  • puddle
    (required) string puddle code for collection.
GET /puddle/{puddle}/query/{query}{?offset,limit,sort}

Search puddle collection with query.

  • Parameters
  • puddle
    (required) string puddle code for collections or ISO 639-3 code for public ditionary.
    query
    (required) string Formal SignWriting query string.
    offset
    number offset for results array.
    limit
    number limit the number of results. 0 for no limit, default of 100.
    sort
    number field for sorting results, prefix with minus for descending. Options: id, user, sign, created_at, updated_at.
GET /puddle/{puddle}/query/signtext/{query}{?offset,limit,sort}

Search puddle collection for SignText with query.

  • Parameters
  • puddle
    (required) string puddle code for collections or ISO 639-3 code for public ditionary.
    query
    (required) string Formal SignWriting query string.
    offset
    number offset for results array.
    limit
    number limit the number of results. 0 for no limit, default of 100.
    sort
    number field for sorting results, prefix with minus for descending. Options: id, user, sign, created_at, updated_at.
GET /puddle/{puddle}/query/{flags}/{fsw}{?offset,limit,sort}

Search puddle collection with Formal SignWriting and conversion flags.

  • Parameters
  • puddle
    (required) string puddle code for collections or ISO 639-3 code for public ditionary.
    flags
    (required) string Flags for FSW convertion to query string. 'A' - sorted by the same exact symbols. 'a' - sorted by the same general symbols. 'S' - spatial arrangement contains the same exact symbols. 's' - spatial arrangement contains the same general symbols. 'L' - location of spatial arrangement is similar.
    fsw
    (required) string Formal SignWriting string.
    offset
    number offset for results array.
    limit
    number limit the number of results. 0 for no limit, default of 100.
    sort
    number field for sorting results, prefix with minus for descending. Options: id, user, sign, created_at, updated_at.
GET /puddle/{puddle}/query/signtext/{flags}/{fsw}{?offset,limit,sort}

Search puddle collection for SignText with Formal SignWriting and conversion flags.

  • Parameters
  • puddle
    (required) string puddle code for collections or ISO 639-3 code for public ditionary.
    flags
    (required) string Flags for FSW convertion to query string. 'A' - sorted by the same exact symbols. 'a' - sorted by the same general symbols. 'S' - spatial arrangement contains the same exact symbols. 's' - spatial arrangement contains the same general symbols. 'L' - location of spatial arrangement is similar.
    fsw
    (required) string Formal SignWriting string.
    offset
    number offset for results array.
    limit
    number limit the number of results. 0 for no limit, default of 100.
    sort
    number field for sorting results, prefix with minus for descending. Options: id, user, sign, created_at, updated_at.
GET /puddle/{puddle}/search/{search}{?match,ci,offset,limit,sort}

Search puddle collection with string.

  • Parameters
  • puddle
    (required) string puddle code for collections or ISO 639-3 code for public ditionary.
    search
    (required) string search string.
    match
    string matching strategy: start, end, exact
    ci
    boolean case insensitive flag.
    offset
    number offset for results array.
    limit
    number limit the number of results. 0 for no limit, default of 100.
    sort
    number field for sorting results, prefix with minus for descending. Options: id, user, sign, created_at, updated_at.
GET /puddle/{puddle}/sign{?term,text,query,fsw,flags,source,offset,limit,sort}

Search puddle collection for signs using a variety of parameters.

  • Parameters
  • puddle
    (required) string puddle code for collections or ISO 639-3 code for public ditionary.
    term
    string search terms and titles.
    text
    string search extended text description.
    query
    string Formal SignWriting query string.
    fsw
    string Formal SignWriting string.
    flags
    string Flags for FSW convertion to query string. 'A' - sorted by the same exact symbols. 'a' - sorted by the same general symbols. 'S' - spatial arrangement contains the same exact symbols. 's' - spatial arrangement contains the same general symbols. 'L' - location of spatial arrangement is similar.
    source
    string search source field.
    offset
    number offset for results array.
    limit
    number limit the number of results. 0 for no limit, default of 100.
    sort
    number field for sorting results, prefix with minus for descending. Options: id, user, sign, created_at, updated_at.
GET /puddle/{puddle}/term{?term,text,query,fsw,flags,source,offset,limit,sort}

Search puddle collection for terms using a variety of parameters.

  • Parameters
  • puddle
    (required) string puddle code for collections or ISO 639-3 code for public ditionary.
    term
    string search terms and titles.
    text
    string search extended text description.
    query
    string Formal SignWriting query string.
    fsw
    string Formal SignWriting string.
    flags
    string Flags for FSW convertion to query string. 'A' - sorted by the same exact symbols. 'a' - sorted by the same general symbols. 'S' - spatial arrangement contains the same exact symbols. 's' - spatial arrangement contains the same general symbols. 'L' - location of spatial arrangement is similar.
    source
    string search source field.
    offset
    number offset for results array.
    limit
    number limit the number of results. 0 for no limit, default of 100.
    sort
    number field for sorting results, prefix with minus for descending. Options: id, user, sign, created_at, updated_at.
GET /puddle/{puddle}/created{?before,after,offset,limit,sort}

Search puddle collection based on creation.

  • Parameters
  • puddle
    (required) string puddle code for collections or ISO 639-3 code for public ditionary.
    before
    string date time string
    after
    string date time string
    offset
    number offset for results array.
    limit
    number limit the number of results. 0 for no limit, default of 100.
    sort
    number field for sorting results, prefix with minus for descending. Options: id, user, sign, created_at, updated_at.
GET /puddle/{puddle}/updated{?before,after,offset,limit,sort}

Search puddle collection based on updates.

  • Parameters
  • puddle
    (required) string puddle code for collections or ISO 639-3 code for public ditionary.
    before
    string date time string
    after
    string date time string
    offset
    number offset for results array.
    limit
    number limit the number of results. 0 for no limit, default of 100.
    sort
    number field for sorting results, prefix with minus for descending. Options: id, user, sign, created_at, updated_at.
GET /puddle/{puddle}/entry/{id}{?sort}

Listing from puddle collection based on entry id.

  • Parameters
  • puddle
    (required) string puddle code for collections or ISO 639-3 code for public ditionary.
    id
    (required) string list of comma separated entry id numbers.
    sort
    number field for sorting results, prefix with minus for descending. Options: id, user, sign, created_at, updated_at.

user

Work in progress

GET /user/salt

User salt is required for user authentication. Passwords are mixed with the salt before they are sent to the server.