Function
The Purchase Order (PO) Schedule Get API is used for viewing scheduling information for items on POs.
URL
{Root URL}/API/PO/ScheduleGet/{API Key} |
Parameters
| Parameter | Description | Required | Comment | |
| 1 | poNum | Purchase order number | Y | |
| 2 | uniqLnNo | Unique PO item identifier number | Y |
Example Strings
PO Schedule Get
URL
?poNum=PONUMBER |
JSON
{ "poNum":"PONUMBER" } |
A successful get should result in the following:
{ "$id": "1", "Code": "200", "Message": "PO Schedule details:", "SessionId": "null", "IsValidUser": "true", "ResponseObject": [ { "$id": "2", "UNIQDETNO": "_44Z0M6ZZW", "UNIQLNNO": "_44Z0M4ZD2", "SCHD_DATE": "2014-09-03T00:00:00", "REQ_DATE": "2014-09-03T00:00:00", "SCHD_QTY": "1", "RECDQTY": "100", "BALANCE": "-99", "GL_NBR": "1315000-00-00", "REQUESTTP": "Invt Recv ", "REQUESTOR": " ", "UNIQWH": "_0DM120YNM", "LOCATION": "s4r1 ", "WOPRJNUMBER": " ", "COMPLETEDT": "null", "PONUM": "000000000001724", "ORIGCOMMITDT": "2014-09-03T00:00:00", "SCHDNOTES": "", "UNIQMFGRHD": "null", "UNIQ_KEY": "null", "WAREHOUSE": "null", "ORD_QTY": "0", "RECV_QTY": "0", "POITTYPE": "null", "ITEMNO": "null", "PART_NO": "null", "REVISION": "null", "PARTMFGR": "null", "MFGR_PT_NO": "null" } ] } |
Common Errors
API Key Error
If there is an error with the API key, the system will return an error message describing it:
{ "$id": "1", "Code": "403", "Message": "Invalid API Key.", "SessionId": "null", "IsValidUser": "false", "ResponseObject": "null" } |
URL Error
If there is an error with the URL, the system will return an "HTTP not found" error:
{ "$id": "1", "Message": "No HTTP resource was found that matches the request URI 'http://localhost/api/POScheduleGet/123456789?poNum=410'.", "MessageDetail": "No type was found that matches the controller named 'POScheduleGet'." } |
Detail Get Failed
If the parameter being used is invalid or the record being retrieved no longer exists, the system will return a "Schedule Details Failed" message:
{ "$id": "1", "Code": "403", "Message": "PO Schedule details failed:", "SessionId": "null", "IsValidUser": "true", "ResponseObject": "null" } |