YM REST Services

<back to all web services

Members

Requires Authentication
Requires any of the roles:admin, oauthadminRequired permission:CanAdminMembers
The following routes are available for this service:
POST/Ams/{ClientID}/MembersCreate a new member.
PUT/Ams/{ClientID}/MembersUpdate the primary address of an existing member.
GET/Ams/{ClientID}/Members/{id}Get the details of a member.
Members Parameters:
NameParameterData TypeRequiredDescription
typeCodebodystringNo
Person Parameters:
NameParameterData TypeRequiredDescription
idformintNo
organizationformstringNo
firstNameformstringNo
lastNameformstringNo
middleNameformstringNo
nameSuffixformstringNo
emailAddressformstringNo
primaryAddressformAddressNo
usernameformstringNo
passwordformstringNo
isMemberformboolNo
expirationDateformstringNo
currentMembershipAllowsMultipleOpenInvoicesformboolNo
currentMembershipInvoiceIsOpenformboolNo
currentMembershipInvoiceAwaitingAutoBillformboolNo
BaseDto Parameters:
NameParameterData TypeRequiredDescription
UsingRedisformboolNo
AppInitTimeformDateTimeNo
ServerIDformstringNo
BaseSharedDto Parameters:
NameParameterData TypeRequiredDescription
ClientIDformintNo
ResponseStatusformResponseStatusNo
BypassCacheformboolNo
DateCachedformDateTimeNo
DeviceformDeviceNo
Address Parameters:
NameParameterData TypeRequiredDescription
firstNameformstringNo
lastNameformstringNo
organizationformstringNo
address1formstringNo
address2formstringNo
cityformstringNo
locationformstringNo
postalCodeformstringNo
countryCodeformstringNo
countryNameformstringNo
areaCodeformstringNo
phoneformstringNo
MembersResponse Parameters:
NameParameterData TypeRequiredDescription
memberTypeIdformintNo

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.

POST /Ams/{ClientID}/Members HTTP/1.1 
Host: ws.yourmembership.com 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"typeCode":"String","id":0,"organization":"String","firstName":"String","lastName":"String","middleName":"String","nameSuffix":"String","emailAddress":"String","primaryAddress":{"firstName":"String","lastName":"String","organization":"String","address1":"String","address2":"String","city":"String","location":"String","postalCode":"String","countryCode":"String","countryName":"String","areaCode":"String","phone":"String"},"username":"String","password":"String","isMember":false,"expirationDate":"String","currentMembershipAllowsMultipleOpenInvoices":false,"currentMembershipInvoiceIsOpen":false,"currentMembershipInvoiceAwaitingAutoBill":false,"UsingRedis":true,"AppInitTime":"2025-01-15T06:36:34.5424027-05:00","ServerID":"WS-5-212-532","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":"2025-01-15T08:59:21.8166262-05:00","Device":"Desktop"}

HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"memberTypeId":0,"typeCode":"String","id":0,"organization":"String","firstName":"String","lastName":"String","middleName":"String","nameSuffix":"String","emailAddress":"String","primaryAddress":{"firstName":"String","lastName":"String","organization":"String","address1":"String","address2":"String","city":"String","location":"String","postalCode":"String","countryCode":"String","countryName":"String","areaCode":"String","phone":"String"},"username":"String","password":"String","isMember":false,"expirationDate":"String","currentMembershipAllowsMultipleOpenInvoices":false,"currentMembershipInvoiceIsOpen":false,"currentMembershipInvoiceAwaitingAutoBill":false,"UsingRedis":true,"AppInitTime":"2025-01-15T06:36:34.5424027-05:00","ServerID":"WS-5-212-532","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":"2025-01-15T08:59:21.8166262-05:00","Device":"Desktop"}