CCC API v8.4.0.0

<back to all web services

GetGatewayServiceMessageRule

The following routes are available for this service:
GET/api/gateways/{GatewayGuid}/services/{ServiceGuid}/settings/messagerules/{MessageRuleGuid}Gets a specific message rule for a service and gateway instance.
GetGatewayServiceMessageRule Parameters:
NameParameterData TypeRequiredDescription
GatewayGuidpathGuidYesIdentifies the gateway instance.
ServiceGuidpathGuidYesIdentifies the service instance.
MessageRuleGuidpathGuidYesIdentifies the message rule.
GatewayServiceMessageRuleResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
GatewayServiceMessageRule Parameters:
NameParameterData TypeRequiredDescription
ServiceGuidformGuidNo
GatewayMessageRule Parameters:
NameParameterData TypeRequiredDescription
MessageRuleGuidformGuidNo
GatewayGuidformGuidNo
CostformlongNo
EnabledformboolNo
CheckNextRuleIfformintNo
DescriptionformstringNo
MatchExpressionformstringNo

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/gateways/{GatewayGuid}/services/{ServiceGuid}/settings/messagerules/{MessageRuleGuid} 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"
    }
  },
  "serviceGuid": "00000000000000000000000000000000",
  "messageRuleGuid": "00000000000000000000000000000000",
  "gatewayGuid": "00000000000000000000000000000000",
  "cost": 0,
  "enabled": false,
  "checkNextRuleIf": 0,
  "description": "String",
  "matchExpression": "String"
}