CCC API v8.12.0.0

PingCollection

The following routes are available for this service:
GET	/api/collections/{CollectionGuid}/ping	Pings the specified Collection and returns that Collections current UTC time, plus the current CCC / Site / Collection Versions.

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

**PingCollectionResponse** Parameters:
Name	Parameter	Data Type	Required
Timestamp	body	DateTime	No
DirectoryVersion	form	string	No
SiteVersion	form	string	No
CollectionVersion	form	string	No

**BaseResponse** Parameters:
Name	Parameter	Data Type	Required	Description
ResponseStatus	form	ResponseStatus	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}/ping HTTP/1.1 
Host: api.secure-messaging.com 
Accept: application/json

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{
  "timestamp": "0001-01-01T00:00:00Z",
  "directoryVersion": "String",
  "siteVersion": "String",
  "collectionVersion": "String",
  "responseStatus": {
    "errorCode": "String",
    "message": "String",
    "stackTrace": "String",
    "errors": [
      {
        "errorCode": "String",
        "fieldName": "String",
        "message": "String",
        "meta": {
          "String": "String"
        }
      }
    ],
    "meta": {
      "String": "String"
    }
  }
}