CCC API v8.4.0.0

<back to all web services

ResellerCollectionAccess

The following routes are available for this service:
POST/api/resellers/{ResellerGuid}/collectionaccess/{CollectionGuid}Add a new reseller collection relationship for the entities identified by the ResellerGuid and the CollectionGuid parameters.Creating an access record that already exists will result in an error. If the record is the first one created for a Reseller on a Site, IsDefaultCollectionForSite will default to true. If IsDefaultCollectionForSite is set to true, it will reset any other Collections that were previously set as Default for the Site. This parameter is not valid for DELETE operations.
PUT/api/resellers/{ResellerGuid}/collectionaccess/{CollectionGuid}Update reseller collection relationship for the entities identified by the ResellerGuid and the CollectionGuid parameters.If the specified access record does not exist an error will be thrown.
DELETE/api/resellers/{ResellerGuid}/collectionaccess/{CollectionGuid}Remove the reseller collection relationship for the entities identified by the ResellerGuid and the CollectionGuid parameters.If the specified access record does not exist an error will be thrown.
ResellerCollectionAccess Parameters:
NameParameterData TypeRequiredDescription
ResellerGuidpathGuidYesThe Reseller to create the collection for.
CollectionGuidpathGuidYesThe base URL where this collection is located.
IsDefaultCollectionForSitebodyBooleanNoNot valid on DELETE.

Allowable Values

  • true
  • false
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}/collectionaccess/{CollectionGuid} HTTP/1.1 
Host: api.secure-messaging.com 
Accept: application/json
Content-Type: application/json
Content-Length: length

{
  "resellerGuid": "00000000000000000000000000000000",
  "collectionGuid": "00000000000000000000000000000000",
  "isDefaultCollectionForSite": false
}
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"
    }
  }
}