Note: the Transfer API requires specific permissions to be enabled in order to use. See prerequisite permissions at the end of this article.
URL
{Root URL}/api/shopfloortracking/transfer/{API KEY} |
Parameters
| Parameter | Description | Required | Comment | |
| 1 | WoNo | Work order number | Y | |
| 2 | FromDeptNumber | From department number | Y | This is the department number that the product is being transferred from. Must be a whole number with no decimals. |
| 3 | FromDeptKey | From department key | Y | This is the department key that the product is being transferred from. |
| 4 | FromDeptUniqueRec | From department unique record | Y | This is the department's unique record of where the product is being transferred from. |
| 5 | ToDeptNumber | To department number | Y | This is the department number to which the product is being transferred. Must be a whole number with no decimals. |
| 6 | ToDeptKey | To department key | Y | The department key that the product is being transferred to. |
| 7 | ToDeptUniqueRec | To department unique record | Y | The department's unique record of where the product is being transferred to. |
| 8 | transferQty | Transfer quantity | Y | The amount to be transferred. |
| 9 | serialNo | Serial number | N | Required if the part is serialized. |
| 10 | 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. |
| 11 | 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. |
| 12 | WKey | Warehouse unique record identifier | N | Used to identify FGI when transferring to and from FGI. Required for an FGI transfer. If you have multiple locations, you will be able to provide the "Warehouse" and "Location" if the 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 being used or some part of the JSON string, the system will return an 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, 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" } |
Prerequisite Permissions
The user needs the following permissions checked in manexCloud in order to use this API.
Path: System Setup > Group Admin > Production 1
The "Ignore Forced Routing Steps" box needs to be checked (see image below).
