Function
The Work Order (WO) Schedule Add API is used to edit existing schedule information on a WO.
URL
{Root URL}/API/WOSchedule/Edit/{API Key} |
Parameters
| Parameters | Description | Required | Comment | |
| 1 | WoNo | Work order Number | N | |
| 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, enter the following date format: MM-DD-YYYY. |
| 5 | duedt_uniq | Due date unique identifier | Y | Used to select due date information to edit. |
Example Strings
Edit Schedule
URL
?DueDt_Uniq=DueDt_Uniq&autoschedule=true |
JSON
{ “dueDt_Uniq”:”DueDt_Uniq”, “autoSchedule”:”true” } |
A successful edit should result in:
{ "$id": "1", "Code": "200", "Message": "WorkOrderSchedule edited successfully.", "SessionId": "null", "IsValidUser": "true", "ResponseObject": "null" } |
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/WOScheduleEdit/123456789'.", "MessageDetail": "No type was found that matches the controller named 'WOScheduleEdit'." } |
Missing Required Parameter
If a required parameter is missing, the system will return an error message describing the missing parameter:
{ "$id": "1", "Code": "403", "Message": "WorkOrderSchedule edit failed.Please provide DUEDT_UNIQ to edit work order schedule record.", "SessionId": "null", "IsValidUser": "true", "ResponseObject": "null" } |
Parameter Error
If one of the entered parameters is invalid, the system will return an error message describing the problem:
{ "$id": "1", "Code": "403", "Message": "WorkOrderSchedule edit failed.Work order schedule record for DUEDT_UNIQ does not exists ", "SessionId": "null", "IsValidUser": "true", "ResponseObject": "null" } |