POST public-api/employees/GetEmployeeByRfScanAsync

The method returns active employee matching rfScan.UserIdentifier.



Request Information

URI Parameters

None.

Body Parameters

RFScanPayload
NameDescriptionTypeAdditional information
IsCheckout

boolean

None.

IsCheckin

boolean

None.

TransactionIdentifier

The means by which this transaction data will be identified by the checkin/ checkout process.

string

None.

UserIdentifier

The string that will be the psuedonym for Employees, Customers, Vendors.

string

None.

AssetIdentifiers

The strings that will be the psuedonyms for Assets.

Collection of string

None.

VerifyQualification

Verify Individual Checking out equipment is certified/qualified to use the equipment

boolean

None.

VerifyAssetOwner

Verify that the individual checking in/out the equipment is the assigned equipment owner

boolean

None.

VerifyMaintenanceNotOverdue

Verify that the Maintenance is not overdue

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

WaspResultOfEmployeeSearchModel
NameDescriptionTypeAdditional information
Data

Type specific result that always depends on the function called.

EmployeeSearchModel

None.

Messages

List of Messages. All APIs should return messages. If an API function returns an error you can find more information about the error or errors in this collection of messages.

Collection of WtResult

None.

BatchNumber

This is a global batch number generated by a mass group of transaction records to be returned to the consumer on each call to rolling transaction rules. This requests that each group of Move/Add/Remove transaction batches is tied together. In prior products (such as Mobile Asset Cloud), all are set to null and the only time when the batch number is generated is for multiple check-out transactions but the old is to generate for each responsible party.

integer

None.

HasError

True if an API function result has an error message in the results. If this is false, the function succeeded but other informative messages may be available.

boolean

None.

HasHttpError

True if an API function call could not be fully posted to the server or the results could not be fully returned.

boolean

None.

HasMessage

True if any message is available.

boolean

None.

HasSuccessWithMoreDataRemaining

True if the server sent part of the data and there is more data available. Use with paging APIs to fetch data one page at a time.

boolean

None.

TotalRecordsLongCount

This is the total number of records available in the database based on the query and filer conditions provided. It is possible that the value can change from call to call as users add and delete records so this should not be used to page through multiple recordsets of data. This is used, for example, to set relative scroll bar sizes. When paging through data using functions like the assetadvancedinfosearch, calculating TotalRecordsLongCount for every page full of data is an time-consuming operation. To avoid that extra calculation, and help prevent throttling, assign TotalRecordsLongCount to TotalCountFromPriorFetch in the AdvancedSearchParameters to skip recalculating this total page count and to page thru the records faster.

integer

None.

Response Formats

application/json

Sample:
{
  "Data": {
    "EmployeeId": 1,
    "EmployeeNumber": "sample string 2",
    "EmployeeFirstName": "sample string 3",
    "EmployeeLastName": "sample string 4",
    "DepartmentId": 5,
    "DepartmentName": "sample string 6",
    "DepartmentCode": "sample string 7",
    "LocationId": 8,
    "LocationCode": "sample string 9",
    "SiteName": "sample string 10",
    "EmployeeEmail": "sample string 11",
    "CheckedOutQuantity": 12.0
  },
  "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
}