PUT api/AccessControlScan?accessControlToken={accessControlToken}

Validates one token scanned now at the session's Access Control Location, and records the scan. An error (500) if the request has no session.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
accessControlToken

The token as read from the barcode, QR code or card. In the query string.

string

Required

Body Parameters

None.

Response Information

Resource Description

The recorded scan, with its result and a message to show the operator.

AccessControlScanDT
NameDescriptionTypeAdditional information
ExtraData

More data about the scan, by name.

Dictionary of string [key] and string [value]

None.

Message

A message to show the operator, such as why entry was refused.

string

None.

Statistics

Scan statistics.

AccessControlStatisticsDT

None.

AccessControlScanId

globally unique identifier

None.

AccessControlToken

string

None.

SessionId

globally unique identifier

None.

ScanDateTime

date

None.

AccessControlScannerId

globally unique identifier

None.

AccessControlLocationId

globally unique identifier

None.

ScanResult

integer

None.

ItemId

globally unique identifier

None.

ProductId

globally unique identifier

None.

FolderId

globally unique identifier

None.

OrderId

globally unique identifier

None.

AccessControlSchemeId

globally unique identifier

None.

IsSaved

boolean

None.

Response Formats

application/json, text/json

Sample:
{
  "_Message": "sample string 1",
  "extraData": {
    "sample string 1": "sample string 2",
    "sample string 3": "sample string 4"
  },
  "message": "sample string 1",
  "statistics": {
    "totalItems": 1,
    "scannedItems": 2,
    "remainingItems": 3
  },
  "accessControlScanId": "9c0f84c0-724a-4709-a6bb-d5ab4e3d6f39",
  "accessControlToken": "sample string 3",
  "sessionId": "480a6067-9865-4f57-baa1-1779fb4177f5",
  "scanDateTime": "2026-11-04T14:43:08.0683742+00:00",
  "accessControlScannerId": "97015dc8-138d-4086-8cc9-50b21ff8e8b2",
  "accessControlLocationId": "bcdeffcd-7934-431f-a917-c3a3c3f7c39b",
  "scanResult": 6,
  "itemId": "44073e57-cc8c-4250-91cc-5997e5b38b18",
  "productId": "f4e8f625-b2ad-4caf-b1d0-7693af0a8035",
  "folderId": "0b8e61cb-f199-43ac-83bd-eebffe43e588",
  "orderId": "0d1f3a49-6852-4ada-9058-4c9df28b9f3b",
  "accessControlSchemeId": "77d45d68-88b1-4fbb-b6e8-95e416a055a4",
  "isSaved": true
}