1.1. Add |
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 |
uniq_key |
Part Unique Key |
Y |
The uniq_key is used to select the part you would like to add maufacturer information to. |
partmfgr |
Part Manufacturer |
Y |
Sets the Part's manufacturer. Must be a manufacturer in your system. |
mfgr_pt_no |
Manufacturer Part Number |
Y |
Adds the manufacturer's part number to the part. |
matltype |
Material Type |
Y |
Must be a valid material type in the system. |
matltypevalue |
Material Type Value |
Y |
|
orderpref |
|
N |
|
sftystk |
|
N |
|
ldisallowbuy |
|
N |
Can be "true" or "false". |
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 a 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
}
|
1.2. Edit |
The Item Master InvtmfHd add 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 |
uniq_key |
Part Unique Key |
Y |
The uniq_key is used to select the part you would like to edit maufacturer information for. |
uniqmfgrhd |
Unique Part Manufacturer Key |
Y |
Unique field used to identify the part manufacturer information. |
partmfgr |
Part Manufacturer |
N |
Can be used to change the manufacturer, must be a manufacturer in the system. |
mfgr_pt_no |
Manufacturer Part Number |
N |
Can be used t change the manufacturer's part number. |
matltype |
Material Type |
N |
Must exist within the system. |
matltypevalue |
Material Type Value |
N |
Identifier value for the material type, must exist within the system. |
orderpref |
|
N |
|
sftystk |
|
N |
|
ldisallowbuy |
|
N |
Can be "true" or "false". |
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 add 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 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
}
|
1.3. Get |
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
}
|
1.4. Delete |
The Item Master InvtmfHd Delete API is used to remove Manufacturer information from parts in the database.
URL-{Root URL}/api/ItemMaster/InvtmfHdDelete/{API KEY}
Parameters
Parameter |
Description |
Required |
Comment |
uniqmfgrhd |
|
Y |
The uniqmfgrhd is used to select the part you would like to delete manufacturer information from. |
Example Strings
Example invtmfHd Delete String-
URL-?uniqmfgrhd=_4750SWEOD
JSON-
{
'uniqmfgrhd':'_4750SWEOD',
}
A successful add should result in:
{
"$id": "1",
"Code": 200,
"Message": "Invtmfgrhd deleted 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/ItemMaster/InvtmfHdDelet/123456789'.",
"MessageDetail": "No action was found on the controller 'ItemMaster' that matches the name 'InvtmfHdDelet'."
}
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
}
|
|