CCC API v8.4.0.0

GetCollectionSetting

The following routes are available for this service:
GET	/api/collections/{CollectionGuid}/settings/{Name}	Retrieve a value of a specific collection setting.	The setting is identified by its public name. The setting value may differ depending on which collection is queried. The value is serialized.SuperUsers can get any Collection settings. Partners can get a setting owned by one of their Resellers Collections. Resellers can get settings for Collections they own.

**GetCollectionSetting** Parameters:
Name	Parameter	Data Type	Required	Description
CollectionGuid	path	Guid	Yes
Name	path	String	Yes

**CollectionSettingResponse** Parameters:
Name	Parameter	Data Type	Required	Description
ResponseStatus	form	ResponseStatus	No

**CollectionSetting** Parameters:
Name	Parameter	Data Type	Required
Name	form	string	No
Description	form	string	No
Group	form	string	No
Value	form	string	No
CollectionGuid	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

HTTP + JSON

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

GET /api/collections/{CollectionGuid}/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",
  "collectionGuid": "00000000000000000000000000000000"
}