Function
The Work Order (WO) Get API is used to find and view information for existing an WO.
URL
| {Root URL}/API/WO/Get/{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
Work Order Get
URL
?WoNo=WONO |
JSON
{ "WoNo":"WONO" } |
A successful request should result in:
{ "$id": "1", "Code": "200", "Message": "WorkOrder details:", "SessionId": "null", "IsValidUser": "true", "ResponseObject": [ { "$id": "2", "WONO": "0000000410", "UNIQ_KEY": "FW7064W8L8", "OPENCLOS": "STANDARD ", "ORDERDATE": "2014-11-04T14:56:00", "DUE_DATE": "2014-11-07T00:00:00", "AUDPLACE": " ", "BLDQTY": "210", "COMPLETE": "0", "BALANCE": "210", "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": "KIT PROCSS", "KITCLOSEDT": "null", "START_DATE": "2014-11-06T14:33:00", "CUSTNO": "0000000008", "SONO": " ", "KIT": "false", "SHTGNOTE": "", "RELEDATE": "null", "SERIALYES": "false", "UNIQUELN": " ", "GLDIVNO": " ", "CMPRICELNK": " ", "EACHQTY": "0", "FSTDUEDT": "null", "DELIFREQ": " ", "PRJUNIQUE": " ", "ARCSTAT": " ", "SQCSTATUS": " ", "KITLSTCHDT": "2014-11-06T14:33:00", "KITLSTCHINIT": "T1000 ", "MRPONHOLD": "false", "COMPLETEDT": "null", "KITSTARTINIT": "T1000 ", "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 error message describing it:
{ "$id": "1", "Code": "403", "Message": "Invalid API Key.", "SessionId": "null", "IsValidUser": "false", "ResponseObject": "null" } |
URL Error
If there is an error with the URL, the system will return an HTTP error message:
{ "$id": "1", "Message": "No HTTP resource was found that matches the request URI 'http://localhost/api/WOGet/123456789'.", "MessageDetail": "No type was found that matches the controller named 'WOGet'." } |
Not Enough Information
If not enough information is provided to get a work order, the system will return a "Not Enough Information" error message:
{ "$id": "1", "Code": "403", "Message": "Not enough information to return the data, please provide valid parameters.", "SessionId": "null", "IsValidUser": "true", "ResponseObject": "null" } |
Work Order Doesn't Exist
If the work order entered doesn't exist, the system will return an error message saying, "work order doesn't exist":
{ "$id": "1", "Code": "403", "Message": "WorkOrder does not exist.", "SessionId": "null", "IsValidUser": "true", "ResponseObject": "null" } |