YM REST Services

<back to all web services

DuesRules

Requires Authentication
Requires any of the roles:admin, oauthadminRequires the permission:CanAdminMembers
The following routes are available for this service:
GET/Ams/{ClientID}/DuesRules/Return a list of dues rules for the given member and membership ID.
DuesRules Parameters:
NameParameterData TypeRequiredDescription
MemberIDqueryintNo
MembershipIDqueryintNo
BaseDto Parameters:
NameParameterData TypeRequiredDescription
UsingRedisformboolNo
AppInitTimeformDateTimeNo
ServerIDformstringNo
BaseSharedDto Parameters:
NameParameterData TypeRequiredDescription
ClientIDformintNo
ResponseStatusformResponseStatusNo
BypassCacheformboolNo
DateCachedformDateTimeNo
DeviceformDeviceNo
DuesRulesResponse Parameters:
NameParameterData TypeRequiredDescription
RulesformList<DuesRule>No
DuesRule Parameters:
NameParameterData TypeRequiredDescription
IDformintNo
NameformstringNo
DescriptionformstringNo
AmountformdoubleNo
SelectedformboolNo

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 /Ams/{ClientID}/DuesRules/ HTTP/1.1 
Host: ws.yourmembership.com 
Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"Rules":[{"ID":0,"Name":"String","Description":"String","Amount":0,"Selected":false}],"MemberID":0,"MembershipID":0,"UsingRedis":true,"AppInitTime":"2024-05-03T01:56:48.2404069-04:00","ServerID":"WS-5-59-079","ClientID":0,"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}},"BypassCache":false,"DateCached":"2024-05-03T02:47:29.5065199-04:00","Device":"Desktop"}