Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Published by Scroll Versions from this space and version 2024.1

Table of Contents
outlinetrue
stylenone

...

Parameter

Required

Data Type

Options

Notes

recid

Yes

Integer


RECID column from SERVICE_DESK_EQP table.
sde_statusYesString

Value Lookups:

Toggle cloak

Cloak

Insert excerpt
API
API
nopaneltrue


The Status of the Equipment.
asset_tagNo*String

Asset Tag on the Equipment.

Conditionally Required if the Equipment is an Asset.

eqp_idNo*String

Equipment ID of the Equipment.

Conditionally Required if the Equipment is Cabling Equipment.

locationNo*Integer

RECID of the Warehouse of the Equipment.

Conditionally Required: see Notes section below.

workerNo*Integer

RECID of the Worker performing the Activity. 

Conditionally Required: see Notes section below.

scan_dateNoDatetime
Expected format: YYYY/MM/DD HH:ii:ss or YYYY/MM/DD

Notes

  • For sde_statusStaged the following are required.
    • location - must be an active sub-Warehouse of the starting Warehouse
  • For sde_statusPicked Up the following are required.
    • location - must be an active Warehouse
    • worker - Contact RECID - Worker type, Active
  • For sde_statusComplete the following are required.
    • location - if it is blank on the sd_eqp record, it must be included, if the Equipment is non-consumable , and must be an existing Location
  • For sde_status: Void, no additional details are required for the Equipment record.

Request Example

Call
Code Block
languagesql
http://DOMAIN/api/API_KEY/barcode.OUTPUT

...

Parameter

Required

Data Type

Options

Notes

eqp_catalog

Yes

Integer


RECID of the Equipment's Equipment Catalog.
eqp_statusYesInteger

Value Lookups:

Toggle cloak

Cloak

Insert excerpt
API
API
nopaneltrue


The RECID of the status of the Equipment.
eqp_conditionNoInteger

Value Lookups:

Toggle cloak

Cloak

Insert excerpt
API
API
nopaneltrue


The RECID of the condition of the Equipment.
received_dateNoDate
The date the Equipment was Received. Format "YYYY/MM/DD"
locationYesInteger
RECID of the Warehouse of the Equipment. Must be an active Warehouse.
quantityYesInteger

This represents both Units and Quantity. If the Equipment Catalog Has Units - it is Units - if it is marked as "not units" then it is recorded as Quantity in the application currently.

purchase_priceNoFloat
The purchase price of the Equipment must be greater than or equal to zero.
assetsNoArray
Only valid for Asset or Cabling Equipment, else ignored. If provided the number of entries must match the quantity.
commentsYesString

The reason why the Equipment is being added.

unitsNo*Integer
Must be a positive number that is greater than 0.
Conditionally Required: If the "Has Units" box is checked on the Equipment Catalog.
scan_dateNoDatetime
Expected format: YYYY/MM/DD HH:ii:ss or YYYY/MM/DD

Notes

  • It must be an active Equipment Catalog.
  • Positive A positive (none-zero) count , and it cannot be null.
  • Allowed Status' that are allowed
    • Unassigned
    • Broken
    • Lost
    • Retired
    • Any custom status for the EQP_STATUS in the List Values table.
    • If the Status The API will give an error if the status is not one of the valid List Values, the API will error.list values.
  • The Warehouse must be an active Warehouse.
  • Asset Array
    • Optional for Asset or Cabling Equipment (flags on Equipment Catalog).
    • Should It should be ignored (not put in db) if a non-asset or non-cabling equipment is used.
    • The number of entries in the asset array must exactly match the provided count when provided.
  • If provided, the price must be a positive number or zero, If ; if not provided, the value can be null.
  • Any valid date, past, present, or future, is allowed.

...

Parameter

Required

Data Type

Options

Notes

eqp_catalog

Yes

Integer


RECID of the Equipment's Equipment Catalog.
quantityNoInteger
This represents both Units and Quantity. If the Equipment Catalog Has Units - it is Units - if it is marked as "not units" then it is recorded as Quantity in the application currently.
from_locationYesInteger
Location RECID of the Warehouse of the Equipment is from.
to_locationYesInteger
Location RECID of the Warehouse of the Equipment is going to.
recidsNo*Array
Conditionally Required if the Equipment is an Asset or Cabling. Sent as an array of recids. See the Notes section below for more details.
commentsYesString
The reason why the Equipment is being transferred.
scan_dateNoDatetime
Expected format: YYYY/MM/DD HH:ii:ss or YYYY/MM/DD

Notes

  • It must be an active Equipment Catalog.
  • Positive (none-zero) count, cannot be null.
  • Status' that are allowed
    • Unassigned
    • Broken
    • Lost
    • Retired
    • Any custom status
    • If the Status is not one of the valid List Values, the API will error.
  • The Warehouse must be an active Warehouse.
  • Equipment RecIDs array
    • Required for Asset or Cabling Equipment (flags on Equipment Catalog).
    • should be ignored (not put in db) if a non-asset or non-cabling equipment is used.
    • The number of entries in the Equipment RecIDs array must exactly match the count when provided.

...

  • transaction_type must be po_receive.
  • When setting up the Barcode API in Admin, the Authentication Required box must be true Authentication Required checkbox example. Barcode requires authentication to work.

Available Fields

Parameter

Required

Data Type

Options

Notes

recid YesInteger
Purchase Order RECID, Status must be Open
eqp_catalogYesInteger
Equipment Catalog RECID
priceYesFloat
Price of Equipment
unitsNoInteger
Units of Equipment. Only valid for Has Units Equipment, else ignored. The value must match an entry on the Purchase Order Equipment, as PCR-360 uses this to detect which item is being received if there is more than one entry for the Equipment Catalog on the Purchase Order and their units are different.
quantityYesInteger
Quantity to Receive
locationYesInteger
Valid Active Warehouse RECID to receive Equipment
received_dateNoDate
Received Date
assetsNoArray
Only valid for Asset or Cabling Equipment, else ignored. If provided the number of entries must match the quantity.

Request Example

Call

...

languagesql

...

scan_dateNoDatetime
Expected format: YYYY/MM/DD HH:ii:ss or YYYY/MM/DD


Request Example

Call
Code Block
languagesql
http://DOMAIN/api/API_KEY/barcode.OUTPUT
Headers
KeyValue

Content-Type

application/json

PCR-AUTH-TOKEN

example: e036a785-4d7a-40ed-a04a-c8e339327f55

Body
KeyValue
recid 12874
eqp_catalog346
price9.99
quantity4
location694
JSON Request:
Toggle cloak

...

  • transaction_type must be whs_physical_inventory.
  • When setting up the Barcode API in Admin, the Authentication Required box must be true Authentication Required checkbox example. Barcode requires authentication to work.

Available Fields

Parameter

Required

Data Type

Options

Notes

scan_date
No
Yes
Date
Datetime
Expected format: YYYY/MM/DD HH:ii:ss or YYYY/MM/DD
eqp_catalogYesInteger
Equipment Catalog RECID
unitsNoArray
Units of Equipment. Only valid for Has Units Equipment, else ignored. If provided the number of entries must match the quantity.
quantityYesInteger
Quantity to Receive
locationYesInteger
Valid Active Warehouse RECID to receive Equipment
assetsNoArray
Only valid for Asset or Cabling Equipment, else ignored. If provided the number of entries must match the quantity.


Request Example

Call
Code Block
languagesql
http://DOMAIN/api/API_KEY/barcode.OUTPUT
Headers
KeyValue

Content-Type

application/json

PCR-AUTH-TOKEN

example: e036a785-4d7a-40ed-a04a-c8e339327f55

Body
KeyValue
scan_date2000/01/01 00:00:00
eqp_catalog346
quantity1
location694
assetsbcasset1sd126
JSON Request:
Toggle cloak
Cloak


Code Block
languagexml
titleExample JSON Request
"request": {
				"method": "POST",
				"header": [
					{
						"Content-Type": "application/x-www-form-urlencoded",
						"Cookie": "{{DebugCookie}}",
						"PCR-AUTH-TOKEN": "YOUR-AUTH-TOKEN-VALUE-HERE",
					}
				],
				"body": {
					"mode": "urlencoded",
					"urlencoded": [
						{  
							"transaction_type": "whs_physical_inventory",
							"eqp_catalog": "346",
							"location": "694",
							"quantity"": "1",
							"scan_date": "2000/01/01 00:00:00",
							"assets": [
								{
									"ASSET_TAG": "bcasset1sd126"
								}]
						}
					]
				}


...

Cloak


Code Block
{
    "message": "Barcode transaction added successfully."
}


Barcode Physical Inventory Grid Example

Performing a Batch Call

Users are also able to submit a Batch of Barcode scans. These Batches can contain one or more different types of Barcode Transactions.

Parameter

Required

Data Type

Notes

batchNoArray

Barcode Batches expect the data to be formatted as JSON.

Batches are expected to be an array of different Barcode Transactions.


Expand
titleExample Batch:
{
  "batch": [
        {
            "transaction_type": "sd_eqp_status",
            "recid": "53114",
            "sde_status": "263",
            "eqp_id": "331623",
            "location": "332060"
        },
        {
            "transaction_type": "whs_bulk_add",
            "eqp_catalog": "533",
            "eqp_status": "94",
            "location": "86201",
            "quantity": "1",
            "purchase_price": "0.45",
            "assets[0][ASSET_TAG]": "assettag143",
            "assets[0][SERIAL_NUM]": "serialnum143",
            "assets[0][EQUIPMENT_ID]": "equipmentid143",
            "comments": "pete test",
            "units": ""
        },
        {
            "transaction_type": "whs_bulk_transfer",
            "eqp_catalog": "952",
            "quantity": "1",
            "from_location": "289039",
            "to_location": "331623",
            "recids[]": "1",
            "comments": "pete test"
        },
        {
            "transaction_type": "po_receive",
            "recid": "38",
            "eqp_catalog": "1095",
            "price": "1.00",
            "quantity": "1",
            "location": "331570"
        },
        {
            "transaction_type": "whs_physical_inventory",
            "eqp_catalog": "3394",
            "units": "0.45",
            "quantity": "10",
            "location": "332058",
            "scan_date":"2000/01/01"
        }
    ]
}

Locating Data related to Barcodes

...