| 1.1. WO Add |
Functions
WO Add API is used to add a new Work Order.
URL-{Root URL}/API/WO/Add/{API Key}
Parameters
| Parameter |
Description |
Required |
Comment |
| WoNo |
Work Order Number |
N |
|
| Uniq_Key |
Item Unique Identifier |
Y |
Used to Choose the item to be built in the Work Order |
| openclos |
Work Order Status |
Y |
Can be STANDARD, PRIORITY-1, PRIORITY-2, FIRM PLAN, ADMIN HOLD, MFG HOLD, REWORK, REWORK FIRM, CANCEL |
| Due_Date |
Work Order Due Date |
Y |
Use MM-DD-YYYY format |
| custNo |
Customer Number |
Y |
Must be an existing customer |
| bldQty |
Build Quantity |
N |
Amount to be built in the Work Order |
Example Strings
Add Work Order
Url-?uniq_key=UNIQKEY&openclos=STANDARD&Due_Date=MM-DD-YYYY&custno=CUSTOMERNUMBER&bldqty=QTY'
JSON
{
'uniq_key':'UNIQKEY',
'openclos':'STANDARD',
'Due_Date':MM-DD-YYYY',
'custno':'CUSTOMERNUMBER',
'bldqty':'QTY'
}
A successful request should result in
{
$id: "1",
Code: 200,
Message: "WorkOrder added successfully.",
SessionId: null,
IsValidUser: true,
-ResponseObject: {
$id: "2",
WONO: "0000000410",
UNIQ_KEY: "FW7064W8L8",
OPENCLOS: "STANDARD",
ORDERDATE: "2014-11-04T14:55:50.9647637-05:00",
DUE_DATE: "2014-11-07T00:00:00",
AUDPLACE: "",
BLDQTY: 100,
COMPLETE: 0,
BALANCE: 100,
WONOTE: "",
IS_CLOSED: false,
DATECHG: null,
PLANTNO: "",
AUDBY: "",
AUDDATE: null,
MATL_CK: "",
ENGR_CK: "",
QLTY_CK: "",
SALE_CK: "",
KIT_NOTE: "",
MRP_DONE: false,
ORD_TYPE: "",
MAT_REQ_DT: null,
MAT_REQ_Q: 0,
MAT_REQ_D: "",
PROD_TIME: 0,
TTSETPTIME: 0,
ISSUED: false,
ENG_APPR: false,
ENG_APPD: null,
ENG_APPT: "",
ENG_APPI: "",
SHFLNOTE: "",
ORIG_DUEDT: null,
BUILDABLE: 0,
SCHED_FB: 0,
IS_ALLOC: false,
KITSTATUS: "",
KITCLOSEDT: null,
START_DATE: null,
CUSTNO: "0000000008",
SONO: "",
KIT: false,
SHTGNOTE: "",
RELEDATE: null,
SERIALYES: false,
UNIQUELN: "",
GLDIVNO: "",
CMPRICELNK: "",
EACHQTY: 0,
FSTDUEDT: null,
DELIFREQ: "",
PRJUNIQUE: "",
ARCSTAT: "",
SQCSTATUS: "",
KITLSTCHDT: null,
KITLSTCHINIT: null,
MRPONHOLD: false,
COMPLETEDT: null,
KITSTARTINIT: null,
KITCLOSEINIT: null,
KITCOMPLETE: false,
KITCOMPLDT: null,
KITCOMPLINIT: null,
LFCSTITEM: true,
LIS_RWK: false,
UNIQUEREC: null,
UNIQUERECID: null
}
}
Common Errors
API Key Error
If there is a problem with the entered API Key the system will return an API Key error message
{
"$id": "1",
"Code": 403,
"Message": "Invalid API Key.",
"SessionId": null,
"IsValidUser": false,
"ResponseObject": null
}
URL Error
If there is an error with the used URL the system will return a HTTP error.
{
"$id": "1",
"Message": "No HTTP resource was found that matches the request URI 'http://localhost/api/WOAdd/123456789'.",
"MessageDetail": "No type was found that matches the controller named 'WOAdd'."
}
JSON Error
If there is an error with the JSON string the system will return an "Object Reference" error.
{
"$id": "1",
"Code": 403,
"Message": "WorkOrder add failed.Object reference not set to an instance of an object.",
"SessionId": null,
"IsValidUser": true,
"ResponseObject": null
}
Missing required parameter
If a required parameter value is missing the system will return an error message describing the missing parameter.
{
"$id": "1",
"Code": 403,
"Message": "WorkOrder add failed.Work Order Uniq_Key is required",
"SessionId": null,
"IsValidUser": true,
"ResponseObject": null
}
|
| 1.2. WO Edit |
Functions
WO Edit API is used to edit the details of an existing Work Order.
URL-{Root URL}/API/WO/Edit/{API Key}
Parameters
| Parameter |
Description |
Required |
Comment |
| WoNo |
Work Order Number |
Y |
|
| Uniq_Key |
Item Unique Identifier |
Y |
Used to Choose the item to be built in the Work Order |
| openclos |
Work Order Status |
Y |
Can be STANDARD, PRIORITY-1, PRIORITY-2, FIRM PLAN, ADMIN HOLD, MFG HOLD, REWORK, REWORK FIRM, CANCEL |
| Due_Date |
Work Order Due Date |
N |
Use MM-DD-YYYY format |
| custNo |
Customer Number |
Y |
Must be an existing customer |
| bldQty |
Build Quantity |
N |
Amount to be built in the Work Order |
Example Strings
Edit Work Order Quantity
Url-?WoNo=WONO&uniq_key=UNIQKEY&openclos=STANDARD&custno=CUSTOMERNUMBER&bldqty=QTY'
JSON
{
'WoNo':'WONO',
'uniq_key':'UNIQKEY',
'openclos':'STANDARD',
'custno':'CUSTOMERNUMBER',
'bldqty':'QTY'
{
A successful edit should result in
{
$id: "1",
Code: 200,
Message: "WorkOrder edited successfully.",
SessionId: null,
IsValidUser: true,
ResponseObject: null
}
Common Errors
API Key Error
If there is a problem with the entered API key the system will return an error 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 used URL the system will return a HTTP error message.
{
"$id": "1",
"Message": "No HTTP resource was found that matches the request URI 'http://localhost/api/WOEdit/123456789'.",
"MessageDetail": "No type was found that matches the controller named 'WOEdit'."
}
JSON Error
If there is a problem with the setup of the JSON string the system will return a "non-static method" message.
{
"$id": "1",
"Code": 403,
"Message": "WorkOrder edit failed.Non-static method requires a target.",
"SessionId": null,
"IsValidUser": true,
"ResponseObject": null
}
Missing Required Parameter
If a required parameter is missing the system will return an error message showing the missing parameter.
{
"$id": "1",
"Code": 403,
"Message": "WorkOrder edit failed.Please Provide Work Order Number.",
"SessionId": null,
"IsValidUser": true,
"ResponseObject": null
}
|
| 1.3. WO Get |
Functions
WO Get API is used to find and view information for existing Work Orders
URL-{Root URL}/API/WO/Get/{API Key}
Parameters
| Parameter |
Description |
Required |
Comment |
| WoNo |
Work Order Number |
N |
|
| Uniq_Key |
Item Unique Identifier |
Y |
Used to Choose the item to be built in the Work Order |
| openclos |
Work Order Status |
Y |
Can be STANDARD, PRIORITY-1, PRIORITY-2, FIRM PLAN, ADMIN HOLD, MFG HOLD, REWORK, REWORK FIRM, CANCEL |
| Due_Date |
Work Order Due Date |
Y |
Use MM-DD-YYYY format |
| custNo |
Customer Number |
Y |
Must be an existing customer |
| bldQty |
Build Quantity |
N |
Amount to be built in the Work Order |
Example Strings
Work Order Get
URL?WoNo=WONO
JSON
A successful request should result in
{
"$id": "1",
"Code": 200,
"Message": "WorkOrder details:",
"SessionId": null,
"IsValidUser": true,
"ResponseObject": [
{
"$id": "2",
"WONO": "0000000410",
"UNIQ_KEY": "FW7064W8L8",
"OPENCLOS": "STANDARD ",
"ORDERDATE": "2014-11-04T14:56:00",
"DUE_DATE": "2014-11-07T00:00:00",
"AUDPLACE": " ",
"BLDQTY": 210,
"COMPLETE": 0,
"BALANCE": 210,
"WONOTE": "",
"IS_CLOSED": false,
"DATECHG": null,
"PLANTNO": " ",
"AUDBY": " ",
"AUDDATE": null,
"MATL_CK": " ",
"ENGR_CK": " ",
"QLTY_CK": " ",
"SALE_CK": " ",
"KIT_NOTE": "",
"MRP_DONE": false,
"ORD_TYPE": " ",
"MAT_REQ_DT": null,
"MAT_REQ_Q": 0,
"MAT_REQ_D": " ",
"PROD_TIME": 0,
"TTSETPTIME": 0,
"ISSUED": false,
"ENG_APPR": false,
"ENG_APPD": null,
"ENG_APPT": " ",
"ENG_APPI": " ",
"SHFLNOTE": "",
"ORIG_DUEDT": null,
"BUILDABLE": 0,
"SCHED_FB": 0,
"IS_ALLOC": false,
"KITSTATUS": "KIT PROCSS",
"KITCLOSEDT": null,
"START_DATE": "2014-11-06T14:33:00",
"CUSTNO": "0000000008",
"SONO": " ",
"KIT": false,
"SHTGNOTE": "",
"RELEDATE": null,
"SERIALYES": false,
"UNIQUELN": " ",
"GLDIVNO": " ",
"CMPRICELNK": " ",
"EACHQTY": 0,
"FSTDUEDT": null,
"DELIFREQ": " ",
"PRJUNIQUE": " ",
"ARCSTAT": " ",
"SQCSTATUS": " ",
"KITLSTCHDT": "2014-11-06T14:33:00",
"KITLSTCHINIT": "T1000 ",
"MRPONHOLD": false,
"COMPLETEDT": null,
"KITSTARTINIT": "T1000 ",
"KITCLOSEINIT": null,
"KITCOMPLETE": false,
"KITCOMPLDT": null,
"KITCOMPLINIT": null,
"LFCSTITEM": true,
"LIS_RWK": false,
"UNIQUEREC": null,
"UNIQUERECID": null
}
]
}
Common Errors
API Key Error
If there is a problem with the entered 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 error message.
{
"$id": "1",
"Message": "No HTTP resource was found that matches the request URI 'http://localhost/api/WOGet/123456789'.",
"MessageDetail": "No type was found that matches the controller named 'WOGet'."
}
Not Enough Information
If not enough information is provided to get a Work Order the system will return a "Not Enough Information" error message.
{
"$id": "1",
"Code": 403,
"Message": "Not enough information to return the data, please provide valid parameters.",
"SessionId": null,
"IsValidUser": true,
"ResponseObject": null
}
Work Order Doesn't Exist
If the Work Order entered does not exist the system will return an error message saying that the work order doesn't exist.
{
"$id": "1",
"Code": 403,
"Message": "WorkOrder does not exists.",
"SessionId": null,
"IsValidUser": true,
"ResponseObject": null
}
|
|