Quantimodo.UserApi

All URIs are relative to https://app.quantimo.do/api

Method	HTTP request	Description
deleteUser	DELETE /v3/user/delete	Delete user
getUser	GET /v3/user	Get user info
getUserBlogs	GET /v3/userBlogs	Get UserBlogs
getUsers	GET /v3/users	Get users who shared data
postUserBlogs	POST /v3/userBlogs	Post UserBlogs
postUserSettings	POST /v3/userSettings	Post UserSettings

deleteUser

CommonResponse deleteUser(reason, opts)

Delete user

Delete user account. Only the client app that created a user can delete that user.

Example

var Quantimodo = require('quantimodo');
var defaultClient = Quantimodo.ApiClient.instance;

// Configure API key authorization: access_token
var access_token = defaultClient.authentications['access_token'];
access_token.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//access_token.apiKeyPrefix = 'Token';

// Configure OAuth2 access token for authorization: quantimodo_oauth2
var quantimodo_oauth2 = defaultClient.authentications['quantimodo_oauth2'];
quantimodo_oauth2.accessToken = 'YOUR ACCESS TOKEN';

var apiInstance = new Quantimodo.UserApi();

var reason = "reason_example"; // String | Ex: I hate you!

var opts = { 
  'clientId': "clientId_example", // String | Your QuantiModo client id can be obtained by creating an app at https://builder.quantimo.do
  'platform': "platform_example" // String | Ex: chrome, android, ios, web
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.deleteUser(reason, opts, callback);

Parameters

Name	Type	Description	Notes
reason	String	Ex: I hate you!
clientId	String	Your QuantiModo client id can be obtained by creating an app at https://builder.quantimo.do	[optional]
platform	String	Ex: chrome, android, ios, web	[optional]

Return type

CommonResponse

Authorization

access_token, quantimodo_oauth2

HTTP request headers

Content-Type: application/json
Accept: application/json

getUser

User getUser(opts)

Get user info

Returns user info. If no userId is specified, returns info for currently authenticated user

Example

var Quantimodo = require('quantimodo');
var defaultClient = Quantimodo.ApiClient.instance;

// Configure API key authorization: access_token
var access_token = defaultClient.authentications['access_token'];
access_token.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//access_token.apiKeyPrefix = 'Token';

// Configure OAuth2 access token for authorization: quantimodo_oauth2
var quantimodo_oauth2 = defaultClient.authentications['quantimodo_oauth2'];
quantimodo_oauth2.accessToken = 'YOUR ACCESS TOKEN';

var apiInstance = new Quantimodo.UserApi();

var opts = { 
  'userId': 8.14, // Number | User's id
  'createdAt': "createdAt_example", // String | When the record was first created. Use UTC ISO 8601 YYYY-MM-DDThh:mm:ss datetime format. Time zone should be UTC and not local.
  'updatedAt': "updatedAt_example", // String | When the record was last updated. Use UTC ISO 8601 YYYY-MM-DDThh:mm:ss datetime format. Time zone should be UTC and not local.
  'limit': 100, // Number | The LIMIT is used to limit the number of results returned. So if youhave 1000 results, but only want to the first 10, you would set this to 10 and offset to 0. The maximum limit is 200 records.
  'offset': 56, // Number | OFFSET says to skip that many rows before beginning to return rows to the client. OFFSET 0 is the same as omitting the OFFSET clause.If both OFFSET and LIMIT appear, then OFFSET rows are skipped before starting to count the LIMIT rows that are returned.
  'sort': "sort_example", // String | Sort by one of the listed field names. If the field name is prefixed with `-`, it will sort in descending order.
  'clientId': "clientId_example", // String | Your QuantiModo client id can be obtained by creating an app at https://builder.quantimo.do
  'appVersion': "appVersion_example", // String | Ex: 2.1.1.0
  'clientUserId': 56, // Number | Ex: 74802
  'platform': "platform_example" // String | Ex: chrome, android, ios, web
  'log': "log_example", // String | Username or email
  'pwd': "pwd_example" // String | User password
  'includeAuthorizedClients': true // Boolean | Return list of apps, studies, and individuals with access to user data
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.getUser(opts, callback);

Parameters

Name	Type	Description	Notes
userId	Number	User's id	[optional]
createdAt	String	When the record was first created. Use UTC ISO 8601 YYYY-MM-DDThh:mm:ss datetime format. Time zone should be UTC and not local.	[optional]
updatedAt	String	When the record was last updated. Use UTC ISO 8601 YYYY-MM-DDThh:mm:ss datetime format. Time zone should be UTC and not local.	[optional]
limit	Number	The LIMIT is used to limit the number of results returned. So if youhave 1000 results, but only want to the first 10, you would set this to 10 and offset to 0. The maximum limit is 200 records.	[optional] [default to 100]
offset	Number	OFFSET says to skip that many rows before beginning to return rows to the client. OFFSET 0 is the same as omitting the OFFSET clause.If both OFFSET and LIMIT appear, then OFFSET rows are skipped before starting to count the LIMIT rows that are returned.	[optional]
sort	String	Sort by one of the listed field names. If the field name is prefixed with `-`, it will sort in descending order.	[optional]
clientId	String	Your QuantiModo client id can be obtained by creating an app at https://builder.quantimo.do	[optional]
appVersion	String	Ex: 2.1.1.0	[optional]
clientUserId	Number	Ex: 74802	[optional]
platform	String	Ex: chrome, android, ios, web	[optional]
log	String	Username or email	[optional]
pwd	String	User password	[optional]
includeAuthorizedClients	Boolean	Return list of apps, studies, and individuals with access to user data	[optional]

Return type

User

Authorization

access_token, quantimodo_oauth2

HTTP request headers

Content-Type: application/json
Accept: application/json

getUserBlogs

[UserBlogsResponse] getUserBlogs(opts)

Get UserBlogs

Example

var Quantimodo = require('quantimodo');
var defaultClient = Quantimodo.ApiClient.instance;

// Configure API key authorization: access_token
var access_token = defaultClient.authentications['access_token'];
access_token.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//access_token.apiKeyPrefix = 'Token';

// Configure OAuth2 access token for authorization: quantimodo_oauth2
var quantimodo_oauth2 = defaultClient.authentications['quantimodo_oauth2'];
quantimodo_oauth2.accessToken = 'YOUR ACCESS TOKEN';

var apiInstance = new Quantimodo.UserApi();

var opts = { 
  'sort': "sort_example", // String | Sort by one of the listed field names. If the field name is prefixed with `-`, it will sort in descending order.
  'limit': 100, // Number | The LIMIT is used to limit the number of results returned. So if youhave 1000 results, but only want to the first 10, you would set this to 10 and offset to 0. The maximum limit is 200 records.
  'offset': 56, // Number | OFFSET says to skip that many rows before beginning to return rows to the client. OFFSET 0 is the same as omitting the OFFSET clause.If both OFFSET and LIMIT appear, then OFFSET rows are skipped before starting to count the LIMIT rows that are returned.
  'updatedAt': "updatedAt_example", // String | When the record was last updated. Use UTC ISO 8601 YYYY-MM-DDThh:mm:ss datetime format. Time zone should be UTC and not local.
  'userId': 8.14, // Number | User's id
  'createdAt': "createdAt_example", // String | When the record was first created. Use UTC ISO 8601 YYYY-MM-DDThh:mm:ss datetime format. Time zone should be UTC and not local.
  'id': 56, // Number | Id
  'clientId': "clientId_example", // String | Your QuantiModo client id can be obtained by creating an app at https://builder.quantimo.do
  'platform': "platform_example" // String | Ex: chrome, android, ios, web
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.getUserBlogs(opts, callback);

Parameters

Name	Type	Description	Notes
sort	String	Sort by one of the listed field names. If the field name is prefixed with `-`, it will sort in descending order.	[optional]
limit	Number	The LIMIT is used to limit the number of results returned. So if youhave 1000 results, but only want to the first 10, you would set this to 10 and offset to 0. The maximum limit is 200 records.	[optional] [default to 100]
offset	Number	OFFSET says to skip that many rows before beginning to return rows to the client. OFFSET 0 is the same as omitting the OFFSET clause.If both OFFSET and LIMIT appear, then OFFSET rows are skipped before starting to count the LIMIT rows that are returned.	[optional]
updatedAt	String	When the record was last updated. Use UTC ISO 8601 YYYY-MM-DDThh:mm:ss datetime format. Time zone should be UTC and not local.	[optional]
userId	Number	User's id	[optional]
createdAt	String	When the record was first created. Use UTC ISO 8601 YYYY-MM-DDThh:mm:ss datetime format. Time zone should be UTC and not local.	[optional]
id	Number	Id	[optional]
clientId	String	Your QuantiModo client id can be obtained by creating an app at https://builder.quantimo.do	[optional]
platform	String	Ex: chrome, android, ios, web	[optional]

Return type

[UserBlogsResponse]

Authorization

access_token, quantimodo_oauth2

HTTP request headers

Content-Type: application/json
Accept: application/json

getUsers

UsersResponse getUsers(opts)

Get users who shared data

Returns users who have granted access to their data

Example

var Quantimodo = require('quantimodo');
var defaultClient = Quantimodo.ApiClient.instance;

// Configure API key authorization: access_token
var access_token = defaultClient.authentications['access_token'];
access_token.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//access_token.apiKeyPrefix = 'Token';

// Configure OAuth2 access token for authorization: quantimodo_oauth2
var quantimodo_oauth2 = defaultClient.authentications['quantimodo_oauth2'];
quantimodo_oauth2.accessToken = 'YOUR ACCESS TOKEN';

var apiInstance = new Quantimodo.UserApi();

var opts = { 
  'userId': 8.14, // Number | User's id
  'createdAt': "createdAt_example", // String | When the record was first created. Use UTC ISO 8601 YYYY-MM-DDThh:mm:ss datetime format. Time zone should be UTC and not local.
  'updatedAt': "updatedAt_example", // String | When the record was last updated. Use UTC ISO 8601 YYYY-MM-DDThh:mm:ss datetime format. Time zone should be UTC and not local.
  'limit': 100, // Number | The LIMIT is used to limit the number of results returned. So if youhave 1000 results, but only want to the first 10, you would set this to 10 and offset to 0. The maximum limit is 200 records.
  'offset': 56, // Number | OFFSET says to skip that many rows before beginning to return rows to the client. OFFSET 0 is the same as omitting the OFFSET clause.If both OFFSET and LIMIT appear, then OFFSET rows are skipped before starting to count the LIMIT rows that are returned.
  'sort': "sort_example", // String | Sort by one of the listed field names. If the field name is prefixed with `-`, it will sort in descending order.
  'clientId': "clientId_example", // String | Your QuantiModo client id can be obtained by creating an app at https://builder.quantimo.do
  'appVersion': "appVersion_example", // String | Ex: 2.1.1.0
  'clientUserId': 56, // Number | Ex: 74802
  'platform': "platform_example" // String | Ex: chrome, android, ios, web
  'log': "log_example", // String | Username or email
  'pwd': "pwd_example" // String | User password
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.getUsers(opts, callback);

Parameters

Name	Type	Description	Notes
userId	Number	User's id	[optional]
createdAt	String	When the record was first created. Use UTC ISO 8601 YYYY-MM-DDThh:mm:ss datetime format. Time zone should be UTC and not local.	[optional]
updatedAt	String	When the record was last updated. Use UTC ISO 8601 YYYY-MM-DDThh:mm:ss datetime format. Time zone should be UTC and not local.	[optional]
limit	Number	The LIMIT is used to limit the number of results returned. So if youhave 1000 results, but only want to the first 10, you would set this to 10 and offset to 0. The maximum limit is 200 records.	[optional] [default to 100]
offset	Number	OFFSET says to skip that many rows before beginning to return rows to the client. OFFSET 0 is the same as omitting the OFFSET clause.If both OFFSET and LIMIT appear, then OFFSET rows are skipped before starting to count the LIMIT rows that are returned.	[optional]
sort	String	Sort by one of the listed field names. If the field name is prefixed with `-`, it will sort in descending order.	[optional]
clientId	String	Your QuantiModo client id can be obtained by creating an app at https://builder.quantimo.do	[optional]
appVersion	String	Ex: 2.1.1.0	[optional]
clientUserId	Number	Ex: 74802	[optional]
platform	String	Ex: chrome, android, ios, web	[optional]
log	String	Username or email	[optional]
pwd	String	User password	[optional]

Return type

UsersResponse

Authorization

access_token, quantimodo_oauth2

HTTP request headers

Content-Type: application/json
Accept: application/json

postUserBlogs

[UserBlogsResponse] postUserBlogs(opts)

Post UserBlogs

Example

var Quantimodo = require('quantimodo');
var defaultClient = Quantimodo.ApiClient.instance;

// Configure API key authorization: access_token
var access_token = defaultClient.authentications['access_token'];
access_token.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//access_token.apiKeyPrefix = 'Token';

// Configure OAuth2 access token for authorization: quantimodo_oauth2
var quantimodo_oauth2 = defaultClient.authentications['quantimodo_oauth2'];
quantimodo_oauth2.accessToken = 'YOUR ACCESS TOKEN';

var apiInstance = new Quantimodo.UserApi();

var opts = { 
  'sort': "sort_example", // String | Sort by one of the listed field names. If the field name is prefixed with `-`, it will sort in descending order.
  'limit': 100, // Number | The LIMIT is used to limit the number of results returned. So if youhave 1000 results, but only want to the first 10, you would set this to 10 and offset to 0. The maximum limit is 200 records.
  'offset': 56, // Number | OFFSET says to skip that many rows before beginning to return rows to the client. OFFSET 0 is the same as omitting the OFFSET clause.If both OFFSET and LIMIT appear, then OFFSET rows are skipped before starting to count the LIMIT rows that are returned.
  'updatedAt': "updatedAt_example", // String | When the record was last updated. Use UTC ISO 8601 YYYY-MM-DDThh:mm:ss datetime format. Time zone should be UTC and not local.
  'userId': 8.14, // Number | User's id
  'createdAt': "createdAt_example", // String | When the record was first created. Use UTC ISO 8601 YYYY-MM-DDThh:mm:ss datetime format. Time zone should be UTC and not local.
  'id': 56, // Number | Id
  'clientId': "clientId_example", // String | Your QuantiModo client id can be obtained by creating an app at https://builder.quantimo.do
  'platform': "platform_example" // String | Ex: chrome, android, ios, web
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.postUserBlogs(opts, callback);

Parameters

Name	Type	Description	Notes
sort	String	Sort by one of the listed field names. If the field name is prefixed with `-`, it will sort in descending order.	[optional]
limit	Number	The LIMIT is used to limit the number of results returned. So if youhave 1000 results, but only want to the first 10, you would set this to 10 and offset to 0. The maximum limit is 200 records.	[optional] [default to 100]
offset	Number	OFFSET says to skip that many rows before beginning to return rows to the client. OFFSET 0 is the same as omitting the OFFSET clause.If both OFFSET and LIMIT appear, then OFFSET rows are skipped before starting to count the LIMIT rows that are returned.	[optional]
updatedAt	String	When the record was last updated. Use UTC ISO 8601 YYYY-MM-DDThh:mm:ss datetime format. Time zone should be UTC and not local.	[optional]
userId	Number	User's id	[optional]
createdAt	String	When the record was first created. Use UTC ISO 8601 YYYY-MM-DDThh:mm:ss datetime format. Time zone should be UTC and not local.	[optional]
id	Number	Id	[optional]
clientId	String	Your QuantiModo client id can be obtained by creating an app at https://builder.quantimo.do	[optional]
platform	String	Ex: chrome, android, ios, web	[optional]

Return type

[UserBlogsResponse]

Authorization

access_token, quantimodo_oauth2

HTTP request headers

Content-Type: application/json
Accept: application/json

postUserSettings

PostUserSettingsResponse postUserSettings(body, opts)

Post UserSettings

Example

var Quantimodo = require('quantimodo');

var apiInstance = new Quantimodo.UserApi();

var body = new Quantimodo.User(); // User | User settings to update

var opts = { 
  'clientId': "clientId_example", // String | Your QuantiModo client id can be obtained by creating an app at https://builder.quantimo.do
  'platform': "platform_example" // String | Ex: chrome, android, ios, web
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.postUserSettings(body, opts, callback);

Parameters

Name	Type	Description	Notes
body	User	User settings to update
clientId	String	Your QuantiModo client id can be obtained by creating an app at https://builder.quantimo.do	[optional]
platform	String	Ex: chrome, android, ios, web	[optional]

Return type

PostUserSettingsResponse

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Quantimodo.UserApi

deleteUser

Example

Parameters

Return type

Authorization

HTTP request headers

getUser

Example

Parameters

Return type

Authorization

HTTP request headers

getUserBlogs

Example

Parameters

Return type

Authorization

HTTP request headers

getUsers

Example

Parameters

Return type

Authorization

HTTP request headers

postUserBlogs

Example

Parameters

Return type

Authorization

HTTP request headers

postUserSettings

Example

Parameters

Return type

Authorization

HTTP request headers

FilesExpand file tree

UserApi.md

Latest commit

History

UserApi.md

File metadata and controls

Quantimodo.UserApi

deleteUser

Example

Parameters

Return type

Authorization

HTTP request headers

getUser

Example

Parameters

Return type

Authorization

HTTP request headers

getUserBlogs

Example

Parameters

Return type

Authorization

HTTP request headers

getUsers

Example

Parameters

Return type

Authorization

HTTP request headers

postUserBlogs

Example

Parameters

Return type

Authorization

HTTP request headers

postUserSettings

Example

Parameters

Return type

Authorization

HTTP request headers