Versions Compared

Old Version 1

changes.mady.by.user David Engblom

Saved on

compared with

New Version 2

changes.mady.by.user Brian Dixon

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

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
(2024.1) API
(2024.1) 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
...
KeyValue
transaction_typesd_eqp_status
recid53054
sde_status262
asset_tagassettag145
eqp_id39
location87963
worker63045
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": "sd_eqp_status",
							"recid": "53054",
							"sde_status": "262",
							"location": "87963",
							"worker": "63045",
							"type": "text"
							"assets":[
								{
									"ASSET_TAG": "assettag145", "EQUIPMENT_ID": "39"
								}]
						}
					]
				}

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

 Cloak

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

...
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
(2024.1) API
(2024.1) API
nopaneltrue

The RECID of the status of the Equipment.
eqp_conditionNoInteger
Value Lookups:
 Toggle cloak

 Cloak
 Insert excerpt
(2024.1) API
(2024.1) 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
...
KeyValue
transaction_type
whs_bulk_add
eqp_catalog533
eqp_status94
location86201
quantity1
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
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_bulk_add",
							"recid": "53054",
							"quantity": "1",
							"units": "11",
							"purchase_price": "1.74",
							"comments": "Johnny Test",
							"received_date": "2020/11/06",
							"location": "86201",
							"eqp_catalog": "533",
							"eqp_status": "94",
							"assets":[
								{
								 	"ASSET_TAG": "assettag145", "EQUIPMENT_ID": "equipmentid145", "SERIAL_NUM": "serialnum145"
								}]
						}
					]
				}

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

 Cloak

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

...
KeyValue
transaction_type
whs_bulk_transfer
eqp_catalog533
quantity23
from_location86201
to_location86200
commentsJohnny Test
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_bulk_transfer",
							"eqp_catalog": "533",
							"from_location": "86201",
							"to_location": "86200",
							"quantity": "23",
							"comments": "Johnny Test"
						}
					]
				}

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

 Cloak

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

...
KeyValue
recid 12874
eqp_catalog346
price9.99
quantity4
location694
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": "po_receive",
							"eqp_catalog": "346",
							"recid"": "12874",
							"location": "694",
							"quantity": "4",
							"price": "9.99"
						}
					]
				}

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

 Cloak

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

...
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"
								}]
						}
					]
				}

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

 Cloak

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

...
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"
        }
    ]
}
...