Skip to content

REST Endpoints

aris alexis edited this page Feb 8, 2016 · 3 revisions

All rest endpoints deal with JSON data or query parameters in plain text and emit HTTP errors.
The {} notation indicates that the parameter is passed in the URL otherwise it must be posted as a JSON object or query params.
All requests go to https://exchange/rest + the rest of the endpoint.
Some endpoints are restricted and some are not. For example viewing an activity is not restricted but viweing a user's profile is.
If you pass a request to a restricted endpoint you will get a 401 unauthorized error.
Hitting the endpoint with /me works instead of providing the userId
{user} is either the userId or the email

Endpoint java code is under package jersey.

There is an open ticket to better the RESTful appearance where in some cases query params are more suitable or use of other verbs make more sense.

Clone this wiki locally