YM REST Services

<back to all web services

CustomPageMemberTypes

Requires Authentication
Requires any of the roles:admin, oauthadmin
The following routes are available for this service:
GET/Ams/{ClientID}/CustomPageMemberTypesReturn a list of member types for a custom page.
CustomPageMemberTypes Parameters:
NameParameterData TypeRequiredDescription
PageIDqueryintNo
MemberBaseSharedDto Parameters:
NameParameterData TypeRequiredDescription
MemberIDformintNo
BaseSharedDto Parameters:
NameParameterData TypeRequiredDescription
ClientIDformintNo
ResponseStatusformResponseStatusNo
BypassCacheformboolNo
DateCachedformDateTimeNo
DeviceformDeviceNo
CustomPageMemberTypesResponse Parameters:
NameParameterData TypeRequiredDescription
CustomPageMemberTypesformList<CustomMemberType>No
CustomMemberType Parameters:
NameParameterData TypeRequiredDescription
TypeIDformintNo
TypeNameformstringNo
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}/CustomPageMemberTypes HTTP/1.1 
Host: ws.yourmembership.com 
Accept: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"CustomPageMemberTypes":[{"TypeID":0,"TypeName":"String","Selected":false}],"PageID":0,"MemberID":0,"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:03:51.4516614-04:00","Device":"Desktop"}