Function
The Kit Update API is used to update an existing kit using a current bill of material (BOM).
URL
{Root URL}/API/Kit/Update/{API Key} |
Parameter
| Parameter | Description | Required | Comment | |
| 1 | WoNo | Work order number | Y | The work order number is the only required parameter to update a kit. |
Example Strings
Kit Update
URL
?wono=WONO |
JSON
{ "WoNo":"WONO" } |
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 exist.", "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 an 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." } |