CCC API v8.4.0.0

<back to all web services

GetSite

The following routes are available for this service:
GET/api/sites/{SiteGuid}Get details about a site.
GetSite Parameters:
NameParameterData TypeRequiredDescription
SiteGuidpathGuidYes
SiteResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
Site Parameters:
NameParameterData TypeRequiredDescription
SiteGuidbodyGuidNo
CreatedOnbodyDateTimeNo
NameformstringNo
ProviderNameformstringNo
JurisdictionformstringNo
StatusformSiteStatusNo

Allowable Values

  • Active
  • Disabled
EndpointformstringNo
OwnerPartnerGuidbodyGuidNo
AvailableServerVersionformstringNo
AvailableServicePackbodyIntegerNo

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/sites/{SiteGuid} 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"
    }
  },
  "siteGuid": "00000000000000000000000000000000",
  "createdOn": "0001-01-01T00:00:00Z",
  "name": "String",
  "providerName": "String",
  "jurisdiction": "String",
  "status": "Active",
  "endpoint": "String",
  "ownerPartnerGuid": "00000000000000000000000000000000",
  "availableServerVersion": "String",
  "availableServicePack": 0
}