YM REST Services

<back to all web services

ConnectionCategoryList

Requires Authentication
Requires any of the roles:member, oauthmemberRequired permission:CanHaveBuddyList
The following routes are available for this service:
GET/Ams/{ClientID}/Member/{MemberID}/ConnectionCategoryListReturn a client's list of connection categories.
GET/Ams/{ClientID}/Member/{MemberID}/ConnectionCategoryList/{ProfileID}Return a member's connection category list.
ConnectionCategoryList Parameters:
NameParameterData TypeRequiredDescription
ProfileIDpathintNo
MemberBaseSharedDto Parameters:
NameParameterData TypeRequiredDescription
MemberIDformintNo
BaseSharedDto Parameters:
NameParameterData TypeRequiredDescription
ClientIDformintNo
ResponseStatusformResponseStatusNo
BypassCacheformboolNo
DateCachedformDateTimeNo
DeviceformDeviceNo
ConnectionCategoryListResponse Parameters:
NameParameterData TypeRequiredDescription
ConnectionCategoriesformList<ConnectionCategory>No
ConnectionCategory Parameters:
NameParameterData TypeRequiredDescription
CategoryIDformintNo
NameformstringNo
IndexTypeformdouble?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.

GET /Ams/{ClientID}/Member/{MemberID}/ConnectionCategoryList HTTP/1.1 
Host: ws.yourmembership.com 
Accept: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"ConnectionCategories":[{"CategoryID":0,"Name":"String","IndexType":0}],"ProfileID":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-03T02:42:09.9483806-04:00","Device":"Desktop"}