/api/v1/scan-sessions/{id}/lines

GET

const url = 'https://example.com/api/v1/scan-sessions/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/lines';
const options = {method: 'GET'};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://example.com/api/v1/scan-sessions/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/lines

Parameters

Path Parameters

required

string format: uuid

/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/

Responses

200

Default Response

application/json

object

finishedAt

required

string | null

countedPlaceIds

required

Any of:

Array<string>
null

Array<string>

lines

required

Array<object>

object

thingId

required

string format: uuid

/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/

action

required

string

Allowed values: seen not_here move missing elsewhere on_loan in_repair trashed not_counted

readAt

required

string

readBy

required

Any of:

object
null

object

required

Any of:

string
null

string format: uuid

/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/

displayName

required

string

foundQty

required

string | null

Example

{
  "lines": [
    {
      "action": "seen"
    }
  ]
}