YM REST Services

<back to all web services

MembershipModifiers

Requires Authentication
Requires any of the roles:admin, oauthadminRequires the permission:CanAdminMembers
The following routes are available for this service:
GET/Ams/{ClientID}/MembershipModifiers/{MembershipID}Return a list of membership modifiers for the given membership ID.
MembershipModifiers Parameters:
NameParameterData TypeRequiredDescription
MembershipIDpathintNo
BaseDto Parameters:
NameParameterData TypeRequiredDescription
UsingRedisformboolNo
AppInitTimeformDateTimeNo
ServerIDformstringNo
BaseSharedDto Parameters:
NameParameterData TypeRequiredDescription
ClientIDformintNo
ResponseStatusformResponseStatusNo
BypassCacheformboolNo
DateCachedformDateTimeNo
DeviceformDeviceNo
MembershipModifiersResponse Parameters:
NameParameterData TypeRequiredDescription
ModifierListformList<MembershipModifier>No
MembershipModifier Parameters:
NameParameterData TypeRequiredDescription
IDformintNo
NameformstringNo
AdjustedNameformstringNo
DescriptionformstringNo
AmountformdoubleNo
AdjustedAmountformdoubleNo
RequiredformboolNo
FactoredformboolNo
MinFactorformdoubleNo
MaxFactorformdoubleNo
FactorformdoubleNo
AllowProRateformboolNo
CategoryIDformintNo
CategoryNameformstringNo
SelectedformboolNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /Ams/{ClientID}/MembershipModifiers/{MembershipID} HTTP/1.1 
Host: ws.yourmembership.com 
Accept: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"ModifierList":[{"ID":0,"Name":"String","AdjustedName":"String","Description":"String","Amount":0,"AdjustedAmount":0,"Required":false,"Factored":false,"MinFactor":0,"MaxFactor":9999999999,"Factor":0,"AllowProRate":false,"CategoryID":0,"CategoryName":"String","Selected":false}],"MembershipID":0,"UsingRedis":true,"AppInitTime":"2024-05-03T06:25:33.7052010-04:00","ServerID":"WS-6-183-431","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-03T08:28:49.5649294-04:00","Device":"Desktop"}