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 |
| part_class |
Part Class |
N |
Used to designate the new part's class. Must be a valid part class. |
| part_type |
Part Type |
N |
Used to designate the new part's type. Must be a valid part type. |
| part_sourc |
Part Source |
N |
Used to designate the new part's source. Must be a valid part source. |
| U_of_Meas |
Unit of Measurement |
N |
The part's unit of measurement. Must be a valid unit of measurement in the system.
|
| Pur_UOfM |
Purchasing Unit of Measurement |
N |
The part's purchasing unit of measurement. Must be a valid unit of measurement. |
| CustNo |
Customer Identifier Number |
N |
The customer number is used to select the customer for the part. |
| CustPartNo |
Customer Part Number |
N |
Used to set the Customer's part number. |
| CustRev |
Customer Revision |
N |
Used to set the revision level on the customer part. |
| part_No |
Part Number |
N |
Used to set the part number. |
| status |
Part Status |
N |
Used to set the part's status, can be "active" or "inactive". |
| serialYes |
Is the Part Serialized Yes or No |
N |
Use the values true or false |
| descript |
Description |
N |
|
| uniq_key |
Item Unique Identifier Key |
Y |
Used to select the item which item is being edited. |
| 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 a 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
}
|