Contract Management
The Contract Architecture is based on permissions driven app structure. In this architecture, the user is associated with a contract to access the features. Every contract contains a service definition that categorizes users into different segments, such as Retail, Sole Proprietor, Partnership, LLC, and so on. Based on the assigned contract the user can access the features.
| Name | Description | Introduced in |
|---|---|---|
| createContract | This API creates a contract based on the specified parameters. | 2021.01 |
| AddNewFeaturesTOContractFromSD |
When we add a new feature actions at service definition level, this service will be called. And this API will add those newly added features to all the contracts associated with that service definition. |
2022.07 |
| AddNewFeaturesFromJob |
If there are any new feature actions added at any service definition, those newly added feature actions will be added to all the contracts associated with those service definitions. |
2022.07 |
| getContractInfinityUsers | This API fetches the user with its contract. | 2023.01 |
createContract
| Description: | Creates a contract based on the specified parameters. | ||||
| Method: | POST | ||||
| URL: | /services/data/v1/RBObjects/operations/Contract/createContract | ||||
| Security Level: | Authenticated App User | ||||
| Is T24 Required: | No | ||||
| Header Request: | X-Kony-Authorization | ||||
| Body Request: |
{
"serviceDefinitionId":"569efd17-858c-43e5-bab2-e89c79f528c2"
}
|
||||
| Response: | {
"status": success,
"opstatus": 0,
"httpStatusCode": 0
}
|
||||
| Error Code(s): |
|
||||
| Service Flow: |
|
AddNewFeaturesTOContractFromSD
|
Description: |
When we add a new feature actions at service definition level, this service will be called. And this service will add those newly added features to all the contracts associated with that service definition. |
|||||
|
Method: |
POST |
|||||
|
URL: |
/services/eumProductServices/AddNewFeaturesTOContractFromSD |
|||||
|
Security Level: |
Authenticated |
|||||
| Header Request | - | |||||
|
Body Request |
{
"serviceDefinitionId":"569efd17-858c-43e5-bab2-e89c79f528c2"
}
|
|||||
|
Response |
{
"status": success,
"opstatus": 0,
"httpStatusCode": 0
}
|
|||||
| Error Code(s): |
None (since it is an internal call, and caller method is not interested in response) |
|||||
| Service Flow: |
|
AddNewFeaturesFromJob
|
Description: |
If there are any new feature actions added at any service definition, those newly added feature actions will be added to all the contracts associated with those service definitions. |
|||||
|
Method: |
POST |
|||||
|
URL: |
/services/eumProductServices/AddNewFeaturesFromJob |
|||||
|
Security Level: |
Authenticated |
|||||
| Header Request | - | |||||
|
Body Request: |
NA |
|||||
|
Response |
{
"status": success,
"opstatus": 0,
"httpStatusCode": 0
}
|
|||||
| Error Code(s): |
None (normally this service call happen from mobile fabric jobs) |
|||||
| Service Flow: |
|
getContractInfinityUsers
| Description: |
This API fetches the user with its contract. |
| Method: | POST |
| URL: | {base_url}/services/data/v1/ContractManagementObjService/operations/Contract/getContractInfinityUsers |
| Security Level: | Authenticated |
| Header Request: | X-Kony-Authorization |
| Body Request: | {"contractId":"8449525004"}
|
| Response: | {
"opstatus": 0,
"contractUsers": [
{
"signatoryGroups": [
{
"coreCustomerId": "190699",
"contractId": "8449525004",
"groups": [
{
"signatoryGroupId": "d89ef045-7d5b-4a83-a620-47c06efd0121",
"signatoryGroupName": "test",
"signatoryGroupDescription": "test",
"isAssociated": true
}
],
"contractName": "TESTTTT BUSINESS 190699",
"coreCustomerName": "TESTTTT BUSINESS"
}
],
"firstName": "user",
"lastName": "admin",
"Email": "malleswari.yalakurti@temenos.com",
"statusId": "SID_CUS_NEW",
"customerId": "2089227458",
"dateOfBirth": "1995-10-10",
"userName": "8694127989",
"Ssn": "56789"
},
{
"signatoryGroups": [
{
"coreCustomerId": "190699",
"contractId": "8449525004",
"groups": [
{
"signatoryGroupId": "d89ef045-7d5b-4a83-a620-47c06efd0121",
"signatoryGroupName": "test",
"signatoryGroupDescription": "test",
"isAssociated": false
}
],
"contractName": "TESTTTT BUSINESS 190699",
"coreCustomerName": "TESTTTT BUSINESS"
}
],
"firstName": "Testinggg",
"lastName": "Bank",
"primaryCoreCustomerId": "190733",
"Email": "karimillanikhitha@gmail.com",
"statusId": "SID_CUS_NEW",
"customerId": "6732202065",
"dateOfBirth": "2000-04-25",
"userName": "5262003242"
}
],
"httpStatusCode": 0
}
|
| Error Code(s): |
NA |
| Enterprise Provider: | NA |
| Enterprise API: |
NA |
Field Mapping
| UI field | Experience API Field | MS API Field | Transact API Field |
|---|---|---|---|
| NA | NA | NA | NA |
In this topic