Accessibility Layer

1 INTRODUCTION

Ariadna Servicios Informáticos S.L. (ASI) has developed an API to use the Accessibility Layer that unifies the following accessibility services:

The API is now on its version 2.1.

The version 2.0 of the Accessibility Layer has been developed using the PHP language and runs over an Apache Server. The reason of this change comes from the difficulty of some of the project partners who could not connect to the Accessibility Layer because the previous version (1.0), developed in J2EE over Tomcat was listening on port 8080 and their firewall did not allow them to connect to our service.

The Accessibility Layer now runs over the port 80.

You can also download the API documentation in .docx format.

2 RESOURCES

The API provides three different resources. Each of them supports different languages so in the Table 1 you can see which languages supports each of them.

All of them are now available below the API Root: http://al.abletoinclude.eu.

Table 1. Language support.
English Spanish Dutch French
Simplext Yes Yes No No
Text2Picto Yes Yes Yes No
Text2Speech Yes Yes Yes Yes

In the following subsections, you can find how to use each of the services provided by the Accessibility Layer.

Note that the parameters between brackets are optional.

2.1 SIMPLEXT

To run this service, the developer needs to indicate the parameters text and language which can have the values indicated between the < and > signs.

The service will return a response with an empty pictos list and an empty audioSpeech value.

Table 2. Simplext resource.
Path <API Root>/Simplext.php
Method GET
Parameters text <The input text you want to simplify>
language <english|spanish>
Response
{
  "textInput":"Se registraron en España un total de 451 agresiones a facultativos.",
  "textSimplified":"Se registraron en España un total de 451 agresiones a médicos.",
  "pictos":[],
  "audioSpeech":"",
  "status":200
}

2.2 TEXT2PICTO

To run this service, the developer needs to indicate the parameters text, language and type which can have the values indicated between the < and > signs.

The type indicates the pictogram base selected.

The service will return a response with an empty textSimplified and an empty audioSpeech value.

Table 3. Text2Picto resource.
Path <API Root>/Text2Picto.php
Method GET
Parameters text <The input text you want to convert to pictograms>
language <dutch|english|spanish>
type <beta|sclera>
[parallel] <true|false> (new in version 2.1)
Response
{
  "textInput":"Hello world",
  "textSimplified":"",
  "pictos":[
    "http:\/\/webservices.ccl.kuleuven.be\/picto\/sclera\/hallo-zeggen-2.png",
    "http:\/\/webservices.ccl.kuleuven.be\/picto\/sclera\/aarde-3.png",
    "\n",
    "\n"],
  "audioSpeech":"",
  "status":200
}
Response (parallel)
{
  "input": "hello world.",
  "output": [
    [
      "http://webservices.ccl.kuleuven.be/picto/sclera//hallo-zeggen-2.png",
      "hello"
    ],
    [
      "http://webservices.ccl.kuleuven.be/picto/sclera//aarde-3.png",
      "world"
    ],
    "\n",
    "\n"
  ]
}

2.3 TEXT2SPEECH

To run this service, the developer needs to indicate the parameters text and language which can have the values indicated between the < and > signs.

The service will return a response with an empty pictos list and an empty textSimplified value.

Table 4. Text2Speech resource.
Path <API Root>/Text2Speech.php
Method GET
Parameters text <The input text you want to convert to pictograms>
language <english|spanish|french>
Response
{
      "textInput":"Good morning",
      "textSimplified":"",
      "pictos":[],
      "audioSpeech":"http:\/\/able2include.teamnet.ro:8090\/
    AudioFiles\/3c1tqgevlih2wli3.mp4",
      "status":200
    }

3 ERRORS

The Table 5 presents the possible error codes that the Accessibility Layer can return and their description.

Table 5. Error codes.
Code Error description
200 Everything OK
408 Exceed the maximum time
451 No InputText has been introduced
452 No Language has been introduced
453 No Picto database has been introduced
454 No InputText or Language has been introduced
455 No Inputtext, Language or Picto database has been introduced
456 No Language or Picto database has been introduced
457 No Inputtext or Picto database has been introduced
458 Language is not valid
459 Picto database is not valid
460 (new in version 2.1) Parallel indicator must be "true" or "false".