Temenos Digital
Updated On 24 March 2024 | Min(s) read

Service Definition

With Service Definitions, the credit unions/FIs can categorize their customer base into different segments of users, such as Retail, Sole Proprietor, Partnership, LLC, and so on. The system also provides the flexibility to configure these segments. Through these classifications, a bank can offer a set of features, feature actions, set limits against these features, and customize the offerings.

Name Description Introduced In
getServiceDefinitionRoles This API allows the user to get the service definition roles. 2021.01
getServiceDefinitionsForContracts This API allows the user to get the service definitions for contracts. 2021.01
getServicedefinitionAndRoleFeatures This API allows the user to get the service definition and role features. 2021.01
Object Data Model This Object Data Model describes the parameter name and other attribute details for Service Definition.  
 
Description: This API allows the user to get the service definition roles.
Method: POST
URL: {base_url}/services/data/v1/ExternalUserManagement/operations/serviceDefinition/getServiceDefinitionRoles
Security Level: Authenticated App Users
Header Request: X-Kony-Authorization
Body Request:

Parameters

serviceDefinitionId (Mandatory)

Specifies the unique ID of the service definition.

{

                "serviceDefinitionId":"5801fa32-a416-45b6-af01-b22e2de93777",

}
Response:

Parameters(Mandatory)

roles

Specifies an array of roles and their corresponding details.

roles/isDefaultGroup

Specifies whether the group is set as default. The value is Boolean.

roles/name

Specifies the name of the role.

roles/description

Specifies the description of the role.

roles/typeId

Specifies the unique ID of the type of the role (Retail/Business).

roles/id

Specifies the unique ID of the role.

roles/status

Specifies the status of the role (Active/Inactive).

{
    "roles": [{
        "isDefaultGroup": "false",
        "name": "Europe Customers Group",
        "description": "All customers created for online and Mobile Banking in the Europe region will be assigned to this group automatically",
        "typeId": "TYPE_ID_RETAIL",
        "id": "DEFAULT_EUROPE_GROUP",
        "status": "SID_ACTIVE"
    }, {
        "isDefaultGroup": "true",
        "name": "Default Group",
        "description": "All customers created for Online and Mobile Banking application demos",
        "typeId": "TYPE_ID_RETAIL",
        "id": "DEFAULT_GROUP",
        "status": "SID_ACTIVE"
    }, {
        "isDefaultGroup": "false",
        "name": "Digital Banking Customers",
        "description": "All the mobile and online banking customers are added to this group once enrollment is completed",
        "typeId": "TYPE_ID_RETAIL",
        "id": "GID_BANKING_CUSTOMERS",
        "status": "SID_ACTIVE"
    }, {
        "isDefaultGroup": "false",
        "name": "Freedom Credit Card Customers",
        "description": "All customers who own a Freedom Credit Card.  Does not include other credit card customers who do not own a freedom credit card.",
        "typeId": "TYPE_ID_RETAIL",
        "id": "GID_CREDITCARD_CUSTOMERS",
        "status": "SID_ACTIVE"
    }, {
        "isDefaultGroup": "false",
        "name": "High Net Worth Customer",
        "description": "Customers with total assets worth more than $75000",
        "typeId": "TYPE_ID_RETAIL",
        "id": "GID_HNW_CUSTOMERS",
        "status": "SID_ACTIVE"
    }, {
        "isDefaultGroup": "false",
        "name": "Home Loan Customers",
        "description": "All Kony Bank customers with only a Home Loan account",
        "typeId": "TYPE_ID_RETAIL",
        "id": "GID_LOAN_CUSTOMERS",
        "status": "SID_ACTIVE"
    }, {
        "isDefaultGroup": "false",
        "name": "Priority Customers",
        "description": "Members with more than 3 accounts. These members need to be taken care of as a high priority",
        "typeId": "TYPE_ID_RETAIL",
        "id": "GID_PRIORITY_MEMBERS",
        "status": "SID_ACTIVE"
    }, {
        "isDefaultGroup": "false",
        "name": "Auto Loan",
        "description": "All customers who have an Auto Loan Account with Kony Bank",
        "typeId": "TYPE_ID_RETAIL",
        "id": "GROUP_PLATINUM",
        "status": "SID_ACTIVE"
    }, {
        "isDefaultGroup": "false",
        "name": "Service",
        "description": "Service Desc",
        "typeId": "TYPE_ID_RETAIL",
        "id": "GROUP_SERVICE",
        "status": "SID_ACTIVE"
    }, {
        "isDefaultGroup": "false",
        "name": "Pilot Testing Group",
        "description": "All customers created for Online and Mobile Banking application demos",
        "typeId": "TYPE_ID_RETAIL",
        "id": "GROUP_TESTING",
        "status": "SID_ACTIVE"
    }],
    "serviceDefinitionId": "5801fa32-a416-45b6-af01-b22e2de93777",
    "opstatus": 0,
    "httpStatusCode": 0
}

"opstatus": 0,

"services": [],

"httpStatusCode": 0

}
Error Code(s):
  • Error Code: 22017
    Error Message: Error while invoking GetServiceDefinitionRoles service.
  • Error Code: 21902
    Error Message: Service definition Id cannot be null or empty.
  • Error Code: 22014
    Error Message: Error while fetching roles for service definition.
  • Error Code: 22015
    Error Message: Error while fetching roles information.
  • Error Code: 22016
    Error Message: Error while processing roles for service definition.
Enterprise Provider: Spotlight
Enterprise API:

/login?provider=KonyBankingAdminConsoleAPIIdentityService

Spotlight - /services/data/v1/BusinessBankingObjService/operations/servicedefinition/getServiceDefinitionRoles

Field Mapping

UI Field Experience API Field MS API Field Transact API Field
NA serviceDefinitionId NA NA
NA roles NA NA
NA isDefaultGroup NA NA
NA name NA NA
NA description NA NA
NA typeId NA NA
NA id NA NA
NA status NA NA
NA services NA NA
 
Description: Retrieves the service definitions that can be associated with the contracts.
Method: POST
URL: {base_url}/services/data/v1/ExternalUserManagement/operations/serviceDefinition/getServiceDefinitionsForContracts
Security Level: Authenticated App User
Header Request: X-Kony-Authorization
Body Request:

{}
Response:

Parameters(Mandatory)

ServiceDefinitionRecords

Specifies an array service definition records and their corresponding details.

ServiceDefinitionRecords/serviceType

Specifies the type of service.

ServiceDefinitionRecords/numberOfFeatures

Specifies the total number of features that are associated with the service.

ServiceDefinitionRecords/defaultGroup

ServiceDefinitionRecords/name

Specifies the name of the service definition record.

ServiceDefinitionRecords/description

Specifies the description of the service definition record.

ServiceDefinitionRecords/id

Specifies the unique ID of the service definition record.

ServiceDefinitionRecords/numberOfContracts

Specifies the total number of contracts that are associated with the service.

ServiceDefinitionRecords/status

Specifies the status of the service definition (Active/Inactive)

ServiceDefinitionRecords/numberOfRoles

Specifies the total number of roles that are associated with the service definition.

{{
    "ServiceDefinitionRecords": [{
        "serviceType": "TYPE_ID_WEALTH",
        "numberOfFeatures": "12",
        "defaultGroup": "4dd6183f-61d2-410f-8a4f-871af67ac933",
        "name": "Wealth Online Banking",
        "description": "Wealth Online Banking",
        "id": "90356097-7fdf-4b8c-89bd-8a1065338a97",
        "numberOfContracts": "0",
        "status": "SID_ACTIVE",
        "numberOfRoles": "1"
    }, {
        "serviceType": "TYPE_ID_WEALTH",
        "numberOfFeatures": "62",
        "defaultGroup": "a759860a-683a-4d41-81f8-fbd97d53b608",
        "name": "Retail and wealth online banking",
        "description": "Retail and wealth online banking",
        "id": "f85d8392-9afe-4128-b23e-a370f138784f",
        "numberOfContracts": "9",
        "status": "SID_ACTIVE",
        "numberOfRoles": "1"
    }, {
        "serviceType": "TYPE_ID_BUSINESS",
        "numberOfFeatures": "48",
        "defaultGroup": "GROUP_ADMINISTRATOR",
        "name": "Corporate Online Banking",
        "description": "Large to very large corporates when enrolled for online banking are categorised under this service",
        "id": "83c9b8d7-3715-480e-8c7d-3d6e61c00035",
        "numberOfContracts": "7",
        "status": "SID_ACTIVE",
        "numberOfRoles": "8"
    }, {
        "serviceType": "TYPE_ID_BUSINESS",
        "numberOfFeatures": "52",
        "defaultGroup": "GROUP_ADMINISTRATOR",
        "name": "SME Online Banking",
        "description": "Small and medium business enterprises when enrolled for online banking are categorised under this service",
        "id": "707dfea8-d0fe-4154-89c3-e7d7ef2ee16a",
        "numberOfContracts": "8",
        "status": "SID_ACTIVE",
        "numberOfRoles": "8"
    }, {
        "serviceType": "TYPE_ID_RETAIL",
        "numberOfFeatures": "54",
        "defaultGroup": "DEFAULT_GROUP",
        "name": "Retail Online Banking",
        "description": "Retail customer base of the bank when enrolled for online banking are categorised under this service",
        "id": "5801fa32-a416-45b6-af01-b22e2de93777",
        "numberOfContracts": "31",
        "status": "SID_ACTIVE",
        "numberOfRoles": "10"
    }, {
        "serviceType": "TYPE_ID_RETAIL",
        "numberOfFeatures": "46",
        "defaultGroup": "DEFAULT_GROUP",
        "name": "Gig online Banking",
        "description": "Individuals and independent entrepreneurs when enrolled for online banking are categorised under this service",
        "id": "bef2fe82-9c21-4ccb-b599-3308de18de44",
        "numberOfContracts": "1",
        "status": "SID_ACTIVE",
        "numberOfRoles": "10"
    }],
    "opstatus": 0,
    "httpStatusCode": 0
}
Error Code(s):
  • Error Code: 21910
    Error Message: Error while fetching service definition.
  • Error Code: 21903
    Error Message: Failed to get service definition.
  • Error Code: 22030
    Error Message: Error while Processing the result.
Enterprise Provider: Spotlight
Enterprise API:

Spotlight - /services/data/v1/BusinessBankingObjService/operations/servicedefinition/getServiceDefinitionsForContracts
UI Field Experience API Field MS API Field Transact API Field
NA ServiceDefinitionRecords NA NA
NA serviceType NA NA
NA numberOfFeatures NA NA
NA defaultGroup NA NA
NA name NA NA
NA description NA NA
NA id NA NA
NA numberOfContracts NA NA
NA status NA NA
NA numberOfRoles NA NA
 
Description: Retrieves the common features, actions, and action limits that are associated with a service definition.
Method: POST
URL: {base_url}/services/data/v1/ExternalUserManagement/operations/serviceDefinition/getServicedefinitionAndRoleFeatures
Security Level: Authenticated App User
Header Request: X-Kony-Authorization
Body Request:

Parameters

serviceDefinitionId (Mandatory)

Specifies the unique ID of the service definition.

groupId (Mandatory)

Specifies the unique ID of the group.

{

                "serviceDefinitionId":"5801fa32-a416-45b6-af01-b22e2de93777",

                "groupId":"DEFAULT_GROUP"

}
Response:

Parameters

features

Specifies an array of features and their corresponding details.

features/featureName

Specifies the name of the feature.

features/featureStatus

Specifies the status of the feature.

features/featureDescription

Specifies the description of the feature.

features/actions

Specifies an array of actions that are associated with the feature and their corresponding details.

features/actions/accessPolicyId

Specifies the unique ID of the access policy.

features/actions/actionStatus

Specifies the status of the action (Active/Inactive).

features/actions/actionId

Specifies the unique ID of the action

features/actions/accessPolicy

Specifies the type of action policy, such as Create, View , and so on.

features/actions/actionDescription

Specifies the description of the access policy.

features/actions/dependentActions

Specifies an array of dependent actions.

features/actions/actionLevel

Specifies the level at which the action has been set.

features/actions/actionLevelId

Specifies the unique ID that is associated with the action level.

features/actions/actionName

Specifies the name of the action.

features/featureId

Specifies the unique ID of the feature.

 

For response code click here.
Error Code(s):
  • Error Code: 21991
    Error Message: User id not proper.
  • Error Code: 20569
    Error Message: Group ID cannot be empty.
  • Error Code: 22000
    Error Message: Service Definition ID cannot be empty.
  • Error Code: 21999
    Error Message: Provided Customer Role is not associated to the ServiceDefinition.
  • Error Code: 22001
    Error Message: Error while fetching common features between Role and ServiceDefinition.
Enterprise Provider: Spotlight
Enterprise API:

/login?provider=KonyBankingAdminConsoleAPIIdentityService

Spotlight - /services/data/v1/BusinessBankingObjService/operations/servicedefinition/getServicedefinitionAndRoleFeatures

Field Mapping

UI Field Experience API Field MS API Field Transact API Field
NA features NA NA
NA featureName NA NA
NA featureStatus NA NA
NA featureDescription NA NA
NA actions NA NA
NA accessPolicyId NA NA
NA actionStatus NA NA
NA actionId NA NA
NA accessPolicy NA NA
NA actionDescription NA NA
NA isAccountLevel NA NA
NA dependentActions NA NA
NA actionLevel NA NA
NA actionLevelId NA NA
NA actionName NA NA
NA featureId NA NA
 
 
Parameter Name DataType Optional/Mandatory Description
groupId String Mandatory Specifies the group Id.
id String Mandatory Specifies the id.
serviceDefinitionId String Mandatory Specifies the service definition id.

In this topic

Copyright © 2020- Temenos Headquarters SA

Contact Us

knowledge@temenos.com

Published on :
Sunday, March 23, 2025 4:05:22 PM IST