| 1.1. Kit Issue API |
Kit Issue
Kit Issue API is used to issue parts from a warehouse into a Kit
URL-{Root URL}/API/Kit/Issue?{API Key}
Parameters
| Parameter |
Description |
Required |
Comment |
| WoNo |
Work Order Number |
N |
|
| KASEQNUM |
Unique Kitting Record Identifier |
Y |
|
| WKey |
Pick From Warehouse Key |
Y |
|
| PickQty |
Amount Being Picked |
Y |
|
| IssuedSerialNo |
Serial Number for Picked Part |
N |
Required if part is serialized |
| IssuedSerialUniq |
Unique Serial identifier |
N |
Can be used in place of IssuedSerialNo |
| overIssuedSerialNo |
Serial Number for over-issued quantity |
N |
Only required if there is over-issued quantity |
| overIssuedSerialUniq |
Unique Serial identifier for over-issued quantity |
N |
Only required if there is over-issued quantity |
| lotCode |
Lot Code |
N |
Required if the part is lot coded |
| expDate |
Expiration Date and time |
N |
Required if the part is Lot Coded Format example: 2018-08-08 00:00:00 |
| REFERENCE |
Issued Reference |
N |
Required if the part is Lot Coded Format Example: month/day/year |
| poNum |
Purchase Order Number |
N |
Part of the Lotcode Identification. Will not be empty if part was received by Purchase Order. But, can be left empty if the part was received by the way of general receiving. |
| IpKeyUnique |
IP Key |
N |
|
Example Strings
Kit Issue
URL-?KASEQNUM=KASEQNUM&WKey=WKEY&PickQty=QTY
JSON
{
'KASEQNUM':'KASEQNUM',
'WKey':'WKEY',
'PickQty':'QTY'
}
A successful request returns the following
{
"$id": "1",
"Code": 200,
"Message": "Kit issue successfull.",
"SessionId": null,
"IsValidUser": true,
"ResponseObject": null
}
Common Errors
URL Error
If there is an issue with the URL the system should return an error message showing that there is a problem with the URL
{
"$id": "1",
"Message": "No HTTP resource was found that matches the request URI 'http://localhost/api/Kit/Pick/123456789'.",
"MessageDetail": "No action was found on the controller 'Kit' that matches the request."
}
Not Enough Quantity
If there is not enough quantity in the warehouse to issue the system will return a "Not Enough Quantity" Error
{
"$id": "1",
"Code": 403,
"Message": "Failed:Not enough quantity to pick.",
"SessionId": null,
"IsValidUser": true,
"ResponseObject": null
}
Incorrect Parameter
If one of the parameters entered is incorrect then the system will return an error code describing which parameter has the error.
{
"$id": "1",
"Code": 403,
"Message": "Failed:KaMain record does not exists for Kaseqnum provided.",
"SessionId": null,
"IsValidUser": true,
"ResponseObject": null
}
|
| 1.2. Kit Update API |
Kit Update
Kit Update API is used to update an existing Kit using a current BOM
URL-{Root URL}/API/Kit/Update/{API Key}
Parameters
| Parameter |
Description |
Required |
Comment |
| WoNo |
Work Order Number |
Y |
WoNo is the only parameter required to update a kit. |
Example Strings
Kit Update
URL-?wono=WONO
JSON
A successful request returns the following
{
"$id":"1",
"Code":200,
"Placeholder",
"SessionId":null,
"IsValidUser":true,
"ResponseObject":null
}
Common Errors
API Error
If there is a problem with the API Key the system will return an invalid API key message
{
"$id": "1",
"Code": 403,
"Message": "Invalid API Key.",
"SessionId": null,
"IsValidUser": false,
"ResponseObject": null
}
Incorrect Parameter
If the parameter used is incorrect the system will return an error code describing it.
{
"$id": "1",
"Code": 403,
"Message": "Failed:The Work Order Number does not exists.",
"SessionId": null,
"IsValidUser": true,
"ResponseObject": null
}
Incorrect Parameter Name
If the parameter name used is incorrect the system will read it as a URL error and return a HTTP error message
{
"$id": "1",
"Message": "No HTTP resource was found that matches the request URI 'http://localhost/api/Kit/Open/123456789?won=4101'.",
"MessageDetail": "No action was found on the controller 'Kit' that matches the request."
}
|
|