POST api/AccessControlScan
Uploads a batch of scans, e.g. made offline by a handheld scanner, and records them. Each scan is validated against the time it was made, not the time it's uploaded. A scan with an empty SessionId is recorded against this session, and so its Access Control Location. An error (500) if the request has no session.
Request Information
URI Parameters
None.
Body Parameters
The scans, each with its token and the time it was made.
Collection of AccessControlScanDT| Name | Description | Type | Additional 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. |
Request Formats
application/json, text/json
[
{
"_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": "e6125b69-8a9b-4a74-b250-606e63763fe9",
"accessControlToken": "sample string 3",
"sessionId": "154e4250-6742-44ae-96f7-462a03832c69",
"scanDateTime": "2026-11-04T14:43:18.041342+00:00",
"accessControlScannerId": "3de2760b-c00c-4a6c-a10a-f3d5b9246c24",
"accessControlLocationId": "440a2f08-6cc1-4c17-95c6-d2a646acbbc1",
"scanResult": 6,
"itemId": "e143d3a5-0898-468d-a925-9b3bcc95ee5d",
"productId": "a627703b-eb98-44bb-9974-5c94f7bf8d44",
"folderId": "7da3bc33-23b6-40bb-a1ff-a5da9cdf582a",
"orderId": "28a809e1-9a87-4f02-a628-f779cbdaa634",
"accessControlSchemeId": "80fa212c-b6e6-4028-af86-4e6312dae8ee",
"isSaved": true
},
{
"_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": "e6125b69-8a9b-4a74-b250-606e63763fe9",
"accessControlToken": "sample string 3",
"sessionId": "154e4250-6742-44ae-96f7-462a03832c69",
"scanDateTime": "2026-11-04T14:43:18.041342+00:00",
"accessControlScannerId": "3de2760b-c00c-4a6c-a10a-f3d5b9246c24",
"accessControlLocationId": "440a2f08-6cc1-4c17-95c6-d2a646acbbc1",
"scanResult": 6,
"itemId": "e143d3a5-0898-468d-a925-9b3bcc95ee5d",
"productId": "a627703b-eb98-44bb-9974-5c94f7bf8d44",
"folderId": "7da3bc33-23b6-40bb-a1ff-a5da9cdf582a",
"orderId": "28a809e1-9a87-4f02-a628-f779cbdaa634",
"accessControlSchemeId": "80fa212c-b6e6-4028-af86-4e6312dae8ee",
"isSaved": true
}
]
Response Information
Resource Description
The scans as recorded, each with its result.
Collection of AccessControlScanDT| Name | Description | Type | Additional 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
[
{
"_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": "f44b5807-95a8-4fec-87eb-87309acb667f",
"accessControlToken": "sample string 3",
"sessionId": "9edf9376-7851-40f3-a844-9291c54d180a",
"scanDateTime": "2026-11-04T14:43:18.041342+00:00",
"accessControlScannerId": "d93a08cf-5d7d-4f2d-aa71-ee9a29e59864",
"accessControlLocationId": "b8873b8d-b31f-4d65-80fe-5eceb98214d2",
"scanResult": 6,
"itemId": "64d033ee-e1f6-4ba2-a254-958b60cd3bdb",
"productId": "ca78e6a1-daf1-4981-96e4-5f14e0ab8fff",
"folderId": "097ec3b5-3e45-468c-909a-2775fa96d44b",
"orderId": "db298e01-26d5-4fa9-af58-f222bc867cec",
"accessControlSchemeId": "52934121-b8bf-4e8f-b87c-5539d49c6c8c",
"isSaved": true
},
{
"_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": "f44b5807-95a8-4fec-87eb-87309acb667f",
"accessControlToken": "sample string 3",
"sessionId": "9edf9376-7851-40f3-a844-9291c54d180a",
"scanDateTime": "2026-11-04T14:43:18.041342+00:00",
"accessControlScannerId": "d93a08cf-5d7d-4f2d-aa71-ee9a29e59864",
"accessControlLocationId": "b8873b8d-b31f-4d65-80fe-5eceb98214d2",
"scanResult": 6,
"itemId": "64d033ee-e1f6-4ba2-a254-958b60cd3bdb",
"productId": "ca78e6a1-daf1-4981-96e4-5f14e0ab8fff",
"folderId": "097ec3b5-3e45-468c-909a-2775fa96d44b",
"orderId": "db298e01-26d5-4fa9-af58-f222bc867cec",
"accessControlSchemeId": "52934121-b8bf-4e8f-b87c-5539d49c6c8c",
"isSaved": true
}
]