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'."
}
|