YM REST Services

<back to all web services

SingleMembership

Requires Authentication
Requires any of the roles:admin, oauthadminRequires the permission:CanAdminMembers
The following routes are available for this service:
GET/Ams/{ClientID}/Membership/Return. the data for a single membership.With cache is GET.
GET/Ams/{ClientID}/Membership/{Id}Return the data for a single membership.With cache is GET.
SingleMembership Parameters:
NameParameterData TypeRequiredDescription
IdpathintNo
ExpirationDatequerystringNo
BaseDto Parameters:
NameParameterData TypeRequiredDescription
UsingRedisformboolNo
AppInitTimeformDateTimeNo
ServerIDformstringNo
BaseSharedDto Parameters:
NameParameterData TypeRequiredDescription
ClientIDformintNo
ResponseStatusformResponseStatusNo
BypassCacheformboolNo
DateCachedformDateTimeNo
DeviceformDeviceNo
MembershipResponse Parameters:
NameParameterData TypeRequiredDescription
MembershipformMembershipNo
Membership Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
CodeformstringNo
NameformstringNo
DuesAmountformdoubleNo
ProRatedDuesformboolNo
ProRateFactorformdoubleNo
AllowMultipleOpenInvoicesformboolNo

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

{"Membership":{"Id":0,"Code":"String","Name":"String","DuesAmount":0,"ProRatedDues":false,"ProRateFactor":0,"AllowMultipleOpenInvoices":false},"Id":0,"ExpirationDate":"String","UsingRedis":true,"AppInitTime":"2024-05-03T08:23:16.9245126-04:00","ServerID":"WS-6-134-823","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:54:50.7230549-04:00","Device":"Desktop"}