CCC API v8.4.0.0

<back to all web services

PartnerSiteAccess

The following routes are available for this service:
POST/api/partners/{PartnerGuid}/siteaccess/{SiteGuid}Add a new partner site relationship for the entities identified by the PartnerGuid and the SiteGuid parameters.Creating an access record that already exists will result in an error.
DELETE/api/partners/{PartnerGuid}/siteaccess/{SiteGuid}Remove the partner site relationship for the entities identified by the ResellerGuid and the SiteGuid parameters.If the specified access record does not exist an error will be thrown.
PartnerSiteAccess Parameters:
NameParameterData TypeRequiredDescription
PartnerGuidpathGuidYes
SiteGuidpathGuidYes
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/partners/{PartnerGuid}/siteaccess/{SiteGuid} HTTP/1.1 
Host: api.secure-messaging.com 
Accept: application/json
Content-Type: application/json
Content-Length: length

{
  "partnerGuid": "00000000000000000000000000000000",
  "siteGuid": "00000000000000000000000000000000"
}
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"
    }
  }
}