| 1.1. Add |
The Item Master InvtmfSp add API is used to add Supplier information to parts in the database.
URL-{Root URL}/api/ItemMaster/InvtmfSpAdd/{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 supplier information to. |
| uniqmfgrhd |
Unique Manufacturer Information Key |
Y |
The uniqmfgrhd is also used to choose the part you would like to add |
| UniqWh |
Warehouse Identifier
|
Y |
Used to pick the default warehouse for the item. |
| uniqsupno |
Unique Supplier Number
|
Y |
This is used to identify the supplier. |
| suplpartno |
Supplier Part Number
|
Y |
Set the supplier part number for the item. |
Example Strings
Example invtmfSp Add String-
URL-?uniq_key=_4750SWEOD&uniqmfgrhd=SWIWRWPI63&UniqWh=_0DM120YNM&uniqsupno=_44L0SDHY2&suplpartno=1131
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": "Invtmfsp added successfully.",
"SessionId": null,
"IsValidUser": true,
"ResponseObject": "2JT3HLSFLQ"
}
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/InvtmfSpAd/123456789'.",
"MessageDetail": "No action was found on the controller 'ItemMaster' that matches the name 'InvtmfSpAd'."
}
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": "Invtmfsp add failed.Uniqmfsp with uniqmfgrhd 'SWIWRWPI63', supplier part number '1131' and uniqSupNum '_44L0SDHY2' already exists.",
"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 InvtmfSp Edit API is used to add Supplier information to parts in the database.
URL-{Root URL}/api/ItemMaster/InvtmfSpEdit/{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 manufacturer information to. |
| Uniqmfsp |
|
Y |
|
| uniqmfgrhd |
Unique Manufacturer Information Key |
N |
|
| UniqWh |
|
N |
|
| uniqsupno |
Unique Supplier Number
|
N |
|
| suplpartno |
Supplier Part Number
|
N |
|
Example Strings
Example invtmfSp Edit String-
URL-?uniq_key=_4750SWEOD&uniqmfgrhd=SWIWRWPI63&UniqWh=_0DM120YNM&uniqsupno=_44L0SDHY2&suplpartno=1131
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": "Invtmfsp edited successfully.",
"SessionId": null,
"IsValidUser": true,
"ResponseObject": "2JT3HLSFLQ"
}
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/InvtmfSpAd/123456789'.",
"MessageDetail": "No action was found on the controller 'ItemMaster' that matches the name InvtmfSpAd'."
}
Missing Parameter
If a required parameter is missing the system will return an error message asking for the parameter.
{
"$id": "1",
"Code": 403,
"Message":"Invtmfsp edit failed.Uniqmfsp 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 InvtmfSp Get API is used to view supplier information for parts in the database.
URL-{Root URL}/api/ItemMaster/InvtmfSpGet?apiKey={API KEY}&uniqmfsp={UNIQMFSP}
Parameters
| Parameter |
Description |
Required |
Comment |
| uniqmfsp |
|
Y |
The uniqmfsp is used to select the part you would like to view information for. |
Example Strings
Example invtmfSp Get String-
URL-?uniqmfsp=UNIQMFSP
JSON-
{
'uniqmfsp':'UNIQMFSP',
}
A successful add should result in:
{
"$id": "1",
"Code": 200,
"Message": "Invtmfsp details:",
"SessionId": null,
"IsValidUser": true,
"ResponseObject": {
"$id": "2",
"Uniqmfsp": "2JT3HLSFLQ",
"Uniqmfgrhd": "SWIWRWPI63",
"Uniqsupno": "_44L0SDHY2",
"Suplpartno": "1131 ",
"Uniq_Key": "_4750SWEOD",
"Pfdsupl": false,
"Is_Deleted": 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/InvtmfSpGe/123456789'.",
"MessageDetail": "No action was found on the controller 'ItemMaster' that matches the name 'InvtmfSpGe'."
}
Incorrect Parameter
If an incorrect parameter value is used the system will return an error describing the incorrect parameter.
{
"$id": "1",
"Code": 403,
"Message": "Uniqmfsp not provided.",
"SessionId": null,
"IsValidUser": true,
"ResponseObject": null
}
|
| 1.4. Delete |
The Item Master InvtmfSp Delete API is used to remove supplier information from parts in the database.
URL-{Root URL}/api/ItemMaster/InvtmfSpDelete/{API KEY}
Parameters
| Parameter |
Description |
Required |
Comment |
| uniqmfsp |
|
Y |
The uniqmfsp is used to select the part you would like to view information for. |
Example Strings
Example invtmfSp Delete String-
URL-?uniqmfsp=UNIQMFSP
JSON-
{
'uniqmfsp':'UNIQMFSP',
}
A successful delete should result in:
{
"$id": "1",
"Code": 200,
"Message": "Invtmfsp 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/InvtmfSpDelet/123456789'.",
"MessageDetail": "No action was found on the controller 'ItemMaster' that matches the name 'InvtmfSpDelet'."
}
Incorrect Parameter
If an incorrect parameter value is used the system will return an error describing the incorrect parameter.
{
"$id": "1",
"Code": 403,
"Message": "Uniqmfsp not provided.",
"SessionId": null,
"IsValidUser": true,
"ResponseObject": null
}
|
|