YM REST Services

<back to all web services

Favorites

Requires Authentication
Requires any of the roles:member, oauthmember
The following routes are available for this service:
GET/Ams/{ClientID}/Member/{MemberID}/FavoritesReturn a list of favorite URLs for a member.
POST/Ams/{ClientID}/Member/{MemberID}/FavoritesAdd a favorite URL to member profile.
PUT/Ams/{ClientID}/Member/{MemberID}/Favorites/{Id}Update an existing favorite URL for a member.
DELETE/Ams/{ClientID}/Member/{MemberID}/Favorites/{Id}Removes a favorite URL from member profile.
Favorites Parameters:
NameParameterData TypeRequiredDescription
CategorybodystringNo
PageNumberbodyintNo
PageSizebodyintNo
Favorite Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
TypeIdformstringNo
TypeNameformstringNo
TitleformstringNo
FavoriteParametersformstringNo
IsPrivateformstringNo
UrlformstringNo
IconformstringNo
MemberBaseSharedDto Parameters:
NameParameterData TypeRequiredDescription
MemberIDformintNo
BaseSharedDto Parameters:
NameParameterData TypeRequiredDescription
ClientIDformintNo
ResponseStatusformResponseStatusNo
BypassCacheformboolNo
DateCachedformDateTimeNo
DeviceformDeviceNo
FavoritesResponse Parameters:
NameParameterData TypeRequiredDescription
CategoryListformList<FavoriteCategory>No
FavoriteCategory Parameters:
NameParameterData TypeRequiredDescription
CategoryformstringNo
FavoriteItemsformList<Favorite>No

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /Ams/{ClientID}/Member/{MemberID}/Favorites HTTP/1.1 
Host: ws.yourmembership.com 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"Category":"String","PageNumber":0,"PageSize":0,"Id":0,"TypeId":"String","TypeName":"String","Title":"String","FavoriteParameters":"String","IsPrivate":"String","Url":"String","Icon":"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-03T02:07:56.8788124-04:00","Device":"Desktop"}

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"CategoryList":[{"Category":"String","FavoriteItems":[{"Id":0,"TypeId":"String","TypeName":"String","Title":"String","FavoriteParameters":"String","IsPrivate":"String","Url":"String","Icon":"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-03T02:07:56.8888062-04:00","Device":"Desktop"}]}],"Category":"String","PageNumber":0,"PageSize":0,"Id":0,"TypeId":"String","TypeName":"String","Title":"String","FavoriteParameters":"String","IsPrivate":"String","Url":"String","Icon":"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-03T02:07:56.8908039-04:00","Device":"Desktop"}