The Item Master InvtmfHd Get API is used to view Manufacturer information of parts in the database.
URL-{Root URL}/api/ItemMaster/InvtmfhdGet?apiKey={API KEY}&uniqmfgrHd={UNIQMFGRHD}
Parameters
| Parameter |
Description |
Required |
Comment |
| uniqmfgrhd |
|
Y |
The uniqmfgrhd is used to select the part you would like to view manufacturer information for. |
Example Strings
Example invtmfHd Get String-
URL-?uniqmfgrhd=_4750SWEOD
JSON-
{
'uniqmfgrhd':'_4750SWEOD',
}
A successful add should result in:
{
"$id": "1",
"Code": 200,
"Message": "Invtmfgrhd details:",
"SessionId": null,
"IsValidUser": true,
"ResponseObject": {
"$id": "2",
"InvtmfGrList": [ ],
"InvtmfspList": [ ],
"InvtserList": [ ],
"UNIQMFGRHD": "SWIWRWPI63",
"UNIQ_KEY": "_4750SWEOD",
"PARTMFGR": "3G ",
"MFGR_PT_NO": "vit-2 ",
"MARKING": " ",
"BODY": " ",
"PITCH": " ",
"PART_SPEC": " ",
"UNIQPKG": " ",
"IS_DELETED": false,
"MATLTYPE": "Unk ",
"AUTOLOCATION": false,
"ORDERPREF": 99,
"MATLTYPEVALUE": " ",
"LDISALLOWBUY": false,
"LDISALLOWKIT": false,
"SFTYSTK": 0,
"InstoreInstalled": false,
"IsInvtMfhdExist": false
}
}
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/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
}
|
