Table of Contents

API : FlexCare : Dialog : Profiles : List

Introduction

This request is used to retrieve a list of profiles used in the Dialog application

Request

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

Query examples

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

Response

JSON Object
offset Number Index of the first profile returned
limit Number Limit of items returned
total Number Total amount of profile
items Array<ProfileListObject> List of profiles
ProfileListObject
_id ObjectId Unique id of the profile
name StringĀ  Name of profile
allLanguages Boolean If true profile has all languages
totalLicenses Number Amount of licenses on profile
languages Array<ObjectId> List of unique language ids

Example

{
    offset: 0,
    limit: 50,
    total: 2,
    items: [
        {
            _id: '1234567890qwertyuiopqwer',
            name: 'My profile',
            languages: [
                '1234567890qwertyuiopqwer',
                '1234567890qwertyuiopqwer'
            ],
            totalLicenses: 0,
            allLanguages: false
        },
        {
            _id: '1234567890qwertyuiopqwer',
            name: 'My profile',
            languages: [],
            totalLicenses: 10,
            allLanguages: true
        }
    ]
}

Errors

Error code Message Description
403 access_denied Insufficient access level
500 internal_error <Unspecified>