Function
The Item Master Edit API is used to modify item details in the database.
URL
{Root URL}/api/ItemMaster/Edit/{API KEY} |
Parameters
| Parameter | Description | Required | Comment | |
| 1 | part_class | Part class | N | Used to designate the new part's class. Must be a valid part class. |
| 2 | part_type | Part type | N | Used to designate the new part's type. Must be a valid part type. |
| 3 | part_sourc | Part source | N | Used to designate the new part's source. Must be a valid part source. |
| 4 | U_of_Meas | Unit of measurement | N | The part's unit of measurement. Must be a valid unit of measurement in the system. |
| 5 | Pur_UOfM | Purchasing unit of measurement | N | The part's purchasing unit of measurement. Must be a valid unit of measurement. |
| 6 | CustNo | Customer identifier number | N | The customer number is used to select the customer for the part. |
| 7 | CustPartNo | Customer part number | N | Used to set the Customer's part number. |
| 8 | CustRev | Customer revision | N | Used to set the revision level on the customer part. |
| 9 | part_No | Part number | N | Used to set the part number. |
| 10 | status | Part status | N | Used to set the part's status, and can be "active" or "inactive." |
| 11 | serialYes | Is the part serialized "Yes" or "No" | N | Use the values "true" or "false" |
| 12 | descript | Description | N | |
| 13 | uniq_key | Item unique identifier key | Y | Used to select the item being edited. |
| 14 | abc | Item abc code | Y | Can be A, M, or D |
Example Strings
Edit part description:
URL
?uniq_key=UNIQUEKEY&Description=EditedDescription&status=active&abc=D |
{ “uniq_key”:”UNIQUEKEY”, “Description”:”EditedDescription”, “status”:”active”, “abc”:”D” } |
A successful Edit request will return:
{ "$id": "1", "Code": "200", "Message": "Inventor edited successfully.", "SessionId": "null", "IsValidUser": "true", "ResponseObject": "null" } |
Common Errors
API Key Error
If there is an error with the entered API key, the system will return an error describing it:
{ "$id": "1", "Code": "403", "Message": "Invalid API Key.", "SessionId": "null", "IsValidUser": "false", "ResponseObject": "null" } |
URL Error
If there is an error within 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/InventoryHandling/Receiv/123456789'.", "MessageDetail": "No action was found on the controller 'InventoryHandling' that matches the name 'Receiv'." } |
Missing Required Parameter
If a required parameter is missing, the system will return an error describing the incorrect parameter:
{ "$id": "1", "Code": "403", "Message": "Inventor edit failed.Unique_key required.", "SessionId": "null", "IsValidUser": "true", "ResponseObject": "null" } |