Functions
Schedule add API is used to add scheduling information to existing Purchase Orders.
URL-{Root URL}/API/PO/ScheduleAdd/{API Key}
Parameters
| Parameter |
Description |
Required |
Comment |
| poNum |
Purchase Order Number |
Y |
|
| uniqLnNo |
PO Unique item identifier |
Y |
|
| schd_date |
Schedule Date |
N |
Will default to current date or enter in MM-DD-YYYY format. |
| req_date |
Required Date |
N |
Will default to current date or enter in MM-DD-YYYY format. |
| schd_qty |
Scheduled Quantity |
Y |
Must be equal to or less than order quantity. |
| warehouse |
Warehouse |
N |
Warehouse where the item will be received into |
| location |
Warehouse Location |
N |
Used with warehouse to designate a location. |
| origcommitdt |
Commit Date |
N |
Will default to current date or enter in MM-DD-YYYY Format. |
| schdNotes |
Schedule Notes |
N |
Can be used to attach a schedule note to the PO. |
Example Strings
Add Schedule Information
URL-?poNum=PONUMBER&uniqLnNo=UNIQLNNO&SCHD_DATE=MM-DD-YYYY&REQ_DATE=MM-DD-YYYY&SCHD_QTY=QTY&Warehouse=WAREHOUSE&LOCATION=LOCATION&ORIGCOMMITDT=MM-DD-YYYY&SCHDNOTES=NOTE
JSON
{
'poNum':'PONUMBER',
'uniqLnNo':'UNIQLNNO',
'SCHD_DATE':'MMM-DD-YYYY',
'REQ_DATE':'MMM-DD-YYYY',
'SCHD_QTY':'QTY',
'Warehouse':'WAREHOUSE',
'LOCATION':'LOCATION',
'ORIGCOMMITDT':'MMM-DD-YYYY',
'SCHDNOTES':'NOTE'
}
A successful add should result in
{
$id: "1",
Code: 200,
Message: "PO Schedule added successfully.",
SessionId: null,
IsValidUser: true,
-ResponseObject: {
$id: "2",
UNIQDETNO: "O2YHUQB45I",
UNIQLNNO: "_47A0PHH67",
SCHD_DATE: "2014-11-07T00:00:00",
REQ_DATE: "2014-11-07T00:00:00",
SCHD_QTY: 5,
RECDQTY: 0,
BALANCE: 5,
GL_NBR: "",
REQUESTTP: "Invt Recv",
REQUESTOR: "",
UNIQWH: "",
LOCATION: "",
WOPRJNUMBER: "",
COMPLETEDT: null,
PONUM: "1751",
ORIGCOMMITDT: "2014-11-04T00:00:00",
SCHDNOTES: "test",
UNIQMFGRHD: "_44Y0X2L9H",
UNIQ_KEY: "_44Y0WP6H4",
WAREHOUSE: "MAIN1",
ORD_QTY: 0,
RECV_QTY: 0,
POITTYPE: "Invt Part",
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 a HTTP not found error.
{
"$id": "1",
"Message": "No HTTP resource was found that matches the request URI 'http://localhost/api/POScheduleAdd/123456789'.",
"MessageDetail": "No type was found that matches the controller named 'POScheduleAdd'."
}
Schedule Add Failed
If the used parameter 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 add failed.An error occurred while executing the command definition. See the inner exception for details.",
"SessionId": null,
"IsValidUser": true,
"ResponseObject": null
}
|
