1. Shop Floor Tracking API | Shop floor tracking API is used to view where on the shop floor parts are currently being processed through. You can also use the API to transfer the parts between the different work centers of the shop floor. This allows the user to easily interact with the shop floor without having to navigate the MANEX Apps |
1.1. Shop Floor Tracking Transfer |
Transfer
The transfer function of the API is used to move the items of a work order between the different stages of the shop floor.
URL:{Root URL}/api/shopfloortracking/transfer/{API KEY}
Parameter |
Description |
Required |
Comment |
WoNo |
Work Order Number |
Y |
|
FromDeptNumber |
From Department Number |
Y |
Department number where the product is being transferred from. Must be a whole number with no decimals. |
FromDeptKey |
From Department Key |
Y |
Department Key where the product is being transferred from |
FromDeptUniqueRec |
From Department Unique Record |
Y |
Department Unique Record where the product is being transferred from |
ToDeptNumber |
To Department Number |
Y |
Department Number where the product is being transferred to. Must be a whole number with no decimals. |
ToDeptKey |
To Department Key |
Y |
Department Key where the product is being transferred to |
ToDeptUniqueRec |
To Department Unique Record |
Y |
Department Unique Record where the product is being transferred to |
transferQty |
Transfer Quantity |
Y |
Amount to be transferred |
serialNo |
Serial Number |
N |
Required if the part is serialized |
fromActvKey |
From Activity Key |
N |
Activity level where the part is being transferred from. Only needed if the work order has activity tracking turned on. |
toActvKey |
To Activity Key |
N |
Activity level where the part is being transferred to. Only needed if the work order has activity tracking turned on. |
WKey |
Warehouse Unique Record Identifier |
N |
Used to identify FGI when transferring to and from FGI. Required for a FGI transfer. If you have multiple locations, you will be able to provide 'Warehouse' and 'Location' if location is needed and the system will find the Wkey for you. |
Example requests
Transfer, no lot code, no serialization
URL- ?Wono=WONO&fromDeptNumber=1&toDeptNumber=2&transferQty=1
JSON
{
'WoNo':'WONO',
'fromDeptNumber':'1',
'toDeptNumber':'2',
'transferQty':'1'
}
Transfer serialized
URL-?wono=WONO&fromDeptNumber=1&toDeptNumber=2&TransferQty=1&SerialNo=000000000000000000000000000000
JSON
{
'WoNo':'WONO',
'fromDeptNumber':'1',
'toDeptNumber':'2',
'TransferQty':'1',
'SerialNo':'000000000000000000000000000000'
}
A successful transfer returns the following
{
"$id":"1",
"Code":200,
"Message":"Shop Floor Tracking transfer successfull.",
"SessionId":null,
"IsValidUser":true,
"ResponseObject":null
}
Common Errors
API Key Error
If there is an error with the API key the system will return an error describing it.
{
"$id": "1",
"Code": 403,
"Message": "Invalid API Key.",
"SessionId": null,
"IsValidUser": false,
"ResponseObject": null
}
JSON or URL Error
If there is an error with the URL used or some part of the JSON string the system will return a HTTP error.
{
"$id": "1",
"Message": "No HTTP resource was found that matches the request URI 'http://localhost/api/ShopFlooTracking/Transfer/123456789?won=4101'.",
"MessageDetail": "No type was found that matches the controller named 'ShopFlooTracking'."
}
Invalid Work Center
If one of the entered work centers is incorrect or does not exist for the work order then the system will return an error describing an invalid work center.
{
"$id": "1",
"Code": 403,
"Message": "Failed:The From and To Work Center/Activity (number/deptkey/uniquerec/actvkey) is not valid.",
"SessionId": null,
"IsValidUser": true,
"ResponseObject": null
}
Bad Work Order
If the entered work order is invalid or does not exist the system will return an error message describing the Work Order error.
{
"$id": "1",
"Code": 403,
"Message": "Failed:The Work Order Number does not exists.",
"SessionId": null,
"IsValidUser": true,
"ResponseObject": null
}
Permissions
The user needs the following checked on ManexCloud for permissions in order to use this API.
"Ignore Forced Routing Steps" needs to be checked for the user. See image below
|
1.2. Shop Floor Tracking Get |
Shop Floor Tracking Get API allows you to quickly view the status of work orders on the shop floor.
Get
The Get function of the shop floor tracking API allows you to view the stages of the shop floor for a selected work order.
URL:{Root URL}/api/shopfloortracking/get/{API KEY}
Parameter |
Description |
Required |
Comment |
WoNo |
Work Order Number |
Y |
|
includeActivities |
Choose whether to include all activities of the shop floor |
N |
Can be 0 or 1, default 0 |
includeSerialInformation |
Show all serial information with the results |
N |
Can be 0 or 1, default 0 |
serialNo |
Show all information related to a specific
serial number |
N |
Can be empty, if used must be padded with '0' up to 30 characters |
Dept_id |
Department ID Name |
N |
This value can be used to narrow the results to show a specific department |
deptKey |
Department Key |
N |
This value can be used to narrow down the results to show a specific department |
Example request:(Note that provided example strings are for demonstration only and will not work with your system)
URL- ?Wono=393
JSON
Results in the following information
{
"$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 a 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 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 detailing it.
{
"$id": "1",
"Code": 403,
"Message": "Failed:Please provide valid work order number",
"SessionId": null,
"IsValidUser": true,
"ResponseObject": null
}
|
|