YM REST Services

<back to all web services

BasicMemberProfile

Requires Authentication
Requires any of the roles:member, oauthmember
The following routes are available for this service:
GET/Ams/{ClientID}/Member/{MemberID}/BasicMemberProfileReturn the basic information of a member.
MemberBaseSharedDto Parameters:
NameParameterData TypeRequiredDescription
MemberIDformintNo
BaseSharedDto Parameters:
NameParameterData TypeRequiredDescription
ClientIDformintNo
ResponseStatusformResponseStatusNo
BypassCacheformboolNo
DateCachedformDateTimeNo
DeviceformDeviceNo
BasicMemberProfileResponse Parameters:
NameParameterData TypeRequiredDescription
FirstNameformstringNo
LastNameformstringNo
EmailformstringNo
MemberTypeformstringNo
HeadshotImageformstringNo

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

{"FirstName":"String","LastName":"String","Email":"String","MemberType":"String","HeadshotImage":"String","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-03T10:41:07.8156744-04:00","Device":"Desktop"}