Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

Version 1 Next »

Common Master is a unique feature in the SummitAI application that allows Administrators to set most commonly used label names and drop-down values across all the modules. If there is a change or addition required in the label names or drop-down values, this feature saves the efforts of the Administrator to make the same changes in all the pages separately. In other words, it simplifies the customization process required to be done by the Administrators for most commonly used labels names and drop-down values. Use the following API Request to create the Common Master types.

To authenticate the below API, see API Authentication and Authorization.

Service Name

HTTP Method

ADM_CreateOrUpdateCommonMaster

POST

Sample Request

Sample Request
{
    "ServiceName": "ADM_CreateOrUpdateCommonMaster",
    "objCommonParameters": {
        "_ProxyDetails": {
            "ProxyID": 0,
            "ReturnType": "JSON",
            "APIKey": "XXXXXXXXXXXXXXXXXXXXXX",
            "AuthType": "APIKEY"
        },
        "objCommonMasterDetail": {
            "DomainName": "Symphony summit",
            "CommonMasterDetails": [
                {
                    "MasterType": "State",
                    "MasterValue": "Victoria",
                    "Active": 1
                },
                {
                    "MasterType": "State",
                    "MasterValue": "Tasmania",
                    "Active": 1,
                    "ParentMasterType": "Country",
                    "ParentValue": "Australia"
                },
                {
                    "CM_ID": "147491",
                    "MasterType": "State",
                    "MasterValue": "Queensland_updated",
                    "Active": 1
                },
                {
                    "CM_ID": "147492",
                    "MasterType": "State",
                    "MasterValue": "NewSouthWales_Updated",
                    "Active": 1,
                    "ParentMasterType": "Country",
                    "ParentValue": "Australia_Updated"
                }
            ]
        }
    }
}

Request Parameters

Parameter NameTypeDescriptionMandatory
CM_ID

STRING

Unique identification number of the Common Master. This parameter is mandatory while updating a specific Master Type.

TRUE

MasterType

STRING

Name of the MasterType.

TRUE

MasterValue

STRING

Value of the specified MasterType.

TRUE

ParentMasterType

STRING

Name of the Parent MasterType.

TRUE

ParentValue

STRING

Value of the specified ParentMasterType.

TRUE

Active

STRING

Status of the configuration. Specify the value as 1 to make the configuration active or 0 to make the configuration inactive.

TRUE

Note:

  • The Domains of the Master data and Parent data must be the same.


Sample Response
{
  "Errors": "",
  "Message": "",
  "Output": "",
  "TokenID": "A04DE77753528619E19F4E23CC818AAE77BB3A86982166BAEFBA46FFDBBACC8AA50B84E66FBEAA69E4C6B79AE6B7BB929DA63DA5FACF2415E6716AE2EC
F053C7BDD4527E24882FD6D6147312601897DF4D7E7DC4E802E8DED56EFBB8404CB47A0AEC2A3DCBFEF888C9C4EB7082A9AC2F049CAD9CE1AC0ACC61B57F1663D247AF
B20D1759EC26AE4EA9EE6808F03EFAD3",
  "OrgID": 0,
  "OutputObject": {
    "CommonMasterDetails": [
      {
        "CM_ID": "17642",
        "MasterType": "state",
        "MasterValue": "GOAA",
        "ParentMasterType": null,
        "ParentValue": null,
        "Parent_CM_ID": null,
        "Action": "Inserted"
      },
      {
        "CM_ID": "17641",
        "MasterType": "state",
        "MasterValue": "GOA002",
        "ParentMasterType": "Country",
        "ParentValue": "India1",
        "Parent_CM_ID": "4870",
        "Action": "Updated"
      }
    ]
  },
  "OutputID": 0,
  "Input": null
}

Status and Error Codes

For more information, see Status and Error Messages


 

  • No labels