GET /api/v3/digital-boards/constants/facing-cardinals¶
Summary¶
GET /digital-boards/constants/facing-cardinals
Description¶
Returns a list of facing cardinals constants
This is used in the options.facing_cardinal field on the digital board object
From this options.facing_degrees is calculated automatically
Tags: digital-boards
Parameters¶
Header Parameters¶
| Name | Type | Required | Description | Example |
|---|---|---|---|---|
Authorization |
string |
✓ Yes | Bearer {AuthToken} |
|
Content-Type |
string |
✓ Yes | application/json |
|
Accept |
string |
✓ Yes | application/json |
|
AppIdV3 |
string |
✓ Yes | LCUID-LAP-********-****-****-****-************ |
Responses¶
Response: 200¶
Description: Sample Response
Content Type: application/json¶
Schema¶
Type: object
Properties:
success(boolean)facing_cardinals(array)-
Array items:
objectType:objectProperties:
number(integer)name(string)cardinal(string)degrees(integer)
Example Response¶
{
"success": true,
"facing_cardinals": [
{
"number": 0,
"name": "North",
"cardinal": "N",
"degrees": 0
},
{
"number": 1,
"name": "North by east",
"cardinal": "NbE",
"degrees": 11.25
},
{
"number": 2,
"name": "North-northeast",
"cardinal": "NNE",
"degrees": 22.5
},
{
"number": 3,
"name": "Northeast by north",
"cardinal": "NEbN",
"degrees": 33.75
},
{
"number": 4,
"name": "Northeast",
"cardinal": "NE",
"degrees": 45
},
{
"number": 5,
"name": "Northeast by east",
"cardinal": "NEbE",
"degrees": 56.25
},
{
"number": 6,
"name": "East-northeast",
"cardinal": "ENE",
"degrees": 67.5
},
{
"number": 7,
"name": "East by north",
"cardinal": "EbN",
"degrees": 78.75
},
{
"number": 8,
"name": "East",
"cardinal": "E",
"degrees": 90
},
{
"number": 9,
"name": "East by south",
"cardinal": "EbS",
"degrees": 101.25
},
{
"number": 10,
"name": "East-southeast",
"cardinal": "ESE",
"degrees": 112.5
},
{
"number": 11,
"name": "Southeast by east",
"cardinal": "SEbE",
"degrees": 123.75
},
{
"number": 12,
"name": "Southeast",
"cardinal": "SE",
"degrees": 135
},
{
"number": 13,
"name": "Southeast by south",
"cardinal": "SEbS",
"degrees": 146.25
},
{
"number": 14,
"name": "South-southeast",
"cardinal": "SSE",
"degrees": 157.5
},
{
"number": 15,
"name": "South by east",
"cardinal": "SbE",
"degrees": 168.75
},
{
"number": 16,
"name": "South",
"cardinal": "S",
"degrees": 180
},
{
"number": 17,
"name": "South by west",
"cardinal": "SbW",
"degrees": 191.25
},
{
"number": 18,
"name": "South-southwest",
"cardinal": "SSW",
"degrees": 202.5
},
{
"number": 19,
"name": "Southwest by south",
"cardinal": "SWbS",
"degrees": 213.75
},
{
"number": 20,
"name": "Southwest",
"cardinal": "SW",
"degrees": 225
},
{
"number": 21,
"name": "Southwest by west",
"cardinal": "SWbW",
"degrees": 236.25
},
{
"number": 22,
"name": "West-southwest",
"cardinal": "WSW",
"degrees": 247.5
},
{
"number": 23,
"name": "West by south",
"cardinal": "WbS",
"degrees": 258.75
},
{
"number": 24,
"name": "West",
"cardinal": "W",
"degrees": 270
},
{
"number": 25,
"name": "West by north",
"cardinal": "WbN",
"degrees": 281.25
},
{
"number": 26,
"name": "West-northwest",
"cardinal": "WNW",
"degrees": 292.5
},
{
"number": 27,
"name": "Northwest by west",
"cardinal": "NWbW",
"degrees": 303.75
},
{
"number": 28,
"name": "Northwest",
"cardinal": "NW",
"degrees": 315
},
{
"number": 29,
"name": "Northwest by north",
"cardinal": "NWbN",
"degrees": 326.25
},
{
"number": 30,
"name": "North-northwest",
"cardinal": "NNW",
"degrees": 337.5
},
{
"number": 31,
"name": "North by west",
"cardinal": "NbW",
"degrees": 348.75
}
]
}
Example Implementations¶
Bash (cURL)¶
curl --request GET \
--get "https://api.lucit.app/api/v3/digital-boards/constants/facing-cardinals" \
--header "Authorization: Bearer {AuthToken}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "AppIdV3: LCUID-LAP-********-****-****-****-************"
JavaScript (Fetch API)¶
const url = new URL(
"https://api.lucit.app/api/v3/digital-boards/constants/facing-cardinals"
);
const headers = {
"Authorization": "Bearer {AuthToken}",
"Content-Type": "application/json",
"Accept": "application/json",
"AppIdV3": "LCUID-LAP-********-****-****-****-************",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());
PHP (Guzzle)¶
$client = new \GuzzleHttp\Client();
$response = $client->get(
'https://api.lucit.app/api/v3/digital-boards/constants/facing-cardinals',
[
'headers' => [
'Authorization' => 'Bearer {AuthToken}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'AppIdV3' => 'LCUID-LAP-********-****-****-****-************',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
Python (Requests)¶
import requests
import json
url = 'https://api.lucit.app/api/v3/digital-boards/constants/facing-cardinals'
headers = {
'Authorization': 'Bearer {AuthToken}',
'Content-Type': 'application/json',
'Accept': 'application/json',
'AppIdV3': 'LCUID-LAP-********-****-****-****-************'
}
response = requests.request('GET', url, headers=headers)
response.json()
Example Responses¶
200 Response¶
{
"success": true,
"facing_cardinals": [
{
"number": 0,
"name": "North",
"cardinal": "N",
"degrees": 0
},
{
"number": 1,
"name": "North by east",
"cardinal": "NbE",
"degrees": 11.25
},
{
"number": 2,
"name": "North-northeast",
"cardinal": "NNE",
"degrees": 22.5
},
{
"number": 3,
"name": "Northeast by north",
"cardinal": "NEbN",
"degrees": 33.75
},
{
"number": 4,
"name": "Northeast",
"cardinal": "NE",
"degrees": 45
},
{
"number": 5,
"name": "Northeast by east",
"cardinal": "NEbE",
"degrees": 56.25
},
{
"number": 6,
"name": "East-northeast",
"cardinal": "ENE",
"degrees": 67.5
},
{
"number": 7,
"name": "East by north",
"cardinal": "EbN",
"degrees": 78.75
},
{
"number": 8,
"name": "East",
"cardinal": "E",
"degrees": 90
},
{
"number": 9,
"name": "East by south",
"cardinal": "EbS",
"degrees": 101.25
},
{
"number": 10,
"name": "East-southeast",
"cardinal": "ESE",
"degrees": 112.5
},
{
"number": 11,
"name": "Southeast by east",
"cardinal": "SEbE",
"degrees": 123.75
},
{
"number": 12,
"name": "Southeast",
"cardinal": "SE",
"degrees": 135
},
{
"number": 13,
"name": "Southeast by south",
"cardinal": "SEbS",
"degrees": 146.25
},
{
"number": 14,
"name": "South-southeast",
"cardinal": "SSE",
"degrees": 157.5
},
{
"number": 15,
"name": "South by east",
"cardinal": "SbE",
"degrees": 168.75
},
{
"number": 16,
"name": "South",
"cardinal": "S",
"degrees": 180
},
{
"number": 17,
"name": "South by west",
"cardinal": "SbW",
"degrees": 191.25
},
{
"number": 18,
"name": "South-southwest",
"cardinal": "SSW",
"degrees": 202.5
},
{
"number": 19,
"name": "Southwest by south",
"cardinal": "SWbS",
"degrees": 213.75
},
{
"number": 20,
"name": "Southwest",
"cardinal": "SW",
"degrees": 225
},
{
"number": 21,
"name": "Southwest by west",
"cardinal": "SWbW",
"degrees": 236.25
},
{
"number": 22,
"name": "West-southwest",
"cardinal": "WSW",
"degrees": 247.5
},
{
"number": 23,
"name": "West by south",
"cardinal": "WbS",
"degrees": 258.75
},
{
"number": 24,
"name": "West",
"cardinal": "W",
"degrees": 270
},
{
"number": 25,
"name": "West by north",
"cardinal": "WbN",
"degrees": 281.25
},
{
"number": 26,
"name": "West-northwest",
"cardinal": "WNW",
"degrees": 292.5
},
{
"number": 27,
"name": "Northwest by west",
"cardinal": "NWbW",
"degrees": 303.75
},
{
"number": 28,
"name": "Northwest",
"cardinal": "NW",
"degrees": 315
},
{
"number": 29,
"name": "Northwest by north",
"cardinal": "NWbN",
"degrees": 326.25
},
{
"number": 30,
"name": "North-northwest",
"cardinal": "NNW",
"degrees": 337.5
},
{
"number": 31,
"name": "North by west",
"cardinal": "NbW",
"degrees": 348.75
}
]
}