| GET | /api/settings/keys | Get setting keys |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Names | body | String[] | No | |
| AccessType | body | String | No | Allowable Values
|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| SettingKeys | form | List<SettingKey> | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ResponseStatus | form | ResponseStatus | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Guid | body | Guid | No | |
| Name | form | string | No | |
| AccessType | form | string | No | |
| Group | body | SettingGroup | No | |
| Visibility | form | string | No | |
| Description | form | string | No | |
| ValidationDescription | form | string | No | |
| Label | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Guid | body | Guid | No | |
| Name | form | string | No |
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
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",
"label": "String"
}
],
"responseStatus": {
"errorCode": "String",
"message": "String",
"stackTrace": "String",
"errors": [
{
"errorCode": "String",
"fieldName": "String",
"message": "String",
"meta": {
"String": "String"
}
}
],
"meta": {
"String": "String"
}
}
}