| WO Edit |
Functions
WO Edit API is used to edit the details of an existing Work Order.
URL-{Root URL}/API/WO/Edit/{API Key}
Parameters
| Parameter |
Description |
Required |
Comment |
| WoNo |
Work Order Number |
Y |
|
| Uniq_Key |
Item Unique Identifier |
Y |
Used to Choose the item to be built in the Work Order |
| openclos |
Work Order Status |
Y |
Can be STANDARD, PRIORITY-1, PRIORITY-2, FIRM PLAN, ADMIN HOLD, MFG HOLD, REWORK, REWORK FIRM, CANCEL |
| Due_Date |
Work Order Due Date |
N |
Use MM-DD-YYYY format |
| custNo |
Customer Number |
Y |
Must be an existing customer |
| 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 a 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
}
|
|