Function
The Work Order (WO) Edit API is used to edit the details of an existing WO.
URL
{Root URL}/API/WO/Edit/{API Key} |
Parameters
| Parameter | Description | Required | Comment | |
| 1 | WoNo | Work order number | Y | |
| 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 | N | 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
Edit Work Order Quantity
URL
?WoNo=WONO&uniq_key=UNIQKEY&openclos=STANDARD&custno=CUSTOMERNUMBER&bldqty=QTY' |
JSON
{ “WoNo”:”WONO”, “uniq_key”:”UNIQKEY”, “openclos”:”STANDARD”, “custno”:”CUSTOMERNUMBER”, “bldqty”:”QTY” { |
A successful edit should result in:
{ "$id": "1", "Code": "200", "Message": "WorkOrder edited successfully.", "SessionId": "null", "IsValidUser": "true", "ResponseObject": "null" } |
Common Errors
API Key Error
If there is a problem with the entered API key, the system will return an error 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 used 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/WOEdit/123456789'.", "MessageDetail": "No type was found that matches the controller named 'WOEdit'." } |
JSON Error
If there is a problem with the setup of the JSON string, the system will return a "non-static method" message:
{ "$id": "1", "Code": "403", "Message": "WorkOrder edit failed.Non-static method requires a target.", "SessionId": "null", "IsValidUser": "true", "ResponseObject": "null" } |
Missing Required Parameter
If a required parameter is missing, the system will return an error message showing the missing parameter:
{ "$id": "1", "Code": "403", "Message": "WorkOrder edit failed.Please Provide Work Order Number.", "SessionId": "null", "IsValidUser": "true", "ResponseObject": "null" } |