Skip to content

Latest commit

 

History

History
92 lines (55 loc) · 1.66 KB

UsersApi.md

File metadata and controls

92 lines (55 loc) · 1.66 KB

TessJsonApi.UsersApi

All URIs are relative to https://tess.elixir-europe.org

Method HTTP request Description
usersGet GET /users
usersSlugGet GET /users/{slug}

usersGet

UserCollection usersGet()

Example

import TessJsonApi from 'tess_json_api';

let apiInstance = new TessJsonApi.UsersApi();
apiInstance.usersGet((error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

This endpoint does not need any parameter.

Return type

UserCollection

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/vnd.api+json

usersSlugGet

User usersSlugGet(slug)

Example

import TessJsonApi from 'tess_json_api';

let apiInstance = new TessJsonApi.UsersApi();
let slug = "slug_example"; // String | The _slug_ id of a user e.g. niall.beard
apiInstance.usersSlugGet(slug, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name Type Description Notes
slug String The slug id of a user e.g. niall.beard

Return type

User

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/vnd.api+json