Functions
PO Delete Item API is used to remove existing items from Purchase Orders.
URL-{Root URL}/API/PO/ItemDelete/{API Key}
Parameters
| Parameter |
Description |
Required |
Comment |
| PoNum |
Purchase Order Number |
Y |
|
| itemNumber |
Item Number |
N |
Used to choose which item to delete from the PO |
| part_no |
Part Number |
N |
Used to choose which item to delete from the PO |
| revision |
Part Revision |
N |
Used with Part_no to choose an item. |
| uniq_key |
Part Unique Identifier |
N |
Can be used instead of part_no and revision |
| partMfgr |
Part Manufacturer |
N |
Can be used to choose item to delete from PO by part manufacturer |
| mfgr_pt_no |
Manufacturer Part Number |
N |
Used with partMfgr. |
| uniqmfgrhd |
Unique manufacturer part identifier |
N |
Can be used in place of mfgr_pt_no and uniqmfgrhd |
| uniqlnno |
Unique PO item Identifier |
N |
Can be used in place of part_no or partMfgr |
Example Strings
Delete Item
URL-?PoNum=PONUMBER&UNIQLNNO=UNIQLNNO
JSON
{
'poNum':'PONUMBER'
'UNIQLNNO':'UNIQLNNO'
}
A successful request should return
{
$id: "1",
Code: 200,
Message: "PO Items deleted successfully.",
SessionId: null,
IsValidUser: true,
ResponseObject: null
}
Common Errors
Incorrect Parameter
If a parameter is incorrect the system will return an error message describing the error
{
"$id": "1",
"Code": 403,
"Message": "PO Items delete failed.Po Item does not exists.",
"SessionId": null,
"IsValidUser": true,
"ResponseObject": null
}
URL Error
If there is an error with the URL the system will return the following error message
{
"$id": "1",
"Message": "No HTTP resource was found that matches the request URI 'http://localhost/api/PO/ItemDelet/123456789'.",
"MessageDetail": "No action was found on the controller 'Po' that matches the name 'ItemDelet'."
}
|