Scans | API Reference

GEThttps://api.hosted.prismlabs.tech/scans

Response

Body

object

Request

const response = await fetch('https://api.hosted.prismlabs.tech/scans', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{}

register a new scan

This operation registers a new scan in hosted API.

POSThttps://api.hosted.prismlabs.tech/scans

Body

userToken*string

A unique token for the user provided by the partner, that should be associated with the scan

Example: "unique-user-token"

deviceConfigName*enum

The name of the device configuration used for the scan

Example: "IPHONE_SCANNER"

IPHONE_SCANNERANDROID_SCANNER

assetConfigIdstring

The asset configuration used for the scan

Example: ""

bodyfatMethodenum

The requested bodyfat method for the scan

Example: "coco"

adamarmyarmy_athletecocococo_bricoco_legacyextended_navy_thinboosttina_fit

Response

Body

id*string

The unique ID of the scan

Example: "unique-scan-id"

status*enum

The scan status

Example: "PROCESSING"

CREATEDPROCESSINGREADYFAILED

prismScanId*string

The ID of the scan in Prism

Example: "prism-unique-scan-id"

deviceConfigName*enum

The name of the device configuration used for the scan

Example: "IPHONE_SCANNER"

IPHONE_SCANNERANDROID_SCANNER

assetConfigId*string

The asset configuration used for the scan

Example: ""

weight*all of

The user's weight

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

height*all of

The user's height

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

userId*string

The user ID associated with the scan

Example: "unique-user-id"

userToken*string

The unique user token associated with the scan

Example: "unique-user-token"

createdAt*string

The date and time the scan was created

updatedAt*string

The date and time the scan was last updated

scanAssetsall of

The asset metadata associated with the scan

measurements*nullable all of

bodyfat*nullable all of

Request

const response = await fetch('https://api.hosted.prismlabs.tech/scans', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "userToken": "unique-user-token",
      "deviceConfigName": "IPHONE_SCANNER",
      "assetConfigId": "",
      "bodyfatMethod": "coco"
    }),
});
const data = await response.json();

Response

{
  "id": "unique-scan-id",
  "status": "PROCESSING",
  "prismScanId": "prism-unique-scan-id",
  "deviceConfigName": "IPHONE_SCANNER",
  "assetConfigId": "",
  "weight": {
    "value": 80,
    "unit": "kg"
  },
  "height": {
    "value": 1.8,
    "unit": "m"
  },
  "userId": "unique-user-id",
  "userToken": "unique-user-token",
  "createdAt": "text",
  "updatedAt": "text",
  "scanAssets": {
    "id": "unique-scan-asset-id",
    "scanId": "unique-scan-id",
    "captureData": "succeeded",
    "captureDataUpdatedAt": "text",
    "body": "started",
    "bodyUpdatedAt": "text",
    "fittedBody": null,
    "fittedBodyUpdatedAt": "text",
    "measurement": null,
    "measurementUpdatedAt": "text",
    "createdAt": "text",
    "updatedAt": "text"
  },
  "measurements": {
    "neckFit": 1,
    "shoulderFit": 1,
    "upperChestFit": 1,
    "chestFit": 1,
    "lowerChestFit": 1,
    "waistFit": 1,
    "waistNavyFit": 1,
    "stomachFit": 1,
    "hipsFit": 1,
    "upperThighLeftFit": 1,
    "upperThighRightFit": 1,
    "thighLeftFit": 1,
    "thighRightFit": 1,
    "lowerThighLeftFit": 1,
    "lowerThighRightFit": 1,
    "calfLeftFit": 1,
    "calfRightFit": 1,
    "ankleLeftFit": 1,
    "ankleRightFit": 1,
    "midArmRightFit": 1,
    "midArmLeftFit": 1,
    "lowerArmRightFit": 1,
    "lowerArmLeftFit": 1,
    "waistToHipRatio": 1
  },
  "bodyfat": {
    "bodyfatMethod": "coco",
    "bodyfatPercentage": 20,
    "leanMassPercentage": 80,
    "fatMass": 16,
    "leanMass": 64
  }
}

get status of a scan

This operation provides the status of a specific scan.

GEThttps://api.hosted.prismlabs.tech/scans/{id}

Path parameters

id*string

The unique ID of the scan

Example: "unique-scan-id"

Response

Body

id*string

The unique ID of the scan

Example: "unique-scan-id"

status*enum

The scan status

Example: "PROCESSING"

CREATEDPROCESSINGREADYFAILED

prismScanId*string

The ID of the scan in Prism

Example: "prism-unique-scan-id"

deviceConfigName*enum

The name of the device configuration used for the scan

Example: "IPHONE_SCANNER"

IPHONE_SCANNERANDROID_SCANNER

assetConfigId*string

The asset configuration used for the scan

Example: ""

weight*all of

The user's weight

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

height*all of

The user's height

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

userId*string

The user ID associated with the scan

Example: "unique-user-id"

userToken*string

The unique user token associated with the scan

Example: "unique-user-token"

createdAt*string

The date and time the scan was created

updatedAt*string

The date and time the scan was last updated

scanAssetsall of

The asset metadata associated with the scan

measurements*nullable all of

bodyfat*nullable all of

Request

const response = await fetch('https://api.hosted.prismlabs.tech/scans/{id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "id": "unique-scan-id",
  "status": "PROCESSING",
  "prismScanId": "prism-unique-scan-id",
  "deviceConfigName": "IPHONE_SCANNER",
  "assetConfigId": "",
  "weight": {
    "value": 80,
    "unit": "kg"
  },
  "height": {
    "value": 1.8,
    "unit": "m"
  },
  "userId": "unique-user-id",
  "userToken": "unique-user-token",
  "createdAt": "text",
  "updatedAt": "text",
  "scanAssets": {
    "id": "unique-scan-asset-id",
    "scanId": "unique-scan-id",
    "captureData": "succeeded",
    "captureDataUpdatedAt": "text",
    "body": "started",
    "bodyUpdatedAt": "text",
    "fittedBody": null,
    "fittedBodyUpdatedAt": "text",
    "measurement": null,
    "measurementUpdatedAt": "text",
    "createdAt": "text",
    "updatedAt": "text"
  },
  "measurements": {
    "neckFit": 1,
    "shoulderFit": 1,
    "upperChestFit": 1,
    "chestFit": 1,
    "lowerChestFit": 1,
    "waistFit": 1,
    "waistNavyFit": 1,
    "stomachFit": 1,
    "hipsFit": 1,
    "upperThighLeftFit": 1,
    "upperThighRightFit": 1,
    "thighLeftFit": 1,
    "thighRightFit": 1,
    "lowerThighLeftFit": 1,
    "lowerThighRightFit": 1,
    "calfLeftFit": 1,
    "calfRightFit": 1,
    "ankleLeftFit": 1,
    "ankleRightFit": 1,
    "midArmRightFit": 1,
    "midArmLeftFit": 1,
    "lowerArmRightFit": 1,
    "lowerArmLeftFit": 1,
    "waistToHipRatio": 1
  },
  "bodyfat": {
    "bodyfatMethod": "coco",
    "bodyfatPercentage": 20,
    "leanMassPercentage": 80,
    "fatMass": 16,
    "leanMass": 64
  }
}

delete a scan

This operation deletes a specific scan.

DELETEhttps://api.hosted.prismlabs.tech/scans/{id}

Path parameters

id*string

The unique ID of the scan

Example: "unique-scan-id"

Response

Body

id*string

The unique ID of the scan

Example: "unique-scan-id"

status*enum

The scan status

Example: "PROCESSING"

CREATEDPROCESSINGREADYFAILED

prismScanId*string

The ID of the scan in Prism

Example: "prism-unique-scan-id"

deviceConfigName*enum

The name of the device configuration used for the scan

Example: "IPHONE_SCANNER"

IPHONE_SCANNERANDROID_SCANNER

assetConfigId*string

The asset configuration used for the scan

Example: ""

weight*all of

The user's weight

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

height*all of

The user's height

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

userId*string

The user ID associated with the scan

Example: "unique-user-id"

userToken*string

The unique user token associated with the scan

Example: "unique-user-token"

createdAt*string

The date and time the scan was created

updatedAt*string

The date and time the scan was last updated

scanAssetsall of

The asset metadata associated with the scan

measurements*nullable all of

bodyfat*nullable all of

Request

const response = await fetch('https://api.hosted.prismlabs.tech/scans/{id}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Response

{
  "id": "unique-scan-id",
  "status": "PROCESSING",
  "prismScanId": "prism-unique-scan-id",
  "deviceConfigName": "IPHONE_SCANNER",
  "assetConfigId": "",
  "weight": {
    "value": 80,
    "unit": "kg"
  },
  "height": {
    "value": 1.8,
    "unit": "m"
  },
  "userId": "unique-user-id",
  "userToken": "unique-user-token",
  "createdAt": "text",
  "updatedAt": "text",
  "scanAssets": {
    "id": "unique-scan-asset-id",
    "scanId": "unique-scan-id",
    "captureData": "succeeded",
    "captureDataUpdatedAt": "text",
    "body": "started",
    "bodyUpdatedAt": "text",
    "fittedBody": null,
    "fittedBodyUpdatedAt": "text",
    "measurement": null,
    "measurementUpdatedAt": "text",
    "createdAt": "text",
    "updatedAt": "text"
  },
  "measurements": {
    "neckFit": 1,
    "shoulderFit": 1,
    "upperChestFit": 1,
    "chestFit": 1,
    "lowerChestFit": 1,
    "waistFit": 1,
    "waistNavyFit": 1,
    "stomachFit": 1,
    "hipsFit": 1,
    "upperThighLeftFit": 1,
    "upperThighRightFit": 1,
    "thighLeftFit": 1,
    "thighRightFit": 1,
    "lowerThighLeftFit": 1,
    "lowerThighRightFit": 1,
    "calfLeftFit": 1,
    "calfRightFit": 1,
    "ankleLeftFit": 1,
    "ankleRightFit": 1,
    "midArmRightFit": 1,
    "midArmLeftFit": 1,
    "lowerArmRightFit": 1,
    "lowerArmLeftFit": 1,
    "waistToHipRatio": 1
  },
  "bodyfat": {
    "bodyfatMethod": "coco",
    "bodyfatPercentage": 20,
    "leanMassPercentage": 80,
    "fatMass": 16,
    "leanMass": 64
  }
}