POST public-api/transactions/rfscan

Stages the payload for an RF-scanned check-in or check-out so that the check-in / check-out process can pick it up later by its transaction identifier. The payload is held for 24 hours, keyed by whether it is a check-out or a check-in and by the TransactionIdentifier supplied on the payload. Posting a payload again with the same identifier and direction replaces the previously staged payload. This call only stages the payload; it does not itself create a check-in or check-out transaction, and it does not validate the identifiers it is given.



Request Information

URI Parameters

None.

Body Parameters

RFScanPayload
NameDescriptionTypeAdditional information
IsCheckout

boolean

None.

IsCheckin

boolean

None.

TransactionIdentifier

string

None.

UserIdentifier

string

None.

AssetIdentifiers

Collection of string

None.

VerifyQualification

boolean

None.

VerifyAssetOwner

boolean

None.

VerifyMaintenanceNotOverdue

boolean

None.

Request Formats

application/json

Sample:
{
  "IsCheckout": false,
  "IsCheckin": true,
  "TransactionIdentifier": "sample string 1",
  "UserIdentifier": "sample string 2",
  "AssetIdentifiers": [
    "sample string 1",
    "sample string 2"
  ],
  "VerifyQualification": true,
  "VerifyAssetOwner": true,
  "VerifyMaintenanceNotOverdue": true
}



Response Information

Resource Description

WaspResultOfString
NameDescriptionTypeAdditional information
Data

string

None.

Messages

Collection of WtResult

None.

BatchNumber

integer

None.

HasError

boolean

None.

HasHttpError

boolean

None.

HasMessage

boolean

None.

HasSuccessWithMoreDataRemaining

boolean

None.

TotalRecordsLongCount

integer

None.

Response Formats

application/json

Sample:
{
  "Data": "sample string 1",
  "Messages": [
    {
      "ResultCode": 0,
      "Message": "sample string 1",
      "HttpStatusCode": 200,
      "FieldName": "sample string 2"
    },
    {
      "ResultCode": 0,
      "Message": "sample string 1",
      "HttpStatusCode": 200,
      "FieldName": "sample string 2"
    }
  ],
  "BatchNumber": 1,
  "HasError": false,
  "HasHttpError": false,
  "HasMessage": true,
  "HasSuccessWithMoreDataRemaining": false,
  "TotalRecordsLongCount": 1
}