Users | API Reference

API Reference

Fetch a user

get

Authorizations

Path parameters

userIdstringRequired

Query parameters

weight-unitstring · enumOptional

The unit in which the weight will be returned

Available options:

height-unitstring · enumOptional

The unit in which the height will be returned

Available options:

Responses

application/json;v=1

objectOptional

application/json;v=1

get

GET /users/{userId} HTTP/1.1
Host: api.prismlabs.tech
Authorization: Bearer JWT
Accept: */*

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

Register a new user

post

Authorizations

Body

sexstring · enumRequired

Describes the user's sex

Example: femaleAvailable options:

regionstring · enumRequired

Describes the region where the user is being registered

Example: north_americaAvailable options:

birthYearnumber · min: 1900Required

The user's birth year

Example: 1990

weightall ofOptional

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

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

heightall ofOptional

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

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

Responses

application/json;v=1

objectOptional

application/json;v=1

post

POST /users HTTP/1.1
Host: api.prismlabs.tech
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 126

{
  "sex": "female",
  "region": "north_america",
  "birthYear": 1990,
  "weight": {
    "value": 80,
    "unit": "kg"
  },
  "height": {
    "value": 1.7,
    "unit": "m"
  }
}

{
  "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

patch

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

Authorizations

Path parameters

userIdstringRequired

Query parameters

weight-unitstring · enumOptional

The unit in which the weight will be returned

Available options:

height-unitstring · enumOptional

The unit in which the height will be returned

Available options:

Body

sexstring · enumOptional

Describes the user's sex

Example: femaleAvailable options:

regionstring · enumOptional

Describes the region where the user is being registered

Example: north_americaAvailable options:

birthYearnumber · min: 1900Optional

The user's birth year

Example: 1990

weightall ofOptional

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

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

heightall ofOptional

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

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

Responses

application/json;v=1

objectOptional

application/json;v=1

patch

PATCH /users/{userId} HTTP/1.1
Host: api.prismlabs.tech
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 126

{
  "sex": "female",
  "region": "north_america",
  "birthYear": 1990,
  "weight": {
    "value": 80,
    "unit": "kg"
  },
  "height": {
    "value": 1.7,
    "unit": "m"
  }
}

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