1. WO Schedule
1.1. WO Schedule Add

Functions

Work Order Schedule Add API is used to add scheduling information to an existing Work Order

URL-{Root URL}/API/WOSchedule/Add/{API Key}

Parameters

Parameters  Description Required Comment
WoNo  Work Order Number Y  
autoSchedule Auto Schedule  Y Can be 'true' or 'false'
qty  Scheduled Quantity N Not required if autoSchedule is 'true'
due_dts  Due Date N Not required if autoSchedule is 'true'. If used enter in MM-DD-YYYY format.
duedt_uniq Due Date Unique Identifier N  Can be used in place of due_dts, must be unique. 

Example Strings

Add Auto Schedule

URL-?WoNo=WONO&autoschedule=true

JSON

{

'WoNo':'WONO',

'autoSchedule':'true'

}

A successful add should result in

{

$id: "1",

Code: 200,

Message: "WorkOrderSchedule added successfully.",

SessionId: null,

IsValidUser: true,

-ResponseObject: {

$id: "2",

DUEDT_UNIQ: "NCJZ0IQGNK",

WONO: "0000000410",

DUE_DTS: "2014-11-25T00:00:00",

QTY: 210,

AUTOSCHEDULE: true

}

}

Add manual schedule

URL-?WoNo=WONO&autoSchedule=false&due_dts=MM-DD-YYYY

JSON

{

'WoNo':'WONO',

'autoSchedue':'false',

'due_dts':'MM-DD-YYYY'

}

A successful add should result in

{

$id: "1",

Code: 200,

Message: "WorkOrderSchedule added successfully.",

SessionId: null,

IsValidUser: true,

-ResponseObject: {

$id: "2",

DUEDT_UNIQ: "69F6SVHN7L",

WONO: "0000000410",

DUE_DTS: "2014-11-07T00:00:00",

QTY: 0,

AUTOSCHEDULE: false

}

}

Common Errors

API Key Error

If the entered API Key is invalid the system will return an "Invalid 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 entered URL the system will return an error describing it.

{

"$id": "1",

"Message": "No HTTP resource was found that matches the request URI 'http://localhost/api/WOScheduleAdd/123456789'.",

"MessageDetail": "No type was found that matches the controller named 'WOScheduleAdd'."

}

Parameter Error

If there is an error with one of the entered parameters the system will return a Schedule Add Failed error message.

{

"$id": "1",

"Code": 403,

"Message": "WorkOrderSchedule add failed.",

"SessionId": null,

"IsValidUser": true,

"ResponseObject": null

}

1.2. WO Schedule Edit

Functions

Work Order Schedule Add API is used to edit existing schedule information on a Work Order

URL-{Root URL}/API/WOSchedule/Edit/{API Key}

Parameters

Parameters  Description Required Comment
WoNo  Work Order Number N  
autoSchedule Auto Schedule  Y Can be 'true' or 'false'
qty  Scheduled Quantity N Not required if autoSchedule is 'true'
due_dts  Due Date N Not required if autoSchedule is 'true'. If used enter in MM-DD-YYYY format.
duedt_uniq Due Date Unique Identifier Y Used to select Due Date information to edit. 

Example Strings

Edit Schedule

URL-?DueDt_Uniq=DueDt_Uniq&autoschedule=true

JSON

{

'dueDt_Uniq':'DueDt_Uniq',

'autoSchedule':'true'

}

A successful edit should result in

{

$id: "1",

Code: 200,

Message: "WorkOrderSchedule edited successfully.",

SessionId: null,

IsValidUser: true,

ResponseObject: null

}

Common Errors

API Key Error

If the entered API Key is invalid the system will return an "Invalid 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 entered URL the system will return an error describing it.

{

"$id": "1",

"Message": "No HTTP resource was found that matches the request URI 'http://localhost/api/WOScheduleEdit/123456789'.",

"MessageDetail": "No type was found that matches the controller named 'WOScheduleEdit'."

}

Missing Required Parameter

If a required parameter is missing the system will return an error message describing the missing parameter.

{

"$id": "1",

"Code": 403,

"Message": "WorkOrderSchedule edit failed.Please provide DUEDT_UNIQ to edit work order schedule record.",

"SessionId": null,

"IsValidUser": true,

"ResponseObject": null

}

Parameter Error

If one of the entered parameters is invalid the system will return an error message describing the problem.

{

"$id": "1",

"Code": 403,

"Message": "WorkOrderSchedule edit failed.Work order schedule record for DUEDT_UNIQ does not exists ",

"SessionId": null,

"IsValidUser": true,

"ResponseObject": null

}

1.3. WO Schedule Get

Functions

Work Order Schedule Ge API is used to find and view existing schedule information on a Work Order

URL-{Root URL}/API/WOSchedule/Get/{API Key}

Parameters

Parameters  Description Required Comment
WoNo  Work Order Number Y  

Example Strings

Schedule Get

URL-?WoNo=WONO

JSON

{

'WoNo':'WONO'

}

A Successful Get Should result in

{

$id: "1",

Code: 200,

Message: "WorkOrderSchedule details:",

SessionId: null,

IsValidUser: true,

-ResponseObject: [

-{

$id: "2",

DUEDT_UNIQ: "69F6SVHN7L",

WONO: "410 ",

DUE_DTS: "2014-11-07T00:00:00",

QTY: 0,

AUTOSCHEDULE: false

}

]

}

Common Errors

Invalid API Key

If the entered API key is invalid the system will return an "Invalid API Key" Error Message.

{

"$id": "1",

"Code": 403,

"Message": "Invalid API Key.",

"SessionId": null,

"IsValidUser": false,

"ResponseObject": null

}

URL Error

If the entered URL is invalid the system will return a "HTTP Error" message.

{

"$id": "1",

"Message": "No HTTP resource was found that matches the request URI 'http://localhost/api/WOScheduleGet/123456789?Wono=410'.",

"MessageDetail": "No type was found that matches the controller named 'WOScheduleGet'."

}

Schedule Does Not Exist

If the requested schedule information doesn't exist the system will return a "Work Order Schedule does not exist" error message.

{

"$id": "1",

"Code": 403,

"Message": "WorkOrderSchedule does not exists.",

"SessionId": null,

"IsValidUser": true,

"ResponseObject": null

}

1.4. WO Schedule Delete

Functions

Work Order Schedule Delete API is used to remove existing schedule information from a Work Order

URL-{Root URL}/API/WOSchedule/Delete/{API Key}

Parameters

Parameters  Description Required Comment
duedtuniq Due Date Unique Identifier Y Used to select Due Date information to delete.

Example Strings

Edit Schedule

URL-?DueDtUniq=DUEDTUNIQ

JSON

{

'DueDtUniq':'DUEDTUNIQ'

}

A successful delete request should result in

{

"$id": "1",

"Code": 200,

"Message": "WorkOrderSchedule deleted successfully.",

"SessionId": null,

"IsValidUser": true,

"ResponseObject": null

}

Common Errors

API Key Error

If the entered API Key is invalid the system will return an "Invalid 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 entered URL the system will return an error describing it.

{

"$id": "1",

"Message": "No HTTP resource was found that matches the request URI 'http://localhost/api/WOScheduleDelete/123456789?duedtuniq=E8T6A1KF06'.",

"MessageDetail": "No type was found that matches the controller named 'WOScheduleDelete'."

}

Parameter Error

If there is an error with one of the entered parameters the system will return a HTTP error.

{

"$id": "1",

"Message": "No HTTP resource was found that matches the request URI 'http://localhost/api/WOScheduleDelete/123456789?duedtuniq=E8T6A1KF0'.",

"MessageDetail": "No type was found that matches the controller named 'WOScheduleDelete'."

}