Table of Contents

API : FlexCare : STB-profile : Get

Introduction

This endpoint is used to retrieve information about a single STB-profile

Request

URL https://api.telecomx.dk/flexcare/stbprofile/PROFILE_ID
Method GET
Access level RESELLER_ADMIN, ADMIN
Params PROFILE_ID Unique id of the profile to retrieve

Query example

https://api.telecomx.dk/flexcare/stbprofile/1234567890qwertyuiopqwer

Response

STBProfile - JSON Object
_id ObjectId Unique id of the profile
name String Name of the profile
customer ObjectId Unique id of the customer owning this profile
groups Array<ObjectId> List of unique ids of groups from customers IpTvSettings
default Object Default settings for when new content is added to the profile
default.button Object Default settings for buttons
default.button.fontColor String Color of the button label
default.button.fontSize Number Font size of the button label
default.button.height Number Height of the icon of the button
default.button.width Number Width of the icon of the button
background Object Configuration for the background of the profile
background.id ObjectId Optional If set, is unique id of the image file
background.useDefault Boolean If true, background from IpTvSettings will be used
background.details Object Optional Details used by frontend to display image, details only returned if background.id is set
background.details.name String Name of the file chosen
background.details.url String URL pointing to image
logo Object Configuration for the logo of the profile
logo.id ObjectId Optional Unique id of the image file used as logo
logo.useDefault Boolean If true, logo from IpTvSettings will be used
logo.details Object Optional Details used by frontend to display image, details only returned if logo.id is set
logo.details.name String Name of the file chosen
logo.details.url String URL pointing to image
pages Array List of pages in the profile
pages[].name String Name of the page
pages[].applets Array List of applets on the page
pages[].applets[].buttonId String Local Id of the button, this id is only used internally in the profile
pages[].applets[].height Number Height of the icon of the button
pages[].applets[].width Number Width of the icon of the button
pages[].applets[].type String<TV, RADIO, INFOPAGE, INFOCOLLECTION, VIDEOLIST, WAVECARE, HELBREDSPROFILEN> Type of application to use for this applet
pages[].applets[].value String Optional If type is of other than [“TV”, “RADIO”] this will be the id of the content to be displayed in the application
pages[].applets[].icon Object Icon configuration for the icon
pages[].applets[].icon.id ObjectId Optional Unique id of the image used as icon
pages[].applets[].icon.details Object Optional Details used by frontend to display image, details only returned if pages[].applets[].icon.id is set
pages[].applets[].icon.details.name String Name of the file chosen
pages[].applets[].icon.details.url String URL pointing to image
pages[].applets[].label Object Configuration for the applet label
pages[].applets[].label.color String Color of the label
pages[].applets[].label.fontSize Number Font size of the label
pages[].applets[].label.text String Text in the label
pages[].applets[].position Object Position configuration of the applet
pages[].applets[].position.x Number X coordinate
pages[].applets[].position.y Number Y coordinate

Example

{
    _id: '1234567890qwertyuiopqwer',
    name: 'Min profil',
    customer: '1234567890qwertyuiopqwer',
    groups: ['1234567890qwertyuiopqwer'],
    background: {
        id: '1234567890qwertyuiopqwer',
        useDefault: false,
        details: {
            name: 'background.png',
            url: 'https://example.url.com/img/1234567890qwertyuiopqwer'
        }
    },
    default: {
        button: {
            fontColor: '#ffffff',
            fontSize: 18,
            height: 100,
            width: 100
        }
    },
    logo: {
        id: null,
        useDefault: true
    },
    pages: [
        {
            name: 'Forside',
            applets: [
                {
                    buttonId: '0_0',
                    height: 100,
                    type: 'TV',
                    value: null,
                    width: 100,
                    icon: {
                        id: '1234567890qwertyuiopqwer',
                        details: {
                            name: 'icon.png',
                            url: 'https://example.url.com/img/1234567890qwertyuiopqwer'
                        }
                    },
                    label: {
                        color: '#ffffff',
                        fontSize: 18,
                        text: 'Ny knap'
                    },
                    position: {
                        x: 100,
                        y: 200
                    }
                }
            ]
        }
    ]
}

Errors

Error code Message Description
403 access_denied Insufficient access level
404 not_found Profile not found
500 internal_error <Unspecified>