Assets

Records the result of scanning an asset tag

Records the outcome of scanning (or attempting to scan) an asset tag. Includes validation status and standardized failure reasons. For a successful request, returns true in the response. <br />Note: Asset scanning is based on Asset Rules (AssetRules FF) configured by clients within Asset Manager. To check validation rules, run the GET/assets/{subscriberId}/ValidationRules method.

post/assets/RecordScannedAsset

Request

Request body

AssetIDinteger required

Unique numeric identifier of the scanned asset. Must be greater than 0.

TrackingNumberinteger required

Tracking number of the work order associated with the scanned asset. Must be greater than 0.

WorkOrderIDstring

Unique numeric identifier of the work order associated with the scanned asset.

AssetTagStatus'Unknown' | 'NotAvailable' | 'NotValidated' | 'PendingValidation' | 'Validated'

Validation status of the scanned asset tag. Possible values:  • 0=Unknown: Validation status is not determined.  • 1=NotAvailable: Asset tag does not exist or cannot be scanned.  • 2=NotValidated: Asset tag exists, but validation failed.  • 3=PendingValidation: Asset tag has been scanned and is awaiting validation.  • 4=Validated: Asset tag has been successfully validated.

ManuallyEnteredboolean

Indicates whether the asset tag value was entered manually instead of being scanned. Possible values: true and false.

AssetTagNotScannedReasonstring

Free‑text explanation of why the tag was not scanned. Must not exceed 50 characters.

ValidationRequiredboolean

Indicates whether this asset requires asset tag validation. Possible values: true and false. To check whether validation is required, run the GET/assets/{trackingNumber}/IsValidationRequired method.

AssetValidatedboolean

Indicates whether the asset has been successfully validated. Possible values: true and false.

UnableToValidateReasonIdinteger

Standardized reason code defining why validation could not be completed. Possible values:  • 1: Cannot find the asset in the database  • 2: Cannot find the asset on site  • 3: New asset  • 4: Other (requires explanation in OtherReason) To check the reasons and their IDs, run the GET/assets/UnableToValidateReasons method.

OtherReasonstring

Free-text explanation of why validation failed. Required when UnableToValidateReasonId = 4 (Other).

UnableToScanReasonIdinteger

Standardized reason code defining why scanning could not be completed. Possible values:  • 1: Tag Missing  • 2: Tag Damaged  • 3: Scanner Problem  • 4: Other To get the reason codes, run the GET/assets/UnableToScanReasons method.

Response

The result of asset tag scanning was successfully recorded.

boolean required

Changes

No recorded changes to this operation across all 1 revision of this API.