# SystemsX
Documentation and Guides for SystemsX Products.
# API Create Job
##
## Create a Booking Job
`POST` `/external/deploy/booking`
This endpoint allows the creation of a booking job. Either the `username` **or** the `email_address` parameter is required, but **only one** should be provided.
**Body**
Name
Type
Required
api_key
string
true
type
string
po,msc,tui
bookingReference
string
true
return_url
url
false
organisationName
string
required
agentName
string
required
bookingFields[]
array
true
bookingFields[username]
string
[username OR email_address]
bookingFields[email_address]
email
[username OR email_address]
bookingFields[password]
string
true
**Response**
{% tabs %}
{% tab title="200" %}
```json
{
"hash": "XXXXXXXXXXXXXXXXXXXXX"
}
```
{% endtab %}
{% tab title="400" %}
```json
{
"hash": "XXXXXXXXXXXXXXXXXXXXX",
"errors": [
"X field is Missing or Empty."
]
}
```
{% endtab %}
{% endtabs %}
{% tabs %}
{% tab title="return\_url Response" %}
```json
{
"hash": "XXXXXXXX",
"ImportDetail": {
"importRequest": {
"sourceReference": "",
"bookingReference" : "",
"bookingFields": [],
"returnUrl": "",
"api_key": "",
"type": ""
}
}
}
```
{% endtab %}
{% endtabs %}
# API Billing Usage
# API - Query Builder
Production API URL:
The API is focused towards POST requests however these can be GET requests also.
Ensure you are using `x-www-form-urlencoded` or `json` when sending requests.
## Query a table
`POST` `https://api.sense-ai.co.uk/v4/{tableName?}`
Leave table empty to view all available tables and columns for selection.
**Body**
| Name | Type | Description |
| ------------ | ----------------- | --------------------------------------- |
| `api_key` | string (required) | API Key for account |
| `per_page` | number | Default: 20, Max: 100 |
| `page` | number | Default: 1 |
| `type` | string | `first` (One) or `get` (Many - Default) |
| `select` | array (required) | Array of columns to select |
| `conditions` | array | Array of conditions (see below) |
## Conditions
Conditions are how a query is built, for example a list of Calls made, but only ones that have a duration above 60 seconds would be;
```
['type' => 'where', 'column' => 'duration', 'operator' => '>', 'value' => 60]
```
Conditions are provided as an array allowing you to apply multiple conditions to a query.
Operators Supported: (=, !=, >, >=, <, <=)
**Example Payload**
{% tabs %}
{% tab title="New Email" %}
```json
{
"api_key": "",
"from_address": "staffmember@email.com",
"to_address": "client@email.com",
"cc": [
"another@email.com"
],
"subject": "Example Subjext",
"body": "HTML or Plain Text here",
"headers": [
"sense_client_id": 123456
]
}
```
{% endtab %}
{% tab title="Reply Email" %}
```json
{
"api_key": "",
"from_address": "staffmember@email.com",
"uid": "UNIQUE_ID_HERE",
"body": "HTML or Plain Text here"
}
```
{% endtab %}
{% endtabs %}
**Response**
{% tabs %}
{% tab title="200" %}
```json
{
"status": "success"
}
```
{% endtab %}
{% tab title="400" %}
```json
{
"error": "Invalid request"
}
```
{% endtab %}
{% endtabs %}
# Common - Encode
## Encode Lat/Lng to GeoHash
`POST` `/api/common`
Returns the GeoHash for the lat/lng provided. If precision is auto, the result will be max 12 char length.\
The max precision of a GeoHash is based on the decimals of the initial Lat/Lng, for more precision ensure the Lat/Lng is the most accurate as possible.
**Body**
| Param | Value/Type | Description |
| --------- | ---------- | ----------- |
| function | 'encode' | Static |
| latitude | float | |
| precision | int | 0 = Auto |
**Response**
{% tabs %}
{% tab title="200" %}
```json
{
"geo_hash": "gbuw6fyprdsg"
}
```
{% endtab %}
{% tab title="400" %}
```json
{
"error": "Error Message Here"
}
```
{% endtab %}
{% endtabs %}
# Common - Decode
## Decode GeoHash to Lat/Lng
`POST` `/api/common`
Returns the Lat/Lng from a GeoHash based on the precision of the GeoHash.
**Body**
| Param | Value/Type | Description |
| --------- | ---------- | ----------- |
| function | 'decode' | Static |
| geo\_hash | string | |
**Response**
{% tabs %}
{% tab title="200" %}
```json
{
"latitude": float,
"longitude": float
}
```
{% endtab %}
{% tab title="400" %}
```json
{
"error": "Error Message Here"
}
```
{% endtab %}
{% endtabs %}
# Common - Neighbors
## GeoHash Neighbors
`POST` `/api/common`
Returns an array of geohash's for all neighbors from a starting neighbor until X radius.
**Body**
| Param | Value/Type | Description |
| --------- | ----------- | ----------- |
| function | 'neighbors' | Static |
| geo\_hash | string | |
| radius | int | \[Miles] |
| precision | int | 0 = Auto |
**Response**
{% tabs %}
{% tab title="200" %}
```json
["gbvqs","gbvqu","gbvqv","gbvqt","gbvqm","gbvqk","gbvq7","gbvqe","gbvqg","gbvrh","gbvrj","gbvr5","gbvrn","gbvqy","gbvqw","gbvqq","gbvqn","gbvqj","gbvqh","gbvq5","gbvq4","gbvq6","gbvqd","gbvqf","gbvr4","gbvrp","gbvqz","gbvqx","gbvqr","gbvqp","gbvmz","gbvmy","gbvmv","gbvmu","gbvmg","gbvmf","gbvmc","gbvq1","gbvq3","gbvq9","gbvqc","gbvr1","gbvwb","gbvw8","gbvw2","gbvw0","gbvq0","gbvq2","gbvq8","gbvqb","gbvw9","gbvw3"]
```
{% endtab %}
{% tab title="400" %}
```json
{
"error": "Error Message Here"
}
```
{% endtab %}
{% endtabs %}
# Common - Inside Polygon
## Location Inside Poly
`POST` `/api/common`
Returns results on if a location is inside a polygon or not. Recommended to use for high-level checking.
This specific endpoint does not auto-scale geohash precision, ensure your initial polygon points have precision or use another endpoint.
**Body**
| Param | Value/Type | Description |
| --------- | ---------- | ------------ |
| function | 'inside' | Static |
| points | array | |
| precision | int | Default is 6 |
| locations | array | |
**Example**
{% tabs %}
{% tab title="Input" %}
```json
{
.. other params
"points": [
[float, float],
[float, float],
[float, float],
[float, float],
...
],
"locations": [
{
"latitude": float,
"longitude": float
}
...
]
}
```
{% endtab %}
{% endtabs %}
**Response**
{% tabs %}
{% tab title="200" %}
```json
[
{
"latitude": float,
"longitude": float,
"is_inside": bool
}
...
]
```
{% endtab %}
{% tab title="400" %}
```json
{
"error": "Error Message Here"
}
```
{% endtab %}
{% endtabs %}
# Editor
GitBook has a powerful block-based editor that allows you to seamlessly create, update, and enhance your content.
### Writing content
GitBook offers a range of block types for you to add to your content inline — from simple text and tables, to code blocks and more. These elements will make your pages more useful to readers, and offer extra information and context.
Either start typing below, or press `/` to see a list of the blocks you can insert into your page.
# Markdown
GitBook supports many different types of content, and is backed by Markdown — meaning you can copy and paste any existing Markdown files directly into the editor!
Feel free to test it out and copy the Markdown below by hovering over the code block in the upper right, and pasting into a new line underneath.
```markdown
# Heading
This is some paragraph text, with a [link](https://docs.gitbook.com) to our docs.
## Heading 2
- Point 1
- Point 2
- Point 3
```
{% hint style="info" %}
If you have multiple files, GitBook makes it easy to import full repositories too — allowing you to keep your GitBook content in sync.
{% endhint %}
# Images & media
GitBook allows you to add images and media easily to your docs. Simply drag a file into the editor, or use the file manager in the upper right corner to upload multiple images at once.
Add alt text and captions to your images
{% hint style="info" %}
You can also add images simply by copying and pasting them directly into the editor — and GitBook will automatically add it to your file manager.
{% endhint %}
# Interactive blocks
In addition to the default Markdown you can write, GitBook has a number of out-of-the-box interactive blocks you can use. You can find interactive blocks by pressing `/` from within the editor.
### Tabs
{% tabs %}
{% tab title="First tab" %}
Each tab is like a mini page — it can contain multiple other blocks, of any type. So you can add code blocks, images, integration blocks and more to individual tabs in the same tab block.
{% endtab %}
{% tab title="Second tab" %}
Add images, embedded content, code blocks, and more.
```javascript
const handleFetchEvent = async (request, context) => {
return new Response({message: "Hello World"});
};
```
{% endtab %}
{% endtabs %}
### Expandable sections
Click me to expand
Expandable blocks are helpful in condensing what could otherwise be a lengthy paragraph. They are also great in step-by-step guides and FAQs.
### Drawings
### Embedded content
{% embed url="" %}
{% hint style="info" %}
GitBook supports thousands of embedded websites out-of-the-box, simply by pasting their links. Feel free to check out which ones[ are supported natively](https://iframely.com).
{% endhint %}
# OpenAPI
You can sync GitBook pages with an OpenAPI or Swagger file or a URL to include auto-generated API methods in your documentation.
### OpenAPI block
GitBook's OpenAPI block is powered by [Scalar](https://scalar.com/), so you can test your APIs directly from your docs.
{% openapi src="" path="/pet" method="post" %}
{% endopenapi %}
# Integrations
GitBook integrations allow you to connect your GitBook spaces to some of your favorite platforms and services. You can install integrations into your GitBook page from the *Integrations* menu in the top left.
### Types of integrations
