1. PO Schedule API
1.1. PO Schedule Add

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

}

1.2. PO Schedule Edit

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

}

1.3. PO Schedule Delete

Functions

Schedule Edit API is used to delete scheduling information in Purchase Orders.

URL-{Root URL}/API/PO/ScheduleDelete/{API Key}

Parameters


Parameter Description Required Comment
poNum  Purchase Order Number Y
uniqDetNo PO Schedule Identifier Y  

Example Strings

Edit Schedule Qty

URL-?poNum=PONUMBER&uniqDetNo=UNIQDETNO

JSON

{

'poNum':'PONUMBER',

'uniqLnNo':'UNIQLNNO',

}

A successful add should result in

{

$id: "1",

Code: 200,

Message: "PO Schedule deleted 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/PO/ScheduleDelet/123456789'.",

"MessageDetail": "No action was found on the controller 'Po' that matches the name 'ScheduleDelet'."

}

Schedule Delete 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 delete failed.An error occurred while executing the command definition. See the inner exception for details.",

"SessionId": null,

"IsValidUser": true,

"ResponseObject": null

}

1.4. PO Schedule Get

Functions

PO Schedule Get API is used to view scheduling information for items on the Purchase Orders.

URL-{Root URL}/API/PO/ScheduleGet/{API Key}

Parameters

 Parameter Description Required Comment
poNum Purchase Order Number Y  
uniqLnNo Unique PO Item Identifier Number Y  

Example Strings

Get Schedule

URL-

?poNum=PONUMBER

JSON

{

'poNum':'PONUMBER'

}

Successful results should result in.

{

$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 a 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 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 details failed:",

"SessionId": null,

"IsValidUser": true,

"ResponseObject": null

}