Page Comparison

Table of Contents

outline	true
style	none

...

Cloak

Code Block

language	xml
title	Example JSON Request

"request": {
				"method": "POST",
				"header": [
					{
						"keyContent-Type": "Content-Typeapplication/x-www-form-urlencoded",
						"valueCookie": "application/x-www-form-urlencoded{{DebugCookie}}",
						"typePCR-AUTH-TOKEN": "text"YOUR-AUTH-TOKEN-VALUE-HERE",
					},
					{],
						"keybody": "Cookie",{
						"valuemode": "{{DebugCookie}}urlencoded",
						"typeurlencoded": "text"[
					},
					{
							"keytransaction_type": "PCR-AUTH-TOKENsd_eqp_status",
							"valuerecid": "YOUR-AUTH-TOKEN-VALUE-HERE53054",
							"typesde_status": "text262",
					}
				],
				"body"location": {"87963",
							"modeworker": "urlencoded63045",
							"urlencodedtype": ["text"
						{	"assets":[
							"key": "transaction_type",
	{
									"valueASSET_TAG": "sd_eqp_statusassettag145", 							"type"EQUIPMENT_ID": "text39"
								},]
						{}
							"key": "recid",]
							"value": "53054",
							"type}

Results

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

Toggle cloak

Cloak

Code Block

{
    "message": "text"
						},
						{
							"key": "sde_status",
							"value": "262",
							"type": "text"
						},
						{
							"key": "location",
							"value": "87963",
							"type": "text"
						},
						{
							"key": "worker",
							"value": "63045",
							"type": "text"
						},
						{
							"key": "assets[0][ASSET_TAG]",
							"value": "assettag145",
							"type": "text",
							"disabled": true
						},
						{
							"key": "assets[0][EQUIPMENT_ID]",
							"value": "39",
							"type": "text",
							"disabled": true
						}
					]
				}

Results

...

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

Image Removed

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 trueImage Removed. Barcode requires authentication to work.

Available Fields

...

Parameter

...

Required

...

Data Type

...

Notes

...

eqp_catalog

...

Yes

...

Integer

...

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.

...

The reason why the Equipment is being added.

...

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.

Request Example

Call

Code Block

language	sql

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

Headers

...

Content-Type

...

application/json

...

PCR-AUTH-TOKEN

...

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

Body

...

whs_bulk_add

...

2020/11/06

...

Code Block

language	xml
title	Example JSON Request

"request": {
				"method": "POST",
				"header": [
					{
						"key": "Content-Type",
						"value": "application/x-www-form-urlencoded",
						"type": "text"
					},
					{
						"key": "Cookie",
						"value": "{{DebugCookie}}",
						"type": "text"
					},
					{
						"key": "PCR-AUTH-TOKEN",
						"value": "YOUR-AUTH-TOKEN-VALUE-HERE",
						"type": "text"
					}
				],
				"body": {
					"mode": "urlencoded",
					"urlencoded": [
						{
							"key": "transaction_type",
							"value": "whs_bulk_add",
							"type": "text"
						},
						{
							"key": "recid",
							"value": "53054",
							"type": "text"
						},
						{
							"key": "quantity",
							"value": "1",
							"type": "text"
						},
						{
							"key": "units",
							"value": "11",
							"type": "text"
						},
						{
							"key": "purchase_price",
							"value": "$1.74",
							"type": "text"
						},
						{
							"key": "comments",
							"value": "Johnny Test",
							"type": "text"
						}
						{
							"key": "received_date",
							"value": "2020/11/06",
							"type": "text"
						},
						{
							"key": "location",
							"value": "86201",
							"type": "text"
						},
						{
							"key": "eqp_catalog",
							"value": "533",
							"type": "text"
						},
						{
							"key": "eqp_status",
							"value": "94",
							"type": "text"
						},
						{
							"key": "assets[0][ASSET_TAG]",
							"value": "assettag145",
							"type": "text",
							"disabled": true
						},
						{
							"key": "assets[0][EQUIPMENT_ID]",
							"value": "equipmentid145",
							"type": "text",
							"disabled": true
						},
							"key": "assets[0][SERIAL_NUM]",
							"value": "serialnum145",
							"type": "text",
							"disabled": true
						}
					]
				}

Results

...

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

Image Removed

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 Image Removed. Barcode requires authentication to work.

Available Fields

...

Parameter

...

Required

...

Data Type

...

Notes

...

eqp_catalog

...

Yes

...

Integer

...

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

Code Block

language	sql

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

Headers

...

Content-Type

...

application/json

...

PCR-AUTH-TOKEN

...

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

Body

...

transaction_type

...

Code Block

language	xml
title	Example JSON Request

"request": {
				"method": "POST",
				"header": [
					{
						"key": "Content-Type",
						"value": "application/x-www-form-urlencoded",
						"type": "text"
					},
					{
						"key": "Cookie",
						"value": "{{DebugCookie}}",
						"type": "text"
					},
					{
						"key": "PCR-AUTH-TOKEN",
						"value": "YOUR-AUTH-TOKEN-VALUE-HERE",
						"type": "text"
					}
				],
				"body": {
					"mode": "urlencoded",
					"urlencoded": [
						{
							"key": "transaction_type",
							"value": "whs_bulk_transfer",
							"type": "text"
						},
						{
							"key": "eqp_catalog",
							"value": "533",
							"type": "text"
						},
						{
							"key": "from_location",
							"value": "86201",
							"type": "text"
						},
					 	{
							"key": "to_location",
							"value": "86200",
							"type": "text"
						},
						{
							"key": "quantity",
							"value": "23",
							"type": "text"
						},
						{
							"key": "comments",
							"value": "Johnny Test",
							"type": "text"
						}
					]
				}

Results

...

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

Image Removed

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 Image Removed. Barcode requires authentication to work.

Available Fields

...

Parameter

...

Required

...

Data Type

...

Notes

...

Request Example

Call

Code Block

language	sql

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

Headers

...

Content-Type

...

application/json

...

PCR-AUTH-TOKEN

...

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

Body

...

Cloak

Code Block

language	xml
title	Example JSON Request

"request": {
				"method": "POST",
				"header": [
					{
						"key": "Content-Type",
						"value": "application/x-www-form-urlencoded",
						"type": "text"
					},
					{
						"key": "Cookie",
						"value": "{{DebugCookie}}",
						"type": "text"
					},
					{
						"key": "PCR-AUTH-TOKEN",
						"value": "YOUR-AUTH-TOKEN-VALUE-HERE",
						"type": "text"
					}
				],
				"body": {
					"mode": "urlencoded",
					"urlencodedBarcode transaction added successfully."
}

Image Added

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 trueImage Added. Barcode requires authentication to work.

Available Fields

Parameter

Required

Data Type

Options

Notes

eqp_catalog

Yes

Integer

RECID of the Equipment's Equipment Catalog.

eqp_status

Yes

Integer

Lists

Toggle cloak

Cloak

Insert excerpt

	API
	API
nopanel	true

The RECID of the status of the Equipment.

eqp_condition

No

Integer

Lists

Toggle cloak

Cloak

Insert excerpt

	API
	API
nopanel	true

The RECID of the condition of the Equipment.

received_date

No

Date

The date the Equipment was Received. Format "YYYY/MM/DD"

location

Yes

Integer

RECID of the Warehouse of the Equipment. Must be an active Warehouse.

quantity

Yes

Integer

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_price

No

Float

The purchase price of the Equipment must be greater than or equal to zero.

assets

No

Array

Only valid for Asset or Cabling Equipment, else ignored. If provided the number of entries must match the quantity.

comments

Yes

String

The reason why the Equipment is being added.

units

No*

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.

Request Example

Call

Code Block

language	sql

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

Headers

Key	Value
Content-Type	application/json
PCR-AUTH-TOKEN	example: e036a785-4d7a-40ed-a04a-c8e339327f55

Body

Key	Value
transaction_type	whs_bulk_add
eqp_catalog	533
eqp_status	94
location	86201
quantity	1
purchase_price	$1.74
comments	Johnny Test
received_date	2020/11/06
assets[0][ASSET_TAG]	assettag145
assets[0][SERIAL_NUM]	serialnum145
assets[0][EQUIPMENT_ID]	equipmentid145
units	11

JSON Request:

Toggle cloak

Cloak

Code Block

language	xml
title	Example 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"
								}]
						}
					]
				}

Results

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

Toggle cloak

Cloak

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

Image Added

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 Image Added. Barcode requires authentication to work.

Available Fields

Parameter	Required	Data Type	Notes
eqp_catalog	Yes	Integer	RECID of the Equipment's Equipment Catalog.
quantity	No	Integer	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_location	Yes	Integer	Location RECID of the Warehouse of the Equipment is from.
to_location	Yes	Integer	Location RECID of the Warehouse of the Equipment is going to.
recids	No*	Array	Conditionally Required if the Equipment is an Asset. An array of Asset Tags, Serial Numbers and/or Equipment IDs (id # on the equipment record). See the Notes section below.
comments	Yes	String	The reason why the Equipment is being transferred.

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

Code Block

language	sql

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

Headers

Key	Value
Content-Type	application/json
PCR-AUTH-TOKEN	example: e036a785-4d7a-40ed-a04a-c8e339327f55

Body

Key	Value
transaction_type	whs_bulk_transfer
eqp_catalog	533
quantity	23
from_location	86201
to_location	86200
comments	Johnny Test

JSON Request:

Toggle cloak

Cloak

Code Block

language	xml
title	Example JSON Request

"request": {
				"method": "POST",
				"header": [
						{
							"keyContent-Type": "transaction_typeapplication/x-www-form-urlencoded",
							"valueCookie": "po_receive{{DebugCookie}}",
							"typePCR-AUTH-TOKEN": "text"
	YOUR-AUTH-TOKEN-VALUE-HERE",
					},
						{],
							"keybody": "eqp_catalog",
	{
						"valuemode": "346urlencoded",
							"typeurlencoded": "text"[
						},
						{{   
							"keytransaction_type": "recidwhs_bulk_transfer",
							"valueeqp_catalog": "12874533",
							"typefrom_location": "text"
						},
						{86201",
							"keyto_location": "location86200",
							"valuequantity": "69423",
							"typecomments": "textJohnny Test"
						},
						{]
							"key": "quantity",
							"value": "4",
							"type": "text"
						},
						{
							"key": "price",
							"value": "9.99",
							"type": "text"
						}
					]
				}

Results

...

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

Image Removed

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 Image Removed. Barcode requires authentication to work.

Available Fields

...

Parameter

...

Required

...

Data Type

...

Notes

...

Request Example

Call

Code Block

language	sql

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

Headers

...

Content-Type

...

application/json

...

PCR-AUTH-TOKEN

...

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

Body

...

Cloak

Code Block

language	xml
title	Example JSON Request

"request}

Results

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

Toggle cloak

Cloak

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

Image Added

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 Image Added. Barcode requires authentication to work.

Available Fields

Parameter	Required	Data Type	Notes
recid	Yes	Integer	Purchase Order RECID, Status must be Open
eqp_catalog	Yes	Integer	Equipment Catalog RECID
price	Yes	Float	Price of Equipment
units	No	Integer	Units of Equipment, Note: that this will default to 1 for units catalogs. It is ignored for non-unit catalogs
quantity	Yes	Integer	Quantity to Receive
location	Yes	Integer	Valid Active Warehouse RECID to receive Equipment
received_date	No	Date	Received Date
assets	No	Array	Only valid for Asset or Cabling Equipment, else ignored. If provided the number of entries must match the quantity.

Request Example

Call

Code Block

language	sql

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

Headers

Key	Value
Content-Type	application/json
PCR-AUTH-TOKEN	example: e036a785-4d7a-40ed-a04a-c8e339327f55

Body

Key	Value
recid	12874
eqp_catalog	346
price	9.99
quantity	4
location	694

JSON Request:

Toggle cloak

Cloak

Code Block

language	xml
title	Example JSON Request

"request": {
				"method": "POST",
				"header": [
					{
						"Content-Type": "application/x-www-form-urlencoded",
						"Cookie": "{{DebugCookie}}",
						"PCR-AUTH-TOKEN": "YOUR-AUTH-TOKEN-VALUE-HERE",
					}
				],
				"body": {
					"methodmode": "POSTurlencoded",
					"headerurlencoded": [
						{   
							"transaction_type": "po_receive",
							"keyeqp_catalog": "346",
							"recid"": "Content-Type12874",
							"valuelocation": "application/x-www-form-urlencoded694",
							"typequantity": "text"
					}4",
					{
						"keyprice": "Cookie9.99",
						"value": "{{DebugCookie}}",
					]
				"type}

Results

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

Toggle cloak

Cloak

Code Block

{
    "message": "textBarcode transaction added successfully."
					},
					{
						"key": "PCR-AUTH-TOKEN",
						"value": "YOUR-AUTH-TOKEN-VALUE-HERE",
						"type": "text"
					}
				],
				"body": {
					"mode": "urlencoded",
					"urlencoded": [
						{
							"key": "transaction_type",
							"value": "whs_physical_inventory",
							"type": "text"
						},
	}

Image Added

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 Image Added. Barcode requires authentication to work.

Available Fields

Parameter	Required	Data Type	Notes
scan_date	No	Date	Expected format: YYYY/MM/DD
eqp_catalog	Yes	Integer	Equipment Catalog RECID
units	No	Integer	Units of Equipment, Note: that this will default to 1 for units catalogs. It is ignored for non-unit catalogs
quantity	Yes	Integer	Quantity to Receive
location	Yes	Integer	Valid Active Warehouse RECID to receive Equipment
assets	No	Array	Only valid for Asset or Cabling Equipment, else ignored. If provided the number of entries must match the quantity.

Request Example

Call

Code Block

language	sql

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

Headers

Key	Value
Content-Type	application/json
PCR-AUTH-TOKEN	example: e036a785-4d7a-40ed-a04a-c8e339327f55

Body

Key	Value
scan_date	2000/01/01
eqp_catalog	346
quantity	1
location	694
assets	bcasset1sd126

JSON Request:

Toggle cloak

Cloak

Code Block

language	xml
title	Example JSON Request

"request": {
				"method": "POST",
				"header": [
					{
							"keyContent-Type": "eqp_catalogapplication/x-www-form-urlencoded",
							"valueCookie": "346{{DebugCookie}}",
							"typePCR-AUTH-TOKEN": "text"
						}YOUR-AUTH-TOKEN-VALUE-HERE",
					}
	{
			],
				"keybody": "location",{
							"valuemode": "694urlencoded",
							"typeurlencoded": "text"[
						},
						{{  
							"keytransaction_type": "quantitywhs_physical_inventory",
							"valueeqp_catalog": "1346",
							"typelocation": "text"
						},
						{694",
							"keyquantity"": "scan_date1",
							"valuescan_date": "2000/01/01",
							"typeassets": "text"[
						},
			{
			{
							"key": "assets[0][ASSET_TAG]",
							"value": "bcasset1sd126",
							"type": "text",
							"disabled": true	}]
						}
					]
				}

Results

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

Toggle cloak

...

Page Comparison

Versions Compared

Old Version 2

New Version 3

Key

Results

Results

Warehouse Bulk Add

Available Fields

Request Example

Call

Headers

Body

Results

Warehouse Bulk Transfer

Available Fields

Request Example

Call

Headers

Body

Results

Receive Purchase Order

Available Fields

Request Example

Call

Headers

Body

Warehouse Bulk Add

Available Fields

Request Example

Call

Headers

Body

JSON Request: Toggle cloak

Results

Warehouse Bulk Transfer

Available Fields

Request Example

Call

Headers

Body

JSON Request: Toggle cloak

Results

Warehouse Physical Inventory

Available Fields

Request Example

Call

Headers

Body

Results

Receive Purchase Order

Available Fields

Request Example

Call

Headers

Body

JSON Request: Toggle cloak

Results

Warehouse Physical Inventory

Available Fields

Request Example

Call

Headers

Body

JSON Request: Toggle cloak

Results

JSON Request:
Toggle cloak

JSON Request:
Toggle cloak

JSON Request:
Toggle cloak

JSON Request:
Toggle cloak