Functions
The Work Order (WO) Schedule Add API is used to add scheduling information to an existing WO.
URL
{Root URL}/API/WOSchedule/Add/{API Key} |
Parameters
| Parameters | Description | Required | Comment | |
| 1 | WoNo | Work order number | Y | |
| 2 | autoSchedule | Auto schedule | Y | Can be "true" or "false." |
| 3 | qty | Scheduled quantity | N | Not required if autoSchedule is "true." |
| 4 | due_dts | Due date | N | Not required if autoSchedule is "true." If used, then use the following date format: MM-DD-YYYY. |
| 5 | duedt_uniq | Due date unique identifier | N | Can be used in place of due_dts, and must be unique. |
Example Strings
Add Auto-Schedule
URL
?WoNo=WONO&autoschedule=true |
JSON
{ "WoNo":"WONO", "autoSchedule":"true" } |
A successful add should result in:
{ "$id: "1", "Code": "200", "Message": "WorkOrderSchedule added successfully.", "SessionId": "null", "IsValidUser": "true", "-ResponseObject": { "$id": "2", "DUEDT_UNIQ": "NCJZ0IQGNK", "WONO": "0000000410", "DUE_DTS": "2014-11-25T00:00:00", "QTY": "210", "AUTOSCHEDULE": "true" } } |
Add Manual Schedule
URL
?WoNo=WONO&autoSchedule=false&due_dts=MM-DD-YYYY |
JSON
{ “WoNo”:”WONO”, “autoSchedue”:”false”, “due_dts”:”MM-DD-YYYY” } |
A successful add should result in:
{ "$id": "1", "Code": "200", "Message": "WorkOrderSchedule added successfully.", "SessionId": "null", "IsValidUser": "true", "-ResponseObject": { "$id": "2", "DUEDT_UNIQ": "69F6SVHN7L", "WONO": "0000000410", "DUE_DTS": "2014-11-07T00:00:00", "QTY": "0", "AUTOSCHEDULE": "false" } } |
Common Errors
API Key Error
If the entered API Key is invalid, the system will return an "Invalid 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 entered URL, the system will return an error describing it:
{ "$id": "1", "Message": "No HTTP resource was found that matches the request URI 'http://localhost/api/WOScheduleAdd/123456789'.", "MessageDetail": "No type was found that matches the controller named 'WOScheduleAdd'." } |
Parameter Error
If there is an error with one of the entered parameters, the system will return a "Work Order Schedule Add Failed" error message:
{ "$id": "1", "Code": "403", "Message": "WorkOrderSchedule add failed.", "SessionId": "null", "IsValidUser": "true", "ResponseObject": "null" } |