Users

Register a new user

POSThttps://api.prismlabs.tech/users

Authorization

bearer

Body

application/json

sex*enum

Describes the user's sex

Example: "female"

malefemaleneutralundefined

region*enum

Describes the region where the user is being registered

Example: "north_america"

africaasiacaribbeancentral_americaeuropenorth_americaoceaniasouth_americaunspecified

birthYear*number

The user's birth year

Example: 1990

weightall of

Describes the user's weight in kilograms (kg) or pounds (lb)

Example: {"value":80,"unit":"kg"}

heightall of

Describes the user's height in meters (m) or inches (in)

Example: {"value":1.7,"unit":"m"}

Response

201400401403422500

Body

application/json;v=1

id*string

The user's registered id in Prism's system

Example: "7f2ec6e0-b06d-42b1-b2a1-fff59a458490"

sex*enum

Describes the user's sex

Example: "female"

malefemaleneutralundefined

region*enum

Describes the region where the user is being registered

Example: "north_america"

africaasiacaribbeancentral_americaeuropenorth_americaoceaniasouth_americaunspecified

birthYear*number

The user's birth year

Example: 1990

weightall of

Describes the user's weight in kg or lb

Example: {"value":80,"unit":"kg"}

heightall of

Describes the user's height in m or in

Example: {"value":1.7,"unit":"m"}

Request

JavaScriptCurlPythonHTTP

const response = await fetch('https://api.prismlabs.tech/users', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer JWT",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "sex": "female",
      "region": "north_america",
      "birthYear": 1990,
      "weight": {
        "value": 80,
        "unit": "kg"
      },
      "height": {
        "value": 1.7,
        "unit": "m"
      }
    }),
});
const data = await response.json();

Response

201400401403422500

{
  "id": "7f2ec6e0-b06d-42b1-b2a1-fff59a458490",
  "sex": "female",
  "region": "north_america",
  "birthYear": 1990,
  "weight": {
    "value": 80,
    "unit": "kg"
  },
  "height": {
    "value": 1.7,
    "unit": "m"
  }
}

Fetch a user

GEThttps://api.prismlabs.tech/users/{userId}

Authorization

bearer

Path parameters

userId*string

Query parameters

Response

200401403404500

Body

application/json;v=1

id*string

The user's registered id in Prism's system

Example: "7f2ec6e0-b06d-42b1-b2a1-fff59a458490"

sex*enum

Describes the user's sex

Example: "female"

malefemaleneutralundefined

region*enum

Describes the region where the user is being registered

Example: "north_america"

africaasiacaribbeancentral_americaeuropenorth_americaoceaniasouth_americaunspecified

birthYear*number

The user's birth year

Example: 1990

weightall of

Describes the user's weight in kg or lb

Example: {"value":80,"unit":"kg"}

heightall of

Describes the user's height in m or in

Example: {"value":1.7,"unit":"m"}

Request

JavaScriptCurlPythonHTTP

const response = await fetch('https://api.prismlabs.tech/users/{userId}', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer JWT"
    },
});
const data = await response.json();

Response

200401403404500

{
  "id": "7f2ec6e0-b06d-42b1-b2a1-fff59a458490",
  "sex": "female",
  "region": "north_america",
  "birthYear": 1990,
  "weight": {
    "value": 80,
    "unit": "kg"
  },
  "height": {
    "value": 1.7,
    "unit": "m"
  }
}

Update a user

IMPORTANT: A user should be updated with current information (e.g. weight) before the creation a new scan.

PATCHhttps://api.prismlabs.tech/users/{userId}

Authorization

bearer

Path parameters

userId*string

Query parameters

Body

application/json

sexenum

Describes the user's sex

Example: "female"

malefemaleneutralundefined

regionenum

Describes the region where the user is being registered

Example: "north_america"

africaasiacaribbeancentral_americaeuropenorth_americaoceaniasouth_americaunspecified

birthYearnumber

The user's birth year

Example: 1990

weightall of

Describes the user's weight in kilograms (kg) or pounds (lb)

Example: {"value":80,"unit":"kg"}

heightall of

Describes the user's height in meters (m) or inches (in)

Example: {"value":1.7,"unit":"m"}

Response

200400401403422500

Body

application/json;v=1

id*string

The user's registered id in Prism's system

Example: "7f2ec6e0-b06d-42b1-b2a1-fff59a458490"

sex*enum

Describes the user's sex

Example: "female"

malefemaleneutralundefined

region*enum

Describes the region where the user is being registered

Example: "north_america"

africaasiacaribbeancentral_americaeuropenorth_americaoceaniasouth_americaunspecified

birthYear*number

The user's birth year

Example: 1990

weightall of

Describes the user's weight in kg or lb

Example: {"value":80,"unit":"kg"}

heightall of

Describes the user's height in m or in

Example: {"value":1.7,"unit":"m"}

Request

JavaScriptCurlPythonHTTP

const response = await fetch('https://api.prismlabs.tech/users/{userId}', {
    method: 'PATCH',
    headers: {
      "Authorization": "Bearer JWT",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "sex": "female",
      "region": "north_america",
      "birthYear": 1990,
      "weight": {
        "value": 80,
        "unit": "kg"
      },
      "height": {
        "value": 1.7,
        "unit": "m"
      }
    }),
});
const data = await response.json();

Response

200400401403422500

{
  "id": "7f2ec6e0-b06d-42b1-b2a1-fff59a458490",
  "sex": "female",
  "region": "north_america",
  "birthYear": 1990,
  "weight": {
    "value": 80,
    "unit": "kg"
  },
  "height": {
    "value": 1.7,
    "unit": "m"
  }
}