Get Service

Use this API, to get the serivce providers as per the request provided.

Resource Informations

Name	Value
Requires authentication?	Yes
Rate limited?	Yes

Request

Request headers

Key	Value
Authorization	Bearer token
Content-Type	application/json

HTTP request URL for SSMS

GET https://{tenantId}.{hostname}/digitanium/v3/mpower/services/?category=<CATEGORY>

HTTP request URL for SHIFT

GET https://{hostname}/auth/realms/{tenantId}/mpower/v1/services/?category={CATEGORY}

note

API requests must be made over https. Calls made over plain http will fail.

Parameters (*Required)

Field Name	Type	Description

• category | String | Category for which you wanted to get Service Providers. Possible values partner, backend, operator, information

Request body

No request body fields are required

Response

Field Name	Type	Description
version	Integer	Service provider version
category	String	Category to which service belong to
uuid	UUID	Unique ID of service provider
services	Array	List of services available
tags	String	Add respective tag category (Example : recommended).

services

Field Name	Type	Description
name	String	Name of the service
position	Integer	Position of service provider among the list
uuid	UUID	Unique ID of the service
type	String	Type of the service chat or miniapp or information
displayName	Object	Display name of the service. Can be localised.
description	Object	Description of the service. Can be localised.
openUrl	URL	Url of the service
avatarPicture	Object	Picture which should be displayed in app for the service.

Sample Response

{
    "version": 1,
    "category": "information",
    "uuid": "2221761a-9f91-4109-a778-b8ef372a5edc",
    "services": [
        {
            "name": "info2",
            "priority": 1.0,
            "position": 1,
            "uuid": "bc3fd095-9bb0-4c9c-96ea-e6600fadcffc",
            "type": "InformationApp",
            "displayName": {
                "de": "Info 2"
            },
            "description": {
                "de": "Info 2"
            },
            "openUrl": "https://google.com",
            "informationPicture": {
                "mimetype": "image/jpeg",
                "data": "test from API"
            },
            "communicationType": "person2service",
            "version": 1,
            "tags": [
                "operator1",
                "recommended1"
            ]
        },
        {
            "name": "info2",
            "priority": 0.66667,
            "position": 2,
            "uuid": "cb70acf8-4ec2-4c7b-81bf-2acfd4a4a6d4",
            "type": "InformationApp",
            "displayName": {
                "de": "Info 2"
            },
            "description": {
                "de": "Info 2"
            },
            "openUrl": "https://google.com",
            "informationPicture": {
                "mimetype": "image/jpeg",
                "data": "test from API"
            },
            "communicationType": "person2service",
            "version": 1,
            "tags": [
                "operator1",
                "recommended1"
            ]
        },
        {
            "name": "info2",
            "priority": 0.33333,
            "position": 3,
            "uuid": "14af364d-1987-447a-b966-cd14efb6d715",
            "type": "InformationApp",
            "displayName": {
                "de": "Info Mod"
            },
            "description": {
                "de": "Info Mod"
            },
            "openUrl": "https://www.kobil.com",
            "informationPicture": {
                "mimetype": "image/jpeg",
                "data": "test from API"
            },
            "communicationType": "person2service",
            "version": 1,
            "tags": [
                "tag1",
                "test1"
            ]
        }
    ]
}

Response Status Information

Status	Type	Description
200	OK	For successfull update
400	status	Bad request
401	status	Unauthorized