YM REST Services

<back to all web services

Ambassadors

Requires Authentication
Requires any of the roles:admin, oauthadmin
The following routes are available for this service:
GET/Ams/{ClientID}/AmbassadorsReturn a list of Ambassadors for the client.
POST/Ams/{ClientID}/AmbassadorsCreate an Ambassador for the client.
DELETE/Ams/{ClientID}/Ambassadors/{MemberID}Delete the Ambassador for the client.
Ambassadors Parameters:
NameParameterData TypeRequiredDescription
MemberIDpathintNo
PageSizebodyintNo
PageNumberbodyintNo
OffSetbodyintNo
BaseDto Parameters:
NameParameterData TypeRequiredDescription
UsingRedisformboolNo
AppInitTimeformDateTimeNo
ServerIDformstringNo
BaseSharedDto Parameters:
NameParameterData TypeRequiredDescription
ClientIDformintNo
ResponseStatusformResponseStatusNo
BypassCacheformboolNo
DateCachedformDateTimeNo
DeviceformDeviceNo
AmbassadorsResponse Parameters:
NameParameterData TypeRequiredDescription
AmbassadorsListformList<Ambassador>No
TotalResultsCountformintNo
Ambassador Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
FirstNameformstringNo
LastNameformstringNo
HeadShotImageformstringNo
DisplayNameformstringNo
MemberTypeformstringNo
WorkTitleformstringNo
RankformintNo
LatestActivityformDateTimeNo

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}/Ambassadors HTTP/1.1 
Host: ws.yourmembership.com 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"MemberID":0,"PageSize":0,"PageNumber":0,"OffSet":0,"UsingRedis":true,"AppInitTime":"2025-01-15T06:05:49.4554707-05:00","ServerID":"WS-6-64-014","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-15T09:04:01.8972270-05:00","Device":"Desktop"}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"AmbassadorsList":[{"Id":0,"FirstName":"String","LastName":"String","HeadShotImage":"String","DisplayName":"String","MemberType":"String","WorkTitle":"String","Rank":0,"LatestActivity":"0001-01-01T00:00:00.0000000"}],"TotalResultsCount":0,"MemberID":0,"PageSize":0,"PageNumber":0,"OffSet":0,"UsingRedis":true,"AppInitTime":"2025-01-15T06:05:49.4554707-05:00","ServerID":"WS-6-64-014","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-15T09:04:01.8972270-05:00","Device":"Desktop"}