Functions
The Work Order (WO) Schedule Get API is used to find and view existing schedule information for a WO.
URL
{Root URL}/API/WOSchedule/Get/{API Key} |
Parameter
Parameters | Description | Required | Comment | |
1 | WoNo | Work order number | Y |
Example Strings
Schedule Get
URL
?WoNo=WONO |
JSON
{ "WoNo":"WONO" } |
A successful get should result in:
{ "$id": "1", "Code": "200", "Message": "WorkOrderSchedule details:", "SessionId": "null", "IsValidUser": "true", "-ResponseObject": [ -{ "$id": "2", "DUEDT_UNIQ": "69F6SVHN7L", "WONO": "410 ", "DUE_DTS": "2014-11-07T00:00:00", "QTY": "0", "AUTOSCHEDULE": "false" } ] } |
Common Errors
Invalid API Key
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 the entered URL is invalid, the system will return an HTTP error message:
{ "$id": "1", "Message": "No HTTP resource was found that matches the request URI 'http://localhost/api/WOScheduleGet/123456789?Wono=410'.", "MessageDetail": "No type was found that matches the controller named 'WOScheduleGet'." } |
The Schedule Does Not Exist
If the requested schedule information does not exist, the system will return a "Work Order Schedule does not exist" error message:
{ "$id": "1", "Code": "403", "Message": "WorkOrderSchedule does not exists.", "SessionId": "null", "IsValidUser": "true", "ResponseObject": "null" } |