CCC API v8.4.0.0

<back to all web services

SearchServices

The following routes are available for this service:
GET/api/servicesGet a paged list of services associated with the current user. The search parameters use OR query logic. All search parameters are optional. When no search parameters are provided, the search returns all the Services the current user has access to.
SearchServices Parameters:
NameParameterData TypeRequiredDescription
DomainqueryStringNoThe Domain to search for. If left null, this param is excluded from the Search.
NamequeryStringNoThe Name to search for. If left null, this param is excluded from the Search.
CodequeryStringNoThe Code to search for. If left null, this param is excluded from the Search.
PagequeryIntegerNoThe Page number being requested. Defaults to 1.
PageSizequeryIntegerNoThe Page Size returned by the operation. Defaults to 25.
CreatedAfterDateTimequeryDateTimeNoSearch for any services created after or on this date / time (UTC). If left null, this param is excluded from the Search.
CreatedBeforeDateTimequeryDateTimeNoSearch for any services created before or on this date / time (UTC). If left null, this param is excluded from the Search.
ServicesPagedResponse Parameters:
NameParameterData TypeRequiredDescription
PageSizebodyIntegerNo
TotalPagesbodyIntegerNo
TotalItemsbodyIntegerNo
CurrentPagebodyIntegerNo
ResultsbodyService[]No
BaseResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
Service Parameters:
NameParameterData TypeRequiredDescription
ServiceGuidbodyGuidNo
NameformstringNo
StatusformServiceStatusNo

Allowable Values

  • Blocked
  • AccountCancelled
  • AccountSuspended
  • Provisioning
  • TrialExpired
  • TrialActive
  • DemoAccount
  • CertifiedSecure
ServiceCodeformstringNo
ReferenceIdformstringNo
PrimaryDomainformstringNo
UrlsformDictionary<ServiceUrlType, string>No

Allowable Values

  • MessagingApi
  • Webmail
  • ToolbarServices
  • GatewaySettings
  • AdminConsole
  • SecMsgAPI
  • Webapp
  • IdProxy
  • IdProxyLogout
CreatedOnbodyDateTimeNo
TrialEndDatebodyDateTimeNo
EffectiveDatebodyDateTimeNo
InitialTermbodyIntegerNo
CollectionGuidbodyGuidNo
SiteGuidbodyGuidNo
ClientGuidbodyGuidNo
ResellerGuidbodyGuidNo
ResellerNameformstringNo
PartnerGuidbodyGuidNo
PartnerNameformstringNo

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

{
  "pageSize": 0,
  "totalPages": 0,
  "totalItems": 0,
  "currentPage": 0,
  "results": [
    {
      "serviceGuid": "00000000000000000000000000000000",
      "name": "String",
      "status": "Blocked",
      "serviceCode": "String",
      "referenceId": "String",
      "primaryDomain": "String",
      "urls": {
        "MessagingApi": "String"
      },
      "createdOn": "0001-01-01T00:00:00Z",
      "trialEndDate": "0001-01-01T00:00:00Z",
      "effectiveDate": "0001-01-01T00:00:00Z",
      "initialTerm": 0,
      "collectionGuid": "00000000000000000000000000000000",
      "siteGuid": "00000000000000000000000000000000",
      "clientGuid": "00000000000000000000000000000000",
      "resellerGuid": "00000000000000000000000000000000",
      "resellerName": "String",
      "partnerGuid": "00000000000000000000000000000000",
      "partnerName": "String"
    }
  ],
  "responseStatus": {
    "errorCode": "String",
    "message": "String",
    "stackTrace": "String",
    "errors": [
      {
        "errorCode": "String",
        "fieldName": "String",
        "message": "String",
        "meta": {
          "String": "String"
        }
      }
    ],
    "meta": {
      "String": "String"
    }
  }
}