REST Object Definitions Work Order Activity Related Objects Required Part Object

The RequiredPart object contains part order details. The RequiredPart object is always used inside of another object such as the appointment search object, book job etc.

RequiredPart Object Formats

JSON Format

{
	"Delete": false,
	"EstimatedDelivery": "2014-12-15T10:00:00.000Z",
	"PartOrderNum": "",
	"PartStatus": "",
	"Price": 0,
	"ProdAttrs": {
		"Desc": ""
	},
	"ProdNum": "1001",
	"Qty": 0,
	"ShipToLocation": "",
	"SupersededParts": [{
		"ProdNum": "",
		"PartStatus": "{free text}",
		"ProdAttrs": {
			"Desc": "",
			"IsBatch": false,
			"IsInvCtrl": false,
			"IsSerialized": false,
			"ProdType": "1001"
		},
		"Qty": 10
	}],
	"SupersededPartsDesc": "",
	"Urgency": ""
}

RequiredPart Object Properties

Required properties are in bold.

Property

Type

Description

EstimatedDelivery

datetime

This optional property specifies the estimate delivery date of the associated part.

This property is calculated and populated by the back end system if a connection is available at the time the part is ordered. Otherwise, this property will be left empty.

PartOrderNum string The order number associated with the part being ordered.

PartStatus

string

Specifies the status of ordered part. This is a simple free-form text field with no validation.

3.18.0

Price

decimal

The price of the ordered part.

This property is set by the backend system if a network connection is available at the time the part is ordered. Otherwise, the mobile application will use the default price from the Product catalog.

ProdAttrs

object

This object contains the ordered part's product attributes from the Product table. If this object is not specified, then the Broker ESB will automatically populate it from the details in the Product table.

If the Product table is not being managed through the Product REST APIs, then this object is required.

Property	Type	Description
Desc	string	Provides the description of the product item. This description will be in the preferred language of the technician.
IsBatch	boolean	Identifies if this product item is batch controlled. If `true`, then the `BatchNum` property is required. Valid values are: `true` - Item is batch controlled. `false` - Item is not batch controlled. This is the default value if this property is missing.
IsInvCtrl	boolean	Identifies if this product is under inventory control. If `true`, then the application will automatically adjust the proper storage location's inventory based on the item usage. Valid values are: `true` - Item is under inventory control. `false` - Item is not under inventory control. This is the default value if this property is missing.
IsSerialized	boolean	Identifies if this product item is serialized or not. If `true`, then the `SerialNum` property is required. Valid values are: `true` - Item is serialized and requires a serial number. `false` - Item is not serialized. This is the default value if this property is missing.
ProdType	string	Identifies the product item type or category. See: Product Types System Category

See: Product Object

PartNum string The product number of the ordered part.

Qty decimal The quantity being ordered.

ShipToLocation string The location where the parts are to be shipped (see REST System Categories Ordered Parts Shipping Location in system categories).

SupersededParts

collection

This optional collection contains a list of parts that replaces the ordered part.

Property	Type	Description
ProdNum	string	The product number of the replacement part.
PartStatus	string	Specifies the status of replacement part. This is a simple free-form text field with no validation.
ProdAttrs	object	Product attributes of the ordered part. See: Product Object
Qty	decimal	The quantity being ordered.

3.18.0

Urgency

string

This property identifies shipping urgency for the ordered part (see REST System Categories Ordered Parts Shipping Urgency in system categories).

3.18.1