9/2/2021 Avatar API

Documentation Settings

Avatar API

Auth

POST Login

{{baseUrl}}/login

For test purpose: email: [[email protected] (mailto:[email protected])], password:[123abc]

BODY raw

{
"email":"[email protected]",
"password":"123abc"
}

Example Request Login - Invalid Email

var client = new RestClient("https://apistaging.daneuroperesearchandinnovation.eu/login");

client.Timeout = -1;
var request = new RestRequest(Method.POST);
request.AddParameter("text/plain", "{\r\n\t\"email\":\"invalidEmailm\",\r\n\t\"password\":\"validPassword\
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);

https://documenter.getpostman.com/view/1487903/T17M7QzW?version=latest#ca13350d-4a1b-4d73-a9af-1cf445ae3c0c 1/14
9/2/2021 Avatar API

Example Response 422 Unprocessable Entity

Documentation Settings

Body Headers (18)

{
"errors": [
"The email must be a valid email address."
]
}

POST Register

{{baseUrl}}/register

BODY raw

{
"email":"[email protected]",
"password":"abc123",
"passwordConfirmation":"abc123",
"firstName":"Test",
"lastName":"3"
}

Example Request Register

var client = new RestClient("{{baseUrl}}/register");

client.Timeout = -1;
var request = new RestRequest(Method.POST);
request.AddParameter("text/plain", "{\r\n \"email\":\"[email protected]\",\r\n \"password\":\"abc123\",\
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);

GET Password Change

https://documenter.getpostman.com/view/1487903/T17M7QzW?version=latest#ca13350d-4a1b-4d73-a9af-1cf445ae3c0c 2/14
9/2/2021 Avatar API

{{baseUrl}}/password-change
Documentation Settings

AUTHORIZATION

Bearer Token
Token
{{token}}

BODY raw

{
"password":"abc123"
}

Example Request Password Change - Success

var client = new RestClient("{{baseUrl}}/password-change");

client.Timeout = -1;
var request = new RestRequest(Method.POST);
request.AddParameter("text/plain", "{\r\n \"password\":\"abc123\"\r\n}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);

Example Response 200 OK

Body Headers (21)

{
"message": "Password updated successfully"
}

Samples

https://documenter.getpostman.com/view/1487903/T17M7QzW?version=latest#ca13350d-4a1b-4d73-a9af-1cf445ae3c0c 3/14
9/2/2021 Avatar API

Documentation Settings
POST Create Samples

{{baseUrl}}/samples

In the responce the data object is the received data if an error is present. In case of success the data object
is the sample created.

The project_id paramiter is implemented for future developments and can be ignored at the moment.

AUTHORIZATION
Bearer Token

Token
{{token}}

BODY raw

{
"data":[
{
"date":1593964684,
"value":[23.3],
"userId":3,
"measureType":"HeartRate"
},
{
View More
"date":1593964684,

Example Request Create Samples - Errors

var client = new RestClient("https://apistaging.daneuroperesearchandinnovation.eu/samples");

client.Timeout = -1;
var request = new RestRequest(Method.POST);
request.AddParameter("text/plain", "{\r\n \"data\":[\r\n {\r\n \"date\":1593964684,\r
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);

Example Response 422 Unprocessable Entity

https://documenter.getpostman.com/view/1487903/T17M7QzW?version=latest#ca13350d-4a1b-4d73-a9af-1cf445ae3c0c 4/14
9/2/2021 Avatar API

Body Headers (19)

Documentation Settings

{
"message": "One or more samples were invalid"
}

GET Get Samples by month

{{baseUrl}}/samples

AUTHORIZATION

Bearer Token
Token

{{token}}

BODY raw

{
"userId":3,
"month":6,
"year":2020
}

Example Request Create Samples - Errors

var client = new RestClient("https://apistaging.daneuroperesearchandinnovation.eu/samples");

client.Timeout = -1;
var request = new RestRequest(Method.POST);
request.AddParameter("text/plain", "{\r\n \"data\":[\r\n {\r\n \"date\":1593964684,\r
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);

Example Response 422 Unprocessable Entity

Body Headers (19)

https://documenter.getpostman.com/view/1487903/T17M7QzW?version=latest#ca13350d-4a1b-4d73-a9af-1cf445ae3c0c 5/14
9/2/2021 Avatar API

{ Documentation Settings
"message": "One or more samples were invalid"
}

GET Get Samples By Date

{{baseUrl}}/samplesByDate

AUTHORIZATION
Bearer Token

Token
{{token}}

BODY raw

{
"userId":3,
"sensorId":"1",
"date":"2020-07-16"
}

Example Request Get Samples By Date

var client = new RestClient("{{baseUrl}}/samplesByDate");

client.Timeout = -1;
var request = new RestRequest(Method.GET);
request.AddParameter("text/plain", "{\r\n \"userId\":3,\r\n \"sensorId\":\"1\",\r\n \"date\":\"20
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);

GET Get Latest Sample

{{baseUrl}}/latestSample
https://documenter.getpostman.com/view/1487903/T17M7QzW?version=latest#ca13350d-4a1b-4d73-a9af-1cf445ae3c0c 6/14
9/2/2021 Avatar API

Documentation Settings

AUTHORIZATION
Bearer Token

Token
{{token}}

BODY raw

{
"userId":3,
"sensorId":"1",
"date":"2020-08-13"
}

Example Request Get Latest Sample

var client = new RestClient("{{baseUrl}}/latestSample");

client.Timeout = -1;
var request = new RestRequest(Method.GET);
request.AddParameter("text/plain", "{\r\n \"userId\":3,\r\n \"sensorId\":\"1\",\r\n \"date\":\"20
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);

GET Get Samples By Date Partial

{{baseUrl}}/samplesByDate

AUTHORIZATION
Bearer Token
Token
{{token}}

BODY raw

https://documenter.getpostman.com/view/1487903/T17M7QzW?version=latest#ca13350d-4a1b-4d73-a9af-1cf445ae3c0c 7/14
9/2/2021 Avatar API

{
Documentation Settings
"userId":3,
"startDate":"1596499201000",
"endDate":"1596578401000",
"sensorId":"1"
}

Example Request Get Samples By Date Partial

var client = new RestClient("{{baseUrl}}/samplesByDate");

client.Timeout = -1;
var request = new RestRequest(Method.GET);
request.AddParameter("text/plain", "{\r\n \"userId\":3,\r\n \"startDate\":\"1596499201000\",\r\n
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);

Alert

POST Create an Alert

{{baseUrl}}/alert

AUTHORIZATION
Bearer Token
Token
{{token}}

BODY formdata

date

1593964684
UnixTIme - Required

https://documenter.getpostman.com/view/1487903/T17M7QzW?version=latest#ca13350d-4a1b-4d73-a9af-1cf445ae3c0c 8/14
9/2/2021 Avatar API

userId Documentation Settings

3
Optional

Example Request Create an Alert - Success

var client = new RestClient("{{baseUrl}}/alert");

client.Timeout = -1;
var request = new RestRequest(Method.POST);
request.AddParameter("text/plain", "{\r\n \"date\":1593964684,\r\n \"userId\":2\r\n}", ParameterTyp
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);

Example Response 200 OK

Body Headers (12)

{
"success": "Alert succesfully created"
}

Account

GET Me

{{baseUrl}}/account/me

AUTHORIZATION
Bearer Token
Token

https://documenter.getpostman.com/view/1487903/T17M7QzW?version=latest#ca13350d-4a1b-4d73-a9af-1cf445ae3c0c 9/14
9/2/2021 Avatar API

{{token}}
Documentation Settings

Example Request Me

var client = new RestClient("{{baseUrl}}/account/me");

client.Timeout = -1;
var request = new RestRequest(Method.GET);
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);

PUT Update Account

{{baseUrl}}/account/update

AUTHORIZATION

Bearer Token
Token
{{token}}

BODY raw

{
"firstName": "Test",
"lastName": "133",
"email": "[email protected]",
"phone": "+4463805631031",
"country": "IT",
"birthDate": "2002-10-13"
}

Example Request Update Account

https://documenter.getpostman.com/view/1487903/T17M7QzW?version=latest#ca13350d-4a1b-4d73-a9af-1cf445ae3c0c 10/14
9/2/2021 Avatar API

var client = new RestClient("{{baseUrl}}/account/update"); Documentation Settings

client.Timeout = -1;
var request = new RestRequest(Method.PUT);
request.AddParameter("text/plain", "{\r\n \"firstName\": \"Test\",\r\n \"lastName\": \"133\",\r\n
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);

POST Upload Image

{{baseUrl}}/account/upload-avatar

AUTHORIZATION
Bearer Token

Token
{{token}}

BODY raw

{
"avatar": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAPAAAADwCAYAAAA+VemSAAAgAElEQVR4XoS

Example Request Upload Image

var client = new RestClient("{{baseUrl}}/account/upload-avatar");

client.Timeout = -1;
var request = new RestRequest(Method.POST);
request.AddParameter("text/plain", "{\r\n \"avatar\": \"data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAA

Sensors
https://documenter.getpostman.com/view/1487903/T17M7QzW?version=latest#ca13350d-4a1b-4d73-a9af-1cf445ae3c0c 11/14
9/2/2021 Avatar API

GET Get all sensors

Documentation Settings

{{baseUrl}}/sensors

AUTHORIZATION
Bearer Token
Token
{{token}}

Example Request Get all sensors

var client = new RestClient("{{baseUrl}}/sensors");

client.Timeout = -1;
var request = new RestRequest(Method.GET);
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);

GET Get Sensors by Date

{{baseUrl}}/sensorsByDate

BODY raw

{
"userId":3,
"date":"2020-08-01"
}

Example Request Get Sensors by Date

https://documenter.getpostman.com/view/1487903/T17M7QzW?version=latest#ca13350d-4a1b-4d73-a9af-1cf445ae3c0c 12/14
9/2/2021 Avatar API

var client = new RestClient("{{baseUrl}}/sensorsByDate"); Documentation Settings

client.Timeout = -1;
var request = new RestRequest(Method.GET);
request.AddParameter("text/plain", "{\r\n \"userId\":3,\r\n \"date\":\"2020-08-01\"\r\n}", Paramete
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);

User

GET all

{{baseUrl}}/users/all

AUTHORIZATION
Bearer Token
Token

{{token}}

Example Request all

var client = new RestClient("{{baseUrl}}/users/all");

client.Timeout = -1;
var request = new RestRequest(Method.GET);
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);

GET one

{{baseUrl}}/account/me

https://documenter.getpostman.com/view/1487903/T17M7QzW?version=latest#ca13350d-4a1b-4d73-a9af-1cf445ae3c0c 13/14
9/2/2021 Avatar API

Documentation Settings
AUTHORIZATION
Bearer Token
Token
{{token}}

Example Request one

var client = new RestClient("{{baseUrl}}/account/me");

client.Timeout = -1;
var request = new RestRequest(Method.GET);
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);

https://documenter.getpostman.com/view/1487903/T17M7QzW?version=latest#ca13350d-4a1b-4d73-a9af-1cf445ae3c0c 14/14