Scans

Register a scan

This operation registers a new scan in Prism. A scan id is returned, which will be used in subsequent requests.

After registering a scan, capture data must be uploaded.

IMPORTANT: The user of this scan should be updated with current information (e.g. weight) before calling this operation.

post

/scans

Authorizations
Body
deviceConfigIdstringrequired

The id for the device config used to produce the scan

Example: 36b516c7-e598-40a2-9b9a-2016364657ab
assetConfigIdstring

The id for the asset config used to produce the scan

Example: 6dbade37-bb49-449f-bb8b-7bc9226a028d
userIdstringrequired

The id for the user who is to be scanned

Example: 7a50198f-d866-4772-9c2e-1b2ff8408128
consentall of

Various consent flags for the scan. If not provided, scan is opted out of all consent fields.

Example: {"fullResearch":true}
Responses
curl -L \
  --request POST \
  --url 'https://api.prismlabs.tech/scans' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{"deviceConfigId":"36b516c7-e598-40a2-9b9a-2016364657ab","assetConfigId":"6dbade37-bb49-449f-bb8b-7bc9226a028d","userId":"7a50198f-d866-4772-9c2e-1b2ff8408128","consent":{"fullResearch":true}}'
{
  "deviceConfigId": "36b516c7-e598-40a2-9b9a-2016364657ab",
  "assetConfigId": "6dbade37-bb49-449f-bb8b-7bc9226a028d",
  "id": "7f2ec6e0-b06d-42b1-b2a1-fff59a458490",
  "userId": "5304329f-bcb8-48f0-9661-5ac06b2515b1",
  "state": "SCAN_INPUT_VALID"
}

Fetch the status of scan

get

/scans/{scanId}

Authorizations
Path parameters
scanIdstringrequired
Responses
curl -L \
  --url 'https://api.prismlabs.tech/scans/{scanId}' \
  --header 'Authorization: Bearer JWT'
{
  "deviceConfigId": "36b516c7-e598-40a2-9b9a-2016364657ab",
  "assetConfigId": "6dbade37-bb49-449f-bb8b-7bc9226a028d",
  "id": "7f2ec6e0-b06d-42b1-b2a1-fff59a458490",
  "userId": "5304329f-bcb8-48f0-9661-5ac06b2515b1",
  "state": "SCAN_INPUT_VALID"
}