CCC API v8.4.0.0

SearchServiceStatusChanges

The following routes are available for this service:
GET	/api/services/status	Get filtered information about service status changes

**SearchServiceStatusChanges** Parameters:
Name	Parameter	Data Type	Required	Description
ServiceGuid	query	Guid	No
ResellerGuid	query	Guid	No
PartnerGuid	query	Guid	No
ChangedByUserGuid	query	Guid	No
ChangedByUserEmail	query	String	No
ChangedAfterDateTime	query	DateTime	No
ChangedBeforeDateTime	query	DateTime	No
Page	query	Integer	No	The Page number being requested. Defaults to 1.
PageSize	query	Integer	No	The Page Size returned by the operation. Defaults to 25.

**ServiceStatusChangesResponse** Parameters:
Name	Parameter	Data Type	Required
PageSize	body	Integer	No
TotalPages	body	Integer	No
TotalItems	body	Integer	No
CurrentPage	body	Integer	No
Results	body	Service[]	No

**BaseResponse** Parameters:
Name	Parameter	Data Type	Required	Description
ResponseStatus	form	ResponseStatus	No

**ServiceStatusChange** Parameters:
Name	Parameter	Data Type	Required	Description
ServiceGuid	body	Guid	No
ServiceName	body	String	No
ServiceCode	body	String	No
PrimaryDomain	body	String	No
Jurisdiction	body	String	No
Branding	form	Dictionary<string, string>	No
ServiceUsage	body	ServiceUsage	No
CreatedOn	body	DateTime	No
ResellerGuid	body	Guid	No
ResellerName	body	String	No
PartnerGuid	body	Guid	No
PartnerName	body	String	No
OperationGuid	body	Guid	No
ServiceStatusChangeGuid	body	Guid	No
Status	form	ServiceStatus	No	Allowable Values Blocked AccountCancelled AccountSuspended Provisioning TrialExpired TrialActive DemoAccount CertifiedSecure
ChangedOn	body	DateTime	No
ChangedByUserGuid	body	AdminUser	No
ChangedByUserEmailAddress	body	String	No

**ServiceUsage** Parameters:
Name	Parameter	Data Type	Required	Description
ServiceGuid	body	Guid	No
Name	form	string	No
Status	form	ServiceStatus	No	Allowable Values Blocked AccountCancelled AccountSuspended Provisioning TrialExpired TrialActive DemoAccount CertifiedSecure
ServiceCode	form	string	No
ReferenceId	form	string	No
PrimaryDomain	form	string	No
CreatedOn	body	DateTime	No
TrialEndDate	body	DateTime	No
EffectiveDate	body	DateTime	No
InitialTerm	form	int	No
CollectionGuid	body	Guid	No
CollectionName	form	string	No
ClientGuid	body	Guid	No
Contact	body	ContactInfo	No
Company	body	Company	No
PeriodType	form	PeriodType	No	Allowable Values Daily Monthly
Period	body	DateTime	No
TotalUserCount	body	Integer	No
ProUserCount	body	Integer	No
GuestUserCount	body	Integer	No
DisabledUserCount	body	Integer	No
UnregisteredUserCount	body	Integer	No
FeatureUsageSecureMessagingGateway	body	Integer	No
FeatureUsageSecureMessagingPlus	body	Integer	No
FeatureUsageDataLeakPrevention	body	Integer	No
FeatureUsageSecureLargeFiles	body	Integer	No
FeatureUsageSecureForms	body	Integer	No
TotalMessageCount	body	Integer	No
TotalAttachmentCount	body	Integer	No
AttachmentStorageUsage	body	Integer	No

**ContactInfo** Parameters:
Name	Parameter	Data Type	Required
Name	body	String	Yes
Email	body	String	Yes
PhoneNumber	body	String	Yes

**Company** Parameters:
Name	Parameter	Data Type	Required
Name	form	string	No
Address	form	string	No
City	form	string	No
StateProvince	form	string	No
PostalCode	form	string	No
Country	form	string	No
Website	form	string	No

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/status 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",
      "serviceName": "String",
      "serviceCode": "String",
      "primaryDomain": "String",
      "jurisdiction": "String",
      "branding": {
        "String": "String"
      },
      "serviceUsage": {
        "serviceGuid": "00000000000000000000000000000000",
        "name": "String",
        "status": "Blocked",
        "serviceCode": "String",
        "referenceId": "String",
        "primaryDomain": "String",
        "createdOn": "0001-01-01T00:00:00Z",
        "trialEndDate": "0001-01-01T00:00:00Z",
        "effectiveDate": "0001-01-01T00:00:00Z",
        "initialTerm": 0,
        "collectionGuid": "00000000000000000000000000000000",
        "collectionName": "String",
        "clientGuid": "00000000000000000000000000000000",
        "contact": {
          "name": "String",
          "email": "String",
          "phoneNumber": "String"
        },
        "company": {
          "name": "String",
          "address": "String",
          "city": "String",
          "stateProvince": "String",
          "postalCode": "String",
          "country": "String",
          "website": "String"
        },
        "periodType": "Daily",
        "period": "0001-01-01T00:00:00Z",
        "totalUserCount": 0,
        "proUserCount": 0,
        "guestUserCount": 0,
        "disabledUserCount": 0,
        "unregisteredUserCount": 0,
        "featureUsageSecureMessagingGateway": 0,
        "featureUsageSecureMessagingPlus": 0,
        "featureUsageDataLeakPrevention": 0,
        "featureUsageSecureLargeFiles": 0,
        "featureUsageSecureForms": 0,
        "totalMessageCount": 0,
        "totalAttachmentCount": 0,
        "attachmentStorageUsage": 0
      },
      "createdOn": "0001-01-01T00:00:00Z",
      "resellerGuid": "00000000000000000000000000000000",
      "resellerName": "String",
      "partnerGuid": "00000000000000000000000000000000",
      "partnerName": "String",
      "operationGuid": "00000000000000000000000000000000",
      "serviceStatusChangeGuid": "00000000000000000000000000000000",
      "status": "Blocked",
      "changedOn": "0001-01-01T00:00:00Z",
      "changedByUserGuid": "00000000000000000000000000000000",
      "changedByUserEmailAddress": "String"
    }
  ],
  "responseStatus": {
    "errorCode": "String",
    "message": "String",
    "stackTrace": "String",
    "errors": [
      {
        "errorCode": "String",
        "fieldName": "String",
        "message": "String",
        "meta": {
          "String": "String"
        }
      }
    ],
    "meta": {
      "String": "String"
    }
  }
}

CCC API v8.4.0.0

SearchServiceStatusChanges

Allowable Values

Allowable Values

Allowable Values

HTTP + JSON