Functions
Schedule Edit API is used to edit scheduling information in Purchase Orders.
URL-{Root URL}/API/PO/ScheduleEdit/{API Key}
Parameters
| Parameter |
Description |
Required |
Comment |
| poNum |
Purchase Order Number |
Y |
|
| uniqDetNo |
PO Schedule 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
Edit Schedule Qty
URL-?poNum=PONUMBER&uniqDetNo=UNIQDETNO&SCHD_QTY=QTY
JSON
{
'poNum':'PONUMBER',
'uniqLnNo':'UNIQLNNO',
'SCHD_QTY':'QTY',
}
A successful add should result in
{
$id: "1",
Code: 200,
Message: "PO Schedule edited successfully.",
SessionId: null,
IsValidUser: true,
ResponseObject: 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'."
}
Missing Parameter
If there is a missing required parameter the system will return an error detailing which parameter is required.
{
"$id": "1",
"Code": 403,
"Message": "PO Schedule edit failed.UNIQDETNO is required.",
"SessionId": null,
"IsValidUser": true,
"ResponseObject": null
}
|