Barcode API Calls

License

The Barcode module requires a separate license to be installed before key parts of the functionality are available. This license is disabled by default. Please contact PCR to obtain a license.

Before the Barcode API calls can be sent, the Barcode module must be activated, and PCR will need to set up a special Event in order to process Barcode Scan Transactions.

Using POST Calls

• POST requests will ignore parameters supplied as a query string and need any additional parameters in the request Body.

• To configure the number of Pages/Results returned by the API (this is most useful for the SQL Endpoint), you can send these as additional Parameter's in the Body.

  Parameter	Data Type	Default	Description
  limit	Interger	20	Number of listings to show.
  page	Interger	1	Page number to show.

• API fields are not case sensitive, and will always be returned in the lower case format.

Write Call

Available Fields

SD Equipment Status

Notes

• 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.

Available Fields

Notes

• For sde_status: Staged the following are required.
  • location - must be an active sub-Warehouse of the starting Warehouse
• For sde_status: Picked Up the following are required.
  • location - must be an active Warehouse
  • worker - Contact RECID - Worker type, Active
• For sde_status: Complete 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

http://DOMAIN/api/API_KEY/barcode.OUTPUT

Headers

Body

JSON Request:

Results

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

Warehouse Bulk Add

Notes

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

Available Fields

Notes

• It must be an active Equipment Catalog.
• A positive (none-zero) count and it cannot be null.
• Allowed Status'
  • Unassigned
  • Broken
  • Lost
  • Retired
  • Any custom status for the EQP_STATUS in the List Values table.
    
  • The API will give an error if the status is not one of the valid list values.
    
• The Warehouse must be active.
• Asset Array
  • Optional for Asset or Cabling Equipment (flags on Equipment Catalog).
  • It should be ignored (not put in db) if non-asset or non-cabling equipment is used.
  • The number of entries in the asset array must match the provided count.
• 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.

Request Example

Call

http://DOMAIN/api/API_KEY/barcode.OUTPUT

Headers

Body

JSON Request:

Results

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

Warehouse Bulk Transfer

Notes

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

Available Fields

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.

Request Example

Call

http://DOMAIN/api/API_KEY/barcode.OUTPUT

Headers

Body

JSON Request:

Results

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

Receive Purchase Order

Notes

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

Available Fields

Request Example

Call

http://DOMAIN/api/API_KEY/barcode.OUTPUT

Headers

Body

JSON Request:

Results

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

Warehouse Physical Inventory

Notes

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

Available Fields

Request Example

Call

http://DOMAIN/api/API_KEY/barcode.OUTPUT

Headers

Body

JSON Request:

Results

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

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.

{
  "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

When the Barcode Module is enabled, the Barcode is stored on the Equipment Catalog (Main > Catalogs > Equipment) for the Equipment expected to be scanned.

To locate Equipment data navigate to Main > Inventory > Equipment, to view actual Equipment records.

To locate Location data navigate to Main > Catalogs > Location, to view actual Location records.

To locate Service Desk data navigate to Main > Service Desk > My Service Desk > Equipment, to view actual Service Desk records related to Equipment.

All grids have the option to show the ROW ID column, which is also the RECID for that particular record.