User Tools

Site Tools


api:flexcare:stbprofile:list

API : FlexCare : STB-profile : List

Introduction

This request is used to get a list of profiles used by STB devices

Request

URL https://api.telecomx.dk/flexcare/stbprofile
Method GET
Access level RESELLER_ADMIN
Query offset [optional] Index of the first profile to return, default is 0.
limit [optional] The number of profiles to return, default is 100
filter [optional] Used to filter list of profiles
Fields searched: [name]

Query examples

https://api.telecomx.dk/flexcare/stbprofile
https://api.telecomx.dk/flexcare/stbprofile?offset=25&limit=50&filter=something

Response

JSON Object
offset Number Index of the first profile returned
limit Number Limit of profiles returned
total Number Total amount of profiles
profiles Array<STBProfileListObject> List of profiles
STBProfileListObject
_id ObjectId Unique id of the language
name String Name of the profile
devices Number Number of devices with the profile

Example

{
    offset: 0,
    limit: 50,
    total: 2,
    profiles: [
        {
            _id: '1234567890qwertyuiopqwer',
            name: 'Min profil',
            devices: 2
        }
    ]
}

Errors

Error code Message Description
403 access_denied Insufficient access level
500 internal_error <Unspecified>
api/flexcare/stbprofile/list.txt · Last modified: 2025/10/31 10:32 by Mikkel Frederiksen

Donate Powered by PHP Valid HTML5 Valid CSS Driven by DokuWiki