CCC API v8.4.0.0

<back to all web services

GetSettingKeys

The following routes are available for this service:
GET/api/settings/keysGet setting keys
GetSettingKeys Parameters:
NameParameterData TypeRequiredDescription
NamesbodyString[]No
AccessTypebodyStringNo

Allowable Values

  • Service
  • Collection
  • Reseller
  • Partner
GetSettingKeysResponse Parameters:
NameParameterData TypeRequiredDescription
SettingKeysformList<SettingKey>No
BaseResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
SettingKey Parameters:
NameParameterData TypeRequiredDescription
GuidbodyGuidNo
NameformstringNo
AccessTypeformstringNo
GroupbodySettingGroupNo
VisibilityformstringNo
DescriptionformstringNo
ValidationDescriptionformstringNo
SettingGroup Parameters:
NameParameterData TypeRequiredDescription
GuidbodyGuidNo
NameformstringNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /api/settings/keys HTTP/1.1 
Host: api.secure-messaging.com 
Accept: application/json

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{
  "settingKeys": [
    {
      "guid": "00000000000000000000000000000000",
      "name": "String",
      "accessType": "String",
      "group": {
        "guid": "00000000000000000000000000000000",
        "name": "String"
      },
      "visibility": "String",
      "description": "String",
      "validationDescription": "String"
    }
  ],
  "responseStatus": {
    "errorCode": "String",
    "message": "String",
    "stackTrace": "String",
    "errors": [
      {
        "errorCode": "String",
        "fieldName": "String",
        "message": "String",
        "meta": {
          "String": "String"
        }
      }
    ],
    "meta": {
      "String": "String"
    }
  }
}