CCC API v8.4.0.0

<back to all web services

GetServiceSetting

The following routes are available for this service:
GET/api/services/{ServiceGuid}/settings/{Name}Retrieve setting information for selected serviceThe setting is identified by its public name. The setting value may differ depending on which service is queried. The value is serialized.
GetServiceSetting Parameters:
NameParameterData TypeRequiredDescription
ServiceGuidpathGuidYes
NamepathStringYes
ServiceSettingResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
ServiceSetting Parameters:
NameParameterData TypeRequiredDescription
NameformstringNo
DescriptionformstringNo
GroupformstringNo
ValueformstringNo
ServiceGuidbodyGuidNo

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/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"
}