| GET | /api/gateways/{GatewayGuid}/services/{ServiceGuid}/settings/messagerules/{MessageRuleGuid} | Gets a specific message rule for a service and gateway instance. |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| GatewayGuid | path | Guid | Yes | Identifies the gateway instance. |
| ServiceGuid | path | Guid | Yes | Identifies the service instance. |
| MessageRuleGuid | path | Guid | Yes | Identifies the message rule. |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ResponseStatus | form | ResponseStatus | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ServiceGuid | form | Guid | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| 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
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"
}