POST api/Equipment/{orgkey}/quickscan

Request Information

URI Parameters

NameDescriptionTypeAdditional information
orgkey

integer

Required

Body Parameters

InventoryScanRequest
NameDescriptionTypeAdditional information
UserKey

integer

None.

TagKey

string

None.

RewardPointDetailScanStartTime

date

None.

RewardPointDetailInventoryName

string

None.

GeoLatitude

decimal number

None.

GeoLongitude

decimal number

None.

InventoryType

string

None.

equipmentLocation

EquipmentLocationModel

None.

Request Formats

application/json, text/json

Sample:
{
  "userKey": 1,
  "tagKey": "sample string 2",
  "rewardPointDetailScanStartTime": "2026-01-29T20:41:21.7825092+00:00",
  "rewardPointDetailInventoryName": "sample string 3",
  "geoLatitude": 1.0,
  "geoLongitude": 1.0,
  "inventoryType": "sample string 4",
  "equipmentLocation": {
    "equipmentLocationKey": 64,
    "equipmentLocationName": "sample string 1",
    "equipmentLocationDisplayName": "sample string 2",
    "equipmentLocationInventoryDepot": true,
    "equipmentLocationGeofenceEnabled": true,
    "equipmentLocationGeoLatitude": 1.0,
    "equipmentLocationtGeoLongitude": 1.0,
    "equipmentLocationRadius": 1,
    "branch": {
      "siteTemplate": {
        "templateKey": 1,
        "templateHeadingColor": "sample string 2",
        "templateSidebarColor": "sample string 3",
        "templateTextColor": "sample string 4"
      },
      "address": {
        "address1": "sample string 1",
        "address2": "sample string 2",
        "addressCity": "sample string 3",
        "addressState": "sample string 4",
        "addressZipCode": "sample string 5"
      },
      "emails": [
        {
          "userKey": 1,
          "emailType": "sample string 1",
          "emailTypeKey": 64,
          "contactEmailAddress": "sample string 3",
          "contactEmailKey": 4,
          "contactKey": 5
        },
        {
          "userKey": 1,
          "emailType": "sample string 1",
          "emailTypeKey": 64,
          "contactEmailAddress": "sample string 3",
          "contactEmailKey": 4,
          "contactKey": 5
        }
      ],
      "companyKey": 1,
      "orgKey": 2,
      "branchKey": 3,
      "branchCode": "sample string 4",
      "branchName": "sample string 5",
      "companyName": "sample string 6",
      "branchTimeZone": "sample string 7",
      "productlines": {
        "productlineKey": 1,
        "productlineName": "sample string 2",
        "productlineshortName": "sample string 3"
      },
      "productLinesArray": [
        {
          "productlineKey": 1,
          "productlineName": "sample string 2",
          "productlineshortName": "sample string 3"
        },
        {
          "productlineKey": 1,
          "productlineName": "sample string 2",
          "productlineshortName": "sample string 3"
        }
      ],
      "name": "sample string 8",
      "contactPhoneNumber": "sample string 9",
      "logoURI": "sample string 10",
      "logoFileName": "sample string 11",
      "alternateEmail": "sample string 12",
      "email": "sample string 13",
      "templateKey": 1
    }
  }
}

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

PageViewModel
NameDescriptionTypeAdditional information
StatusCode

integer

None.

StatusMessage

string

None.

TotalCount

integer

None.

ModelObject

Object

None.

CurrentDateTime

date

None.

Response Formats

application/json, text/json

Sample:
{
  "statusCode": 1,
  "statusMessage": "sample string 2",
  "totalCount": 3,
  "modelObject": {},
  "currentDateTime": "2026-01-29T20:41:21.7825092+00:00"
}