CCC API v8.4.0.0

<back to all web services

GetCollection

The following routes are available for this service:
GET/api/collections/{CollectionGuid}Get details about a specific collection
GetCollection Parameters:
NameParameterData TypeRequiredDescription
CollectionGuidpathGuidYes
CollectionResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
Collection Parameters:
NameParameterData TypeRequiredDescription
CollectionGuidbodyGuidNo
NameformstringNo
CollectionCodeformstringNo
StatusformstringNo

Allowable Values

  • Active
  • Disabled
CreatedOnformDateTimeNo
ServicesApiBaseUrlformstringNo
SiteGuidbodyGuidNo
SiteEndpointbodySiteEndpointNo
SiteEndpoint Parameters:
NameParameterData TypeRequiredDescription
SiteGuidbodyGuidNo
GuidbodyGuidNo
NamebodyStringNo
SiteVersionbodyStringNo
DescriptionbodyStringNo
UrlbodyStringNo
CreatedOnbodyDateTimeNo

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} 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"
    }
  },
  "collectionGuid": "00000000000000000000000000000000",
  "name": "String",
  "collectionCode": "String",
  "status": "String",
  "createdOn": "0001-01-01T00:00:00Z",
  "servicesApiBaseUrl": "String",
  "siteGuid": "00000000000000000000000000000000",
  "siteEndpoint": {
    "siteGuid": "00000000000000000000000000000000",
    "guid": "00000000000000000000000000000000",
    "name": "String",
    "siteVersion": "String",
    "description": "String",
    "url": "String",
    "createdOn": "0001-01-01T00:00:00Z"
  }
}