GET api/v1/PrayerWall/PrayerModerationRule?ruleID={ruleID}&clientID={clientID}&includeInactive={includeInactive}&ipAddress={ipAddress}&limit={limit}&offset={offset}

Return list of prayer moderation rules

Request Information

URI Parameters

NameDescriptionTypeAdditional information
ruleID

Optional RuleId to return a single rule (returned regardless of IsActive state)

integer

None.

clientID

ClientID to filter rules for a specific client. Ignored when ruleID is supplied.

string

None.

includeInactive

If true, includes inactive/retired rules in the list. Ignored when ruleID is supplied.

boolean

Default value is False

ipAddress

Used for logging IP Address

string

None.

limit

Number of records to return (from 1 to 100)

integer

Default value is 100

offset

Offset by number of records

integer

Default value is 0

Body Parameters

None.

Response Information

Resource Description

IHttpActionResult

None.

Response Formats

application/json, text/json, application/xml, text/xml

Sample:

Sample not available.