media-type-classes¶

Summary¶

GET /digital-boards/constants/media-type-classes

Description¶

Returns a list of media type classes for the media_type_class field on the digital_board object. This is used to determine what types of media are supported by the player software on this screen

Tags: digital-boards

Parameters¶

Header Parameters¶

Name	Type	Required	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)
media_type_classes (array)
Array items: object Type: object

Properties:
- class (string)
- class_name (string)
- class_description (string)

Example Response¶

{
    "success": true,
    "media_type_classes": [
        {
            "class": "App\\LuCore\\DigitalBoards\\MediaTypes\\ImageMediaTypeClass",
            "class_name": "Image",
            "class_description": "Supports jpg or png images"
        },
        {
            "class": "App\\LuCore\\DigitalBoards\\MediaTypes\\VideoMediaTypeClass",
            "class_name": "Video",
            "class_description": "Supports video"
        },
        {
            "class": "App\\LuCore\\DigitalBoards\\MediaTypes\\AudioMediaTypeClass",
            "class_name": "Audio",
            "class_description": "Supports audio on video files"
        },
        {
            "class": "App\\LuCore\\DigitalBoards\\MediaTypes\\HtmlMediaTypeClass",
            "class_name": "Html",
            "class_description": "Supports animated HTML files directly on the player"
        },
        {
            "class": "App\\LuCore\\DigitalBoards\\MediaTypes\\DynamicMediaTypeClass",
            "class_name": "Dynamic",
            "class_description": "Supports dynamic content"
        }
    ]
}

Example Implementations¶

Bash (cURL)¶

curl --request GET \
    --get "https://api.lucit.app/api/v3/digital-boards/constants/media-type-classes" \
    --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/media-type-classes"
);

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/media-type-classes',
    [
        '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/media-type-classes'
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,
    "media_type_classes": [
        {
            "class": "App\\LuCore\\DigitalBoards\\MediaTypes\\ImageMediaTypeClass",
            "class_name": "Image",
            "class_description": "Supports jpg or png images"
        },
        {
            "class": "App\\LuCore\\DigitalBoards\\MediaTypes\\VideoMediaTypeClass",
            "class_name": "Video",
            "class_description": "Supports video"
        },
        {
            "class": "App\\LuCore\\DigitalBoards\\MediaTypes\\AudioMediaTypeClass",
            "class_name": "Audio",
            "class_description": "Supports audio on video files"
        },
        {
            "class": "App\\LuCore\\DigitalBoards\\MediaTypes\\HtmlMediaTypeClass",
            "class_name": "Html",
            "class_description": "Supports animated HTML files directly on the player"
        },
        {
            "class": "App\\LuCore\\DigitalBoards\\MediaTypes\\DynamicMediaTypeClass",
            "class_name": "Dynamic",
            "class_description": "Supports dynamic content"
        }
    ]
}

← Back to digital-boards index | Back to main index