POST api/Configurations

Request Information

URI Parameters

None.

Body Parameters

systemConfigData
NameDescriptionTypeAdditional information
configKeycode

string

None.

data

Collection of valueDataType

None.

configKey

integer

None.

jsonValue

string

None.

Request Formats

application/json, text/json

Sample:
{
  "configKeycode": "COMPANYINFO",
  "data": [
    {
      "valueType": "sample string 1",
      "valueData": [
        {
          "configDetailKey": "a008da94-cd3f-4481-9816-09327c9f652a",
          "value": "sample string 2",
          "description": "sample string 3",
          "faIcon": "sample string 4",
          "important": true,
          "isenable": true,
          "isremoved": true,
          "parentKey": "83df9c82-e320-4246-a2fc-6f24c47701d7"
        },
        {
          "configDetailKey": "a008da94-cd3f-4481-9816-09327c9f652a",
          "value": "sample string 2",
          "description": "sample string 3",
          "faIcon": "sample string 4",
          "important": true,
          "isenable": true,
          "isremoved": true,
          "parentKey": "83df9c82-e320-4246-a2fc-6f24c47701d7"
        }
      ],
      "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": "a008da94-cd3f-4481-9816-09327c9f652a",
          "value": "sample string 2",
          "description": "sample string 3",
          "faIcon": "sample string 4",
          "important": true,
          "isenable": true,
          "isremoved": true,
          "parentKey": "83df9c82-e320-4246-a2fc-6f24c47701d7"
        },
        {
          "configDetailKey": "a008da94-cd3f-4481-9816-09327c9f652a",
          "value": "sample string 2",
          "description": "sample string 3",
          "faIcon": "sample string 4",
          "important": true,
          "isenable": true,
          "isremoved": true,
          "parentKey": "83df9c82-e320-4246-a2fc-6f24c47701d7"
        }
      ],
      "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.

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

systemConfigData
NameDescriptionTypeAdditional 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": "cc02909c-a990-4ac2-bc0d-3cdef8f99ec7",
          "value": "sample string 2",
          "description": "sample string 3",
          "faIcon": "sample string 4",
          "important": true,
          "isenable": true,
          "isremoved": true,
          "parentKey": "80fa562a-77c7-4cac-8560-3995d9ad5459"
        },
        {
          "configDetailKey": "cc02909c-a990-4ac2-bc0d-3cdef8f99ec7",
          "value": "sample string 2",
          "description": "sample string 3",
          "faIcon": "sample string 4",
          "important": true,
          "isenable": true,
          "isremoved": true,
          "parentKey": "80fa562a-77c7-4cac-8560-3995d9ad5459"
        }
      ],
      "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": "cc02909c-a990-4ac2-bc0d-3cdef8f99ec7",
          "value": "sample string 2",
          "description": "sample string 3",
          "faIcon": "sample string 4",
          "important": true,
          "isenable": true,
          "isremoved": true,
          "parentKey": "80fa562a-77c7-4cac-8560-3995d9ad5459"
        },
        {
          "configDetailKey": "cc02909c-a990-4ac2-bc0d-3cdef8f99ec7",
          "value": "sample string 2",
          "description": "sample string 3",
          "faIcon": "sample string 4",
          "important": true,
          "isenable": true,
          "isremoved": true,
          "parentKey": "80fa562a-77c7-4cac-8560-3995d9ad5459"
        }
      ],
      "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.