Function
The Shop Floor Tracking Get API allows you to quickly view the status of work orders on the shop floor.
URL
{Root URL}/api/shopfloortracking/get/{API KEY} |
Parameters
| Parameter | Description | Required | Comment | |
| 1 | WoNo | Work order number | Y | |
| 2 | IncludeActivities | Choose whether to include all activities of the shop floor | N | Can be "0" or "1," but the default is "0." |
| 3 | IncludeSerialInformation | Show all serial information with the results | N | Can be "0" or "1," but the default is "0." |
| 4 | SerialNo | Show all information related to a specific serial number | N | Can be empty, but if used must be populated with "0" up to 30 characters |
| 5 | Dept_id | Department ID name | N | This value can be used to narrow down the results to show a specific department. |
| 6 | DeptKey | Department key | N | This value can be used to narrow down the results to show a specific department. |
Example Request
URL
?Wono=393 |
JSON
{ "WoNo":"393" } |
A successful request returns the following:
{ "$id":"1", "Code":"200", "Message":"Shop Floor Tracking details:", "SessionId":"null", "IsValidUser":"true", "ResponseObject":{ "$id":"2", "SerializedDeptQtyList":"null", "DeptQtyList": [{ "$id":"3", "WONO":"0000000393", "DEPT_ID":"PP-T", "Dept_Name":"PICK & PLACE SMT,TOP SIDE", "CURR_QTY":"0.0", "NUMBER":5."0", "DeptKey":"_26G0V7PBG", "SERIALSTRT":"true" },{ "$id":"4", "WONO":"0000000393", "DEPT_ID":"ATE ", "Dept_Name":"ATE/BURN-IN OF COMPONENTS", "CURR_QTY":"0.0", "NUMBER":"2.0", "DeptKey":"_26G0V7MLP", "SERIALSTRT":"false" },{ "$id":"5", "WONO":"0000000393", "DEPT_ID":"STAG", "Dept_Name":"Material Staging ", "CURR_QTY":"100.0", "NUMBER":"1.0", "DeptKey":"_2600WHEBG", "SERIALSTRT":"false" },{ "$id":"6", "WONO":"0000000393", "DEPT_ID":"WAVE", "Dept_Name":"Wave Soldering ", "CURR_QTY":"0.0", "NUMBER":"4.0", "DeptKey":"_26G0V7OJE", "SERIALSTRT":"false" },{ "$id":"7", "WONO":"0000000393", "DEPT_ID":"AI ", "Dept_Name":"AUTO INSERT-THT COMPONENT", "CURR_QTY":"0.0", "NUMBER":"3.0", "DeptKey":"_26G0V7NN6", "SERIALSTRT":"false" },{ "$id":"8", "WONO":"0000000393", "DEPT_ID":"SCRP", "Dept_Name":"Scrapped Material ", "CURR_QTY":"0.0", "NUMBER":"7.0", "DeptKey":"_2600WHEBI", "SERIALSTRT":"false" },{ "$id":"9", "WONO":"0000000393", "DEPT_ID":"FGI ", "Dept_Name":"Finished Goods Inventory", "CURR_QTY":"0.0", "NUMBER":"6.0", "DeptKey":"_2600WHEBH", "SERIALSTRT":"false" }], "SftAdditionalDetails":"null" } } |
Common Errors
URL Error
If there is an error in the URL, the system will return an HTTP error:
{ "$id": "1", "Message": "No HTTP resource was found that matches the request URI 'http://localhost/api/ShopFlooTracking/Get/123456789?wono=410'.", "MessageDetail": "No type was found that matches the controller named 'ShopFlooTracking'." } |
API Key Error
If there is an error with the API key, the system will return an error message describing it:
{ "$id": "1", "Code": "403", "Message": "Invalid API Key.", "SessionId": "null":, "IsValidUser": "false", "ResponseObject": "null" } |
Invalid Parameter
If there is an error with a parameter value, the system will return an error message describing it:
{ "$id": "1", "Code": "403", "Message": "Failed:Please provide valid work order number", "SessionId": "null", "IsValidUser": "true", "ResponseObject": "null" } |