YM REST Services

<back to all web services

OAuthScopes

Requires Authentication
Requires the role:admin
The following routes are available for this service:
GET/Ams/{ClientID}/OAuthScopesReturn a list of OAuth scopes.
MemberBaseSharedDto Parameters:
NameParameterData TypeRequiredDescription
MemberIDformintNo
BaseSharedDto Parameters:
NameParameterData TypeRequiredDescription
ClientIDformintNo
ResponseStatusformResponseStatusNo
BypassCacheformboolNo
DateCachedformDateTimeNo
DeviceformDeviceNo
OAuthScopesResponse Parameters:
NameParameterData TypeRequiredDescription
ScopeListformList<Scope>No
Scope Parameters:
NameParameterData TypeRequiredDescription
ScopeIDformintNo
ScopeNameformstringNo
DisplayNameformstringNo
IsDefaultformboolNo
GranularScopeformintNo

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.

GET /Ams/{ClientID}/OAuthScopes HTTP/1.1 
Host: ws.yourmembership.com 
Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"ScopeList":[{"ScopeID":0,"ScopeName":"String","DisplayName":"String","IsDefault":false,"GranularScope":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:25:33.0057992-04:00","Device":"Desktop"}