Start

Start

This resource represents various types of machine start requests.


Request a machine start

This will send a start request to the reader, but will not start the machine. User confirmation is required on the reader before the machine will start.

Request

Request Body

Field Name

Type

Description

Notes

Field Name

Type

Description

Notes

Type

integer

Start request type

3 = Machine start
4 = WDF Machine start

Code

string

Machine record ID

Machine record ID obtained through Machine API

WdfOrderID

integer

WDF Order ID

Required only for requesting machine start to be applied to Wash-Dry-Fold order (type=4). This field is ignored for other types.

Response

{ "Type": "MachSwipe", "AccountID": "12", "LocationID": "2", "MachineID": "4311", "MachLabel": "1", "MachNo": "1" }

Field Name

Type

Description

Notes

Field Name

Type

Description

Notes

Type

string

Start response type

MachSwipe

AccountID

string

Account ID

 

LocationID

string

Location record ID

 

MachineID

string

Machine record ID

 

MachineLabel

string

Machine label

 

MachNo

string

Machine number

 

See Error Handling

POST  /api/Start

Example requesting a machine start of Machine ID of 123
{ "Type": "3", "Code": "123" }
Example requesting a machine start of Machine ID of 123 associated with WDF order ID 456
{ "Type": "4", "Code": "123", "WdfOrderID": "456" }