Characters
This resource will return to the user characters whose decimal code values are in the range specified. The characters can be returned as plain text, JSON, XML, HTML, CLOD or YAML. It is a good example of when an API returns a long list of data in the response data.
Resource
https://api.omegatower.net/toolbox/v1/characters
Methods Allowed
GET, HEAD
Available Response Representations
200 OK
- text/plain; charset=UTF-8
- text/html; charset=UTF-8
- application/xml
- application/json
- application/x-clod
- application/x-yaml
400 Bad Request
- text/plain; charset=UTF-8
- text/html; charset=UTF-8
- application/xml
- application/json
- application/x-clod
- application/x-yaml
Request Query Parameters
Test Mode
Sending the Test parameter will return to the user in the "test" section all the possible parameters with their current values. This can be used to verify that you are able to successfully connect to the resource. It will be returned formatted as defined by the Output parameter. If none is sent, "false" is assumed.
Output Parameter
This parameter defines how the characters are to be returned to the user. Values of "text", "verbose", "json", "xml", "html", "clod" or "yaml" are allowed. If none is sent, "text" is assumed.
Start Parameter
This parameter defines which Unicode character to start with. Values between 0 and 1,114,110 inclusive can be sent. If none is sent, 0 is assumed.
End Parameter
This parameter defines which Unicode character to end with. Values between 1 and 1,114,111 inclusive can be sent. If none is sent, 40 is assumed.
Decontrol Parameter
This parameter defines if the Unicode Control Sets C0, C1 and the DEL character are stripped from the characters returned. Allowed values are "true" or "false". If this parameter is not sent, "true" will be assumed.
Caution
Due to the nature of how various browsers will handle the control characters, using this parameter with it set to "false" from a browser may produce unpredictable results.
Schemas
JSON
{
"title": "Toolbox Resources Characters Schema",
"description": "Version 1.2.0.13",
"$schema": "http://json-schema.org/draft-07/schema#",
"$id": "https://toolbox.omegatower.net/schemas/v1/characters-schema.json",
"type": "object",
"additionalProperties": false,
"properties": {
"characters": {
"type": "object",
"additionalProperties": false,
"properties": {
"test": {
"type": "object",
"additionalProperties": false,
"properties": {
"parameter_test": {
"type": "boolean"
},
"parameter_output": {
"type": "string"
},
"parameter_start": {
"type": "integer"
},
"parameter_end": {
"type": "integer"
},
"parameter_decontrol": {
"type": "boolean"
}
}
},
"data": {
"type": "object",
"properties": {
"item": {
"type": "array",
"items": {
"type": "object",
"properties": {
"code": {
"type": "integer"
},
"character": {
"type": "string"
}
},
"additionalProperties": false,
"required": [
"code",
"character"
]
},
"additionalItems": false
}
},
"additionalProperties": false
},
"error": {
"type": "object",
"additionalProperties": false,
"properties": {
"title": {
"type": "string"
},
"detail": {
"type": "string"
},
"resource_server": {
"type": "string"
},
"type": {
"type": "integer"
},
"source": {
"type": "string"
}
}
},
"links": {
"type": "object",
"additionalProperties": false,
"properties": {
"about": {
"type": "string",
"format": "uri"
},
"openapi": {
"type": "string",
"format": "uri"
},
"swaggerhub": {
"type": "string",
"format": "uri"
},
"wadl": {
"type": "string",
"format": "uri"
},
"describedby": {
"type": "string"
}
},
"required": [
"about",
"openapi",
"swaggerhub",
"wadl"
]
}
},
"required": [
"test",
"data",
"error",
"links"
]
}
},
"required": [
"characters"
]
}
XML
<?xml version="1.0" encoding="utf-8" ?>
<!-- Toolbox Resources Characters Schema, Version 1.2.0.13 -->
<xs:schema xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" attributeFormDefault="unqualified" elementFormDefault="qualified" xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:element name="characters">
<xs:complexType>
<xs:sequence>
<xs:element name="test" minOccurs="1" maxOccurs="1">
<xs:complexType>
<xs:sequence minOccurs="0">
<xs:element name="parameter_test" type="xs:boolean" minOccurs="1" maxOccurs="1" />
<xs:element name="parameter_output" type="xs:token" minOccurs="1" maxOccurs="1" />
<xs:element name="parameter_start" type="xs:nonNegativeInteger" minOccurs="1" maxOccurs="1" />
<xs:element name="parameter_end" type="xs:nonNegativeInteger" minOccurs="1" maxOccurs="1" />
<xs:element name="parameter_decontrol" type="xs:boolean" minOccurs="1" maxOccurs="1" />
</xs:sequence>
</xs:complexType>
</xs:element>
<xs:element name="data" minOccurs="1" maxOccurs="1">
<xs:complexType>
<xs:sequence minOccurs="0">
<xs:element name="item" minOccurs="1" maxOccurs="unbounded">
<xs:complexType>
<xs:sequence>
<xs:element name="code" type="xs:nonNegativeInteger" minOccurs="1" maxOccurs="1" />
<xs:element name="character" type="xs:token" minOccurs="1" maxOccurs="1" />
</xs:sequence>
</xs:complexType>
</xs:element>
</xs:sequence>
</xs:complexType>
</xs:element>
<xs:element name="error" minOccurs="1" maxOccurs="1">
<xs:complexType>
<xs:sequence minOccurs="0">
<xs:element name="title" type="xs:string" minOccurs="1" maxOccurs="1" />
<xs:element name="detail" type="xs:string" minOccurs="1" maxOccurs="1" />
<xs:element name="resource_server" type="xs:anyURI" minOccurs="1" maxOccurs="1" />
<xs:element name="type" type="xs:unsignedByte" minOccurs="1" maxOccurs="1" />
<xs:element name="source" type="xs:token" minOccurs="1" maxOccurs="1" />
</xs:sequence>
</xs:complexType>
</xs:element>
<xs:element name="links" minOccurs="1" maxOccurs="1">
<xs:complexType>
<xs:sequence minOccurs="0">
<xs:element name="about" type="xs:anyURI" minOccurs="1" maxOccurs="1" />
<xs:element name="openapi" type="xs:anyURI" minOccurs="1" maxOccurs="1" />
<xs:element name="swaggerhub" type="xs:anyURI" minOccurs="1" maxOccurs="1" />
<xs:element name="wadl" type="xs:anyURI" minOccurs="1" maxOccurs="1" />
<xs:element name="describedby" type="xs:anyURI" minOccurs="1" maxOccurs="1" />
</xs:sequence>
</xs:complexType>
</xs:element>
</xs:sequence>
</xs:complexType>
</xs:element>
</xs:schema>
