YM REST Services

<back to all web services

GroupJoin

Requires Authentication
Requires any of the roles:member, oauthmember, admin, oauthadmin
The following routes are available for this service:
POST/Ams/{ClientID}/Member/{MemberID}/GroupJoinMember request to join a group.
GroupJoin Parameters:
NameParameterData TypeRequiredDescription
GroupIDbodyintNo
MemberBaseSharedDto Parameters:
NameParameterData TypeRequiredDescription
MemberIDformintNo
BaseSharedDto Parameters:
NameParameterData TypeRequiredDescription
ClientIDformintNo
ResponseStatusformResponseStatusNo
BypassCacheformboolNo
DateCachedformDateTimeNo
DeviceformDeviceNo
GroupJoinResponse Parameters:
NameParameterData TypeRequiredDescription
GroupTypeformGroupTypeNo
GroupType Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
TypeNameformstringNo
SortIndexformdouble?No
GroupsformList<Group>No
Group Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
NameformstringNo
StatusformStatus?No
JoinOptionformJoinOption?No

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

{"GroupID":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-03T06:14:54.3283653-04:00","Device":"Desktop"}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"GroupType":{"Id":0,"TypeName":"String","SortIndex":0,"Groups":[{"Id":0,"Name":"String","Status":"None","JoinOption":"CanJoin"}]},"GroupID":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-03T06:14:54.3439900-04:00","Device":"Desktop"}