CCC API v8.4.0.0

SearchGatewayServiceMessageRules

The following routes are available for this service:
GET	/api/gateways/{GatewayGuid}/services/{ServiceGuid}/settings/messagerules	Gets the message rules for a service and gateway instance.

**SearchGatewayServiceMessageRules** Parameters:
Name	Parameter	Data Type	Required	Description
GatewayGuid	path	Guid	Yes	Identifies the gateway instance.
ServiceGuid	path	Guid	Yes	Identifies the service instance.
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.

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

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

**GatewayServiceMessageRule** Parameters:
Name	Parameter	Data Type	Required	Description
ServiceGuid	form	Guid	No

**GatewayMessageRule** Parameters:
Name	Parameter	Data Type	Required
MessageRuleGuid	form	Guid	No
GatewayGuid	form	Guid	No
Cost	form	long	No
Enabled	form	bool	No
CheckNextRuleIf	form	int	No
Description	form	string	No
MatchExpression	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/gateways/{GatewayGuid}/services/{ServiceGuid}/settings/messagerules 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",
      "messageRuleGuid": "00000000000000000000000000000000",
      "gatewayGuid": "00000000000000000000000000000000",
      "cost": 0,
      "enabled": false,
      "checkNextRuleIf": 0,
      "description": "String",
      "matchExpression": "String"
    }
  ],
  "responseStatus": {
    "errorCode": "String",
    "message": "String",
    "stackTrace": "String",
    "errors": [
      {
        "errorCode": "String",
        "fieldName": "String",
        "message": "String",
        "meta": {
          "String": "String"
        }
      }
    ],
    "meta": {
      "String": "String"
    }
  }
}