GET api/Configurations/{id}/{option}

Request Information

URI Parameters

Name	Description	Type	Additional information
id		ConfigKeyType	Required
option		string	Default value is

Body Parameters

None.

Response Information

Resource Description

systemConfigData

Name	Type	Additional information
configKeycode	string	None.
data	Collection of valueDataType	None.
configKey	integer	None.
jsonValue	string	None.

Response Formats

application/json, text/json

Sample:

{
  "configKeycode": "COMPANYINFO",
  "data": [
    {
      "valueType": "sample string 1",
      "valueData": [
        {
          "configDetailKey": "0acd7d33-6cd4-4e8e-866d-b605bc79d6c5",
          "value": "sample string 2",
          "description": "sample string 3",
          "faIcon": "sample string 4",
          "important": true,
          "isenable": true,
          "isremoved": true,
          "parentKey": "c8a02140-3698-45c5-aab8-645397ae793c"
        },
        {
          "configDetailKey": "0acd7d33-6cd4-4e8e-866d-b605bc79d6c5",
          "value": "sample string 2",
          "description": "sample string 3",
          "faIcon": "sample string 4",
          "important": true,
          "isenable": true,
          "isremoved": true,
          "parentKey": "c8a02140-3698-45c5-aab8-645397ae793c"
        }
      ],
      "companyData": [
        {
          "companyName": "sample string 1",
          "addresses": "sample string 2",
          "contacts": "sample string 3",
          "email": {
            "profileName": "sample string 1",
            "emailAddress": "sample string 2",
            "password": "sample string 3",
            "passwordtochange": "sample string 4",
            "useSSL": true,
            "smtpServer": "sample string 6",
            "smtpPort": 7,
            "testTo": "sample string 8"
          },
          "key": "sample string 4",
          "value": "sample string 5",
          "color": "sample string 6",
          "faIcon": "sample string 7",
          "description": "sample string 8",
          "important": true,
          "isenable": true,
          "isremoved": true,
          "parentType": 0,
          "parentKey": "sample string 12"
        },
        {
          "companyName": "sample string 1",
          "addresses": "sample string 2",
          "contacts": "sample string 3",
          "email": {
            "profileName": "sample string 1",
            "emailAddress": "sample string 2",
            "password": "sample string 3",
            "passwordtochange": "sample string 4",
            "useSSL": true,
            "smtpServer": "sample string 6",
            "smtpPort": 7,
            "testTo": "sample string 8"
          },
          "key": "sample string 4",
          "value": "sample string 5",
          "color": "sample string 6",
          "faIcon": "sample string 7",
          "description": "sample string 8",
          "important": true,
          "isenable": true,
          "isremoved": true,
          "parentType": 0,
          "parentKey": "sample string 12"
        }
      ]
    },
    {
      "valueType": "sample string 1",
      "valueData": [
        {
          "configDetailKey": "0acd7d33-6cd4-4e8e-866d-b605bc79d6c5",
          "value": "sample string 2",
          "description": "sample string 3",
          "faIcon": "sample string 4",
          "important": true,
          "isenable": true,
          "isremoved": true,
          "parentKey": "c8a02140-3698-45c5-aab8-645397ae793c"
        },
        {
          "configDetailKey": "0acd7d33-6cd4-4e8e-866d-b605bc79d6c5",
          "value": "sample string 2",
          "description": "sample string 3",
          "faIcon": "sample string 4",
          "important": true,
          "isenable": true,
          "isremoved": true,
          "parentKey": "c8a02140-3698-45c5-aab8-645397ae793c"
        }
      ],
      "companyData": [
        {
          "companyName": "sample string 1",
          "addresses": "sample string 2",
          "contacts": "sample string 3",
          "email": {
            "profileName": "sample string 1",
            "emailAddress": "sample string 2",
            "password": "sample string 3",
            "passwordtochange": "sample string 4",
            "useSSL": true,
            "smtpServer": "sample string 6",
            "smtpPort": 7,
            "testTo": "sample string 8"
          },
          "key": "sample string 4",
          "value": "sample string 5",
          "color": "sample string 6",
          "faIcon": "sample string 7",
          "description": "sample string 8",
          "important": true,
          "isenable": true,
          "isremoved": true,
          "parentType": 0,
          "parentKey": "sample string 12"
        },
        {
          "companyName": "sample string 1",
          "addresses": "sample string 2",
          "contacts": "sample string 3",
          "email": {
            "profileName": "sample string 1",
            "emailAddress": "sample string 2",
            "password": "sample string 3",
            "passwordtochange": "sample string 4",
            "useSSL": true,
            "smtpServer": "sample string 6",
            "smtpPort": 7,
            "testTo": "sample string 8"
          },
          "key": "sample string 4",
          "value": "sample string 5",
          "color": "sample string 6",
          "faIcon": "sample string 7",
          "description": "sample string 8",
          "important": true,
          "isenable": true,
          "isremoved": true,
          "parentType": 0,
          "parentKey": "sample string 12"
        }
      ]
    }
  ],
  "configKey": 1
}

application/xml, text/xml

Sample:

XML example omitted: automatic generation is unsafe for cyclic entity models. XML API requests and responses remain available.