Function
The Work Order (WO) Add API is used to add a new WO.
URL
{Root URL}/API/WO/Add/{API Key} |
Parameters
| Parameter | Description | Required | Comment | |
| 1 | WoNo | Work order number | N | |
| 2 | Uniq_Key | Item unique identifier | Y | Used to choose the item to be built in the work order. |
| 3 | openclos | Work order status | Y | Can be "STANDARD", "PRIORITY-1", "PRIORITY-2", "FIRM PLAN", "ADMIN HOLD", "MFG HOLD", "REWORK", "REWORK FIRM", or "CANCEL". |
| 4 | Due_Date | Work order due date | Y | Uses the following date format: MM-DD-YYYY. |
| 5 | custNo | Customer number | Y | Must be an existing customer. |
| 6 | bldQty | Build quantity | N | Amount to be built in the work order. |
Example Strings
Add Work Order
URL
?uniq_key=UNIQKEY&openclos=STANDARD&Due_Date=MM-DD-YYYY&custno=CUSTOMERNUMBER&bldqty=QTY' |
JSON
{ “uniq_key”:”UNIQKEY”, “open close”:”STANDARD”, “Due_Date”:"MM-DD-YYYY”, “custno”:”CUSTOMERNUMBER”, “bldqty”:”QTY” } |
A successful request should result in:
{ "$id": "1", "Code": "200", "Message": "WorkOrder added successfully.", "SessionId": "null", "IsValidUser": "true", "-ResponseObject": { "$id": "2", "WONO": "0000000410", "UNIQ_KEY": "FW7064W8L8", "OPENCLOS": "STANDARD", "ORDERDATE": "2014-11-04T14:55:50.9647637-05:00", "DUE_DATE": "2014-11-07T00:00:00", "AUDPLACE": "", "BLDQTY": "100", "COMPLETE": "0", "BALANCE": "100", "WONOTE": "", "IS_CLOSED": "false", "DATECHG": "null", "PLANTNO": "", "AUDBY": "", "AUDDATE": "null", "MATL_CK": "", "ENGR_CK": "", "QLTY_CK": "", "SALE_CK": "", "KIT_NOTE": "", "MRP_DONE": "false", "ORD_TYPE": "", "MAT_REQ_DT": "null", "MAT_REQ_Q": "0", "MAT_REQ_D": "", "PROD_TIME": "0", "TTSETPTIME": "0", "ISSUED": "false", "ENG_APPR": "false", "ENG_APPD": "null", "ENG_APPT": "", "ENG_APPI": "", "SHFLNOTE": "", "ORIG_DUEDT": "null", "BUILDABLE": "0", "SCHED_FB": "0", "IS_ALLOC": "false", "KITSTATUS": "", "KITCLOSEDT": "null", "START_DATE": "null", "CUSTNO": "0000000008", "SONO": "", "KIT": "false", "SHTGNOTE": "", "RELEDATE": "null", "SERIALYES": "false", "UNIQUELN": "", "GLDIVNO": "", "CMPRICELNK": "", "EACHQTY": "0", "FSTDUEDT": "null", "DELIFREQ": "", "PRJUNIQUE": "", "ARCSTAT": "", "SQCSTATUS": "", "KITLSTCHDT": "null", "KITLSTCHINIT": "null", "MRPONHOLD": "false", "COMPLETEDT": "null", "KITSTARTINIT": "null", "KITCLOSEINIT": "null", "KITCOMPLETE": "false", 'KITCOMPLDT": "null", "KITCOMPLINIT": "null", "LFCSTITEM": "true", "LIS_RWK": "false", "UNIQUEREC": "null", "UNIQUERECID": "null" } } |
Common Errors
API Key Error
If there is a problem with the entered API Key, the system will return an API Key error message:
{ "$id": "1", "Code": "403", "Message": "Invalid API Key.", "SessionId": "null", "IsValidUser": "false", "ResponseObject": "null" } |
URL Error
If there is an error with the used URL, the system will return an HTTP error:
{ "$id": "1", "Message": "No HTTP resource was found that matches the request URI 'http://localhost/api/WOAdd/123456789'.", "MessageDetail": "No type was found that matches the controller named 'WOAdd'." } |
JSON Error
If there is an error with the JSON string, the system will return an "Object Reference" error:
{ "$id": "1", "Code": "403", "Message": "WorkOrder add failed.Object reference not set to an instance of an object.", "SessionId": "null", "IsValidUser": "true", "ResponseObject": "null" } |
Missing required parameter
If a required parameter value is missing, the system will return an error message describing the missing parameter:
{ "$id": "1", "Code": "403", "Message": "WorkOrder add failed.Work Order Uniq_Key is required", "SessionId": "null", "IsValidUser": "true", "ResponseObject": "null" } |