YM REST Services

<back to all web services

MemberTypes

Requires Authentication
Requires any of the roles:admin, oauthadminRequires any of the permissions:/admin/control/, /admin/events/
The following routes are available for this service:
GET/Ams/{ClientID}/MemberTypesReturns the member types for this client - with cache.
MemberTypes Parameters:
NameParameterData TypeRequiredDescription
IDqueryintNo
SortByquerySortByEnumNo

Allowable Values

  • Default
  • SortOrder
  • TypeName
  • TypeCode
BaseDto Parameters:
NameParameterData TypeRequiredDescription
UsingRedisformboolNo
AppInitTimeformDateTimeNo
ServerIDformstringNo
BaseSharedDto Parameters:
NameParameterData TypeRequiredDescription
ClientIDformintNo
ResponseStatusformResponseStatusNo
BypassCacheformboolNo
DateCachedformDateTimeNo
DeviceformDeviceNo
MemberTypesResponse Parameters:
NameParameterData TypeRequiredDescription
MemberTypesformList<MemberType>No
MemberType Parameters:
NameParameterData TypeRequiredDescription
IDformintNo
TypeCodeformstringNo
NameformstringNo
IsDefaultformboolNo
VisibilityformintNo
PresetTypeformstringNo
SortOrderformdoubleNo

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

{"MemberTypes":[{"ID":0,"TypeCode":"String","Name":"String","IsDefault":false,"Visibility":0,"PresetType":"String","SortOrder":0}],"ID":0,"SortBy":"Default","UsingRedis":true,"AppInitTime":"2024-05-03T05:25:12.6676464-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-03T07:06:13.6423591-04:00","Device":"Desktop"}