Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: under the "warehouse bulk add" section I added an entry in the table with an explanation for units and I added an example of units to the "body" table. I also made a few instances of required red.

...

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

...

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

...

Parameter

Required

Data Type

Options

Notes

eqp_catalog

Yes

Integer


RECID of the Equipment's Equipment Catalog.
eqp_statusYesInteger

Lists 

Toggle cloak

Cloak

Insert excerpt
API
API
nopaneltrue


The RECID of the status of the Equipment.
eqp_conditionNo*Integer

Lists 

Toggle cloak

Cloak

Insert excerpt
API
API
nopaneltrue


The RECID of the condition of the Equipment.
received_dateNo*Date
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_priceNo*Float
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.

UnitsYes*Integer
Must be a positive number that is greater than 0.
Conditionally Required: If the "Has Units" box is checked on the Equipment Catalog.

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 for the EQP_STATUS in the List Values table.
    • If the Status is not one of the valid List Values, the API will error.
  • The Warehouse must be an active Warehouse.
  • Asset Array
    • Optional 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 asset array must exactly match the count when provided.
  • If provided, the price must be a positive number or zero, If not provided, the value can be null.
  • Any valid date, past, present, or future, is allowed.

...

KeyValue
transaction_type

whs_bulk_add

eqp_catalog533
eqp_status94
location86201
quantity3
purchase_price$1.74
commentsJohnny Test
received_date

2020/11/06 

assets[0][ASSET_TAG]assettag145
assets[0][SERIAL_NUM]serialnum145
assets[0][EQUIPMENT_ID]equipmentid145
units11

Results

If the request is successful, then the response will return as:

Toggle cloak

...

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

...