Function
The Item Master InvtmfHd Edit API is used to add manufacturer information to parts in the database.
URL
{Root URL}/api/ItemMaster/InvtmfHdEdit/{API KEY} |
Parameters
Parameter | Description | Required | Comment | |
1 | uniq_key | Part unique key | Y | The uniq_key is used to select the part a user would like to edit manufacturer information for. |
2 | uniqmfgrhd | Unique part manufacturer key | Y | A unique field that is used to identify the part manufacturer information. |
3 | partmfgr | Part manufacturer | N | Can be used to change the manufacturer, and must be a manufacturer in the system. |
4 | mfgr_pt_no | Manufacturer part number | N | Can be used to change the manufacturer's part number. |
5 | matltype | Material type | N | Must exist within the system. |
6 | matltypevalue | Material type value | N | Identifier value for the material type, and must exist within the system. |
7 | orderpref | N | ||
8 | sftystk | N | ||
9 | ldisallowbuy | N | Can be "true" or "false." | |
10 | ldisallowkit | N | Can be "true" or "False." |
Example Strings
Example invtmfHd edit String:
URL
?Uniq_key=_4750SWEOD&uniqmfgrhd=UNIQMFGRHD&MFGR_PT_NO=NEWMFGRPARTNUMBER |
JSON
{ "Uniq_key':"_4750SWEOD", "uniqmfgrhd':"UNIQMFGRHD", "MFGR_PT_NO":"vit-2" } |
A successful edit should result in:
{ "$id": "1", "Code": "200", "Message": "Invtmfgrhd edited successfully.", "SessionId": "null", "IsValidUser": "true", "ResponseObject": "SWIWRWPI63" } |
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/ItemMaster/InvtmfHdEdi/123456789'.", "MessageDetail": "No action was found on the controller 'ItemMaster' that matches the name 'InvtmfHdEdi'." } |
Missing Parameter
If a required parameter is missing, the system will return an error message asking for the parameter:
{ "$id": "1", "Code": "403", "Message":"Invtmfgrhd edit failed.Uniqmfhd required.", "SessionId": "null", "IsValidUser": "true", "ResponseObject": "null" } |
Incorrect Parameter
If an incorrect parameter value is used, 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" } |