| GET | /api/services/{ServiceGuid}/settings/{Name} | Retrieve setting information for selected service | The setting is identified by its public name. The setting value may differ depending on which service is queried. The value is serialized. |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ServiceGuid | path | Guid | Yes | |
| Name | path | String | Yes |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ResponseStatus | form | ResponseStatus | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Name | form | string | No | |
| Description | form | string | No | |
| Group | form | string | No | |
| Value | form | string | No | |
| ServiceGuid | body | Guid | 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/services/{ServiceGuid}/settings/{Name} HTTP/1.1
Host: api.secure-messaging.com
Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length
{
"responseStatus": {
"errorCode": "String",
"message": "String",
"stackTrace": "String",
"errors": [
{
"errorCode": "String",
"fieldName": "String",
"message": "String",
"meta": {
"String": "String"
}
}
],
"meta": {
"String": "String"
}
},
"name": "String",
"description": "String",
"group": "String",
"value": "String",
"serviceGuid": "00000000000000000000000000000000"
}