CCC API v7.11.19095.1

<back to all web services

PublicGetService

The following routes are available for this service:
GET/api/public/services/{ServiceGuid}
GET/api/public/services/singleGet detailed information about a specific service.
PublicGetService Parameters:
NameParameterData TypeRequiredDescription
ServiceGuidqueryGuidNoMust provide ServiceGuid if ServiceCode is null.
ServiceCodequeryStringNoMust provide ServiceCode if ServiceGuid is null.
PublicGetServiceResponse Parameters:
NameParameterData TypeRequiredDescription
ServiceGuidbodyGuidNo
ServiceStatusformServiceStatusNo
ServiceNameformstringNo
ServiceCodeformstringNo
CollectionGuidbodyGuidNo
CollectionNameformstringNo
JurisdictionformstringNo
ProviderNameformstringNo
PrimaryDomainformstringNo
AlertCodebodyIntegerNo
SSOEnabledbodyBooleanNo

Allowable Values

  • true
  • false
BrandingformDictionary<string, string>No
UrlsformDictionary<ServiceUrlType, string>No

Allowable Values

  • MessagingApi
  • Webmail
  • ToolbarServices
  • GatewaySettings
  • AdminConsole
  • SecMsgAPI
  • Webapp
  • IdProxy
  • IdProxyLogout
ConnectorsformList<Connector>No
AuthenticatorsformList<Authenticator>No
TrialEndDatebodyDateTimeNo
BaseResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
Connector Parameters:
NameParameterData TypeRequiredDescription
NamebodyStringNo
IdPxGuidbodyGuidNo
IdPxLoginUrlbodyStringNo
MatchesAuthbodyBooleanNo
Authenticator Parameters:
NameParameterData TypeRequiredDescription
NamebodyStringNo
DescriptionbodyStringNo
IdProviderGuidbodyGuidNo
IdPxLoginUrlbodyStringNo
UsedLastbodyBooleanNo

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/public/services/{ServiceGuid} HTTP/1.1 
Host: api.secure-messaging.com 
Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{
  "serviceGuid": "00000000000000000000000000000000",
  "serviceStatus": "Blocked",
  "serviceName": "String",
  "serviceCode": "String",
  "collectionGuid": "00000000000000000000000000000000",
  "collectionName": "String",
  "jurisdiction": "String",
  "providerName": "String",
  "primaryDomain": "String",
  "alertCode": "String",
  "ssoEnabled": false,
  "branding": {
    "String": "String"
  },
  "urls": {
    "MessagingApi": "String"
  },
  "connectors": [
    {
      "name": "String",
      "idPxGuid": "00000000000000000000000000000000",
      "idPxLoginUrl": "String",
      "matchesAuth": false
    }
  ],
  "authenticators": [
    {
      "name": "String",
      "description": "String",
      "idProviderGuid": "00000000000000000000000000000000",
      "idPxLoginUrl": "String",
      "usedLast": false
    }
  ],
  "trialEndDate": "0001-01-01T00:00:00Z",
  "responseStatus": {
    "errorCode": "String",
    "message": "String",
    "stackTrace": "String",
    "errors": [
      {
        "errorCode": "String",
        "fieldName": "String",
        "message": "String",
        "meta": {
          "String": "String"
        }
      }
    ],
    "meta": {
      "String": "String"
    }
  }
}