Function
The Item Master InvtmfHd Add API is used to add manufacturer information to parts in the database.
URL
{Root URL}/api/ItemMaster/InvtmfHdAdd/{API KEY} |
Parameters
| Parameter | Description | Required | Comment | |
| 1 | uniq_key | Part unique key | Y | The uniq_key is used to select the part the user would like to add the manufacturer information to. |
| 2 | partmfgr | Part manufacturer | Y | Sets up the part's manufacturer. Must be a manufacturer in your system. |
| 3 | mfgr_pt_no | Manufacturer part number | Y | Adds the manufacturer's part number to the part. |
| 4 | matltype | Material type | Y | Must be a valid material type in the system. |
| 5 | matltypevalue | Material type value | Y | |
| 6 | orderpref | N | ||
| 7 | sftystk | N | ||
| 8 | ldisallowbuy | N | Can be "true" or "false." | |
| 9 | ldisallowkit | N | Can be "true" or "false." |
Example Strings
Example invtmfHd Add String
URL
| ?Uniq_key=_4750SWEOD&PARTMFGR=3G&MFGR_PT_NO=vit-2&MATLTYPE=Unk&MATLTYPEVALUE=&ORDERPREF=1&SFTYSTK=10&LDISALLOWBUY=false&LDISALLOWKIT=false |
JSON
{ “Uniq_key”:”_4750SWEOD”, “PARTMFGR”:”3G”, “MFGR_PT_NO”:”vit-2”, “MATLTYPE”:”Unk”, “MATLTYPEVALUE”:”“, “ORDERPREF”:”1”, “SFTYSTK”:”10”, “LDISALLOWBUY”:”false”, “LDISALLOWKIT”:”false” } |
A successful add should result in:
{ "$id": "1", "Code": "200", "Message": "Invtmfgrhd added 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/InvtmfHdAd/123456789'.", "MessageDetail": "No action was found on the controller 'ItemMaster' that matches the name 'Ad'." } |
Part Already in System
If the part number being added is already being used, the system will return an error message describing it:
{ "$id": "1", "Code": "403", "Message": "Invtmfgrhd add failed.Combination of Uniq_Key '_4750SWEOD, PartMfgr '3G' and Mfgr_Part_No 'vit-2' is already exist.", "SessionId": "null", "IsValidUser": "true", "ResponseObject": "null" } |
Missing Parameter
If a required parameter is missing, the system will return an error message asking for the parameter:
{ "$id": "1", "Code": "403", "Message":"Inventor add failed.Please provide description for Inventor.", "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" } |