CCC API v8.4.0.0

<back to all web services

SearchRegistrationFilters

The following routes are available for this service:
GET/api/services/{ServiceGuid}/registrationfilters
SearchRegistrationFilters Parameters:
NameParameterData TypeRequiredDescription
ServiceGuidpathGuidNo
ValuebodyStringNo
TypebodyStringNo

Allowable Values

  • Individual
  • Domain
AccessGrantedbodyBooleanNo
CraExemptbodyBooleanNo
RegistrationFilterGuidbodyGuidNo
DefaultGroupGuidbodyGuidNo
AllowSsoSelfRegisterbodyBooleanNo
PagebodyIntegerNo
PageSizebodyIntegerNo
SearchRegistrationFiltersResponse Parameters:
NameParameterData TypeRequiredDescription
PageSizeformintNo
TotalPagesformintNo
TotalItemsformintNo
CurrentPageformintNo
ResultsformList<RegistrationFilter>No
ResponseStatusformResponseStatusNo
RegistrationFilter Parameters:
NameParameterData TypeRequiredDescription
RegistrationFilterGuidformstringNo
ValueformstringNo
TypeformstringNo
AccessGrantedformboolNo
CraExemptformboolNo
AllowSsoSelfRegisterformboolNo
ServiceGuidformGuidNo
DefaultGroupGuidformGuidNo

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/{ServiceGuid}/registrationfilters 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": [
    {
      "registrationFilterGuid": "String",
      "value": "String",
      "type": "String",
      "accessGranted": false,
      "craExempt": false,
      "allowSsoSelfRegister": false,
      "serviceGuid": "00000000000000000000000000000000",
      "defaultGroupGuid": "00000000000000000000000000000000"
    }
  ],
  "responseStatus": {
    "errorCode": "String",
    "message": "String",
    "stackTrace": "String",
    "errors": [
      {
        "errorCode": "String",
        "fieldName": "String",
        "message": "String",
        "meta": {
          "String": "String"
        }
      }
    ],
    "meta": {
      "String": "String"
    }
  }
}