CCC API v8.4.0.0

<back to all web services

RegisterCollection

The following routes are available for this service:
POST/api/resellers/{ResellerGuid}/collectionsRegister a collection deployment with the Directory.
RegisterCollection Parameters:
NameParameterData TypeRequiredDescription
ResellerGuidpathGuidYesThe Reseller to create the collection for.
SiteGuidbodyGuidNoThe site on which the collection will be registered to.
NamebodyStringNoThe name of the new collection.
CollectionCodebodyStringNoThe code of the collection. Must be unique within the system.
ServicesApiBaseUrlbodyStringNoThe base URL where this collection can be reached at.
RegisterCollectionResponse Parameters:
NameParameterData TypeRequiredDescription
CollectionGuidbodyGuidNo
BaseResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo

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.

POST /api/resellers/{ResellerGuid}/collections HTTP/1.1 
Host: api.secure-messaging.com 
Accept: application/json
Content-Type: application/json
Content-Length: length

{
  "resellerGuid": "00000000000000000000000000000000",
  "siteGuid": "00000000000000000000000000000000",
  "name": "String",
  "collectionCode": "String",
  "servicesApiBaseUrl": "String"
}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{
  "collectionGuid": "00000000000000000000000000000000",
  "responseStatus": {
    "errorCode": "String",
    "message": "String",
    "stackTrace": "String",
    "errors": [
      {
        "errorCode": "String",
        "fieldName": "String",
        "message": "String",
        "meta": {
          "String": "String"
        }
      }
    ],
    "meta": {
      "String": "String"
    }
  }
}