JiwaAPI

<back to all web services

WorkOrderInstructionPOSTRequest

Requires Authentication
The following routes are available for this service:
POST/WorkOrders/{WorkOrderID}/Stages/{StageID}/InstructionsAdds an instruction to a work order stage.
WorkOrderInstructionPOSTRequest Parameters:
NameParameterData TypeRequiredDescription
WorkOrderIDpathstringNo
StageIDpathstringNo
WorkOrderInstruction Parameters:
NameParameterData TypeRequiredDescription
InstructionIDformstringNo
ItemNoformint?No
InstructionTextformstringNo
CustomFieldValuesformList<CustomFieldValue>No
CustomFieldValue Parameters:
NameParameterData TypeRequiredDescription
SettingIDformstringNo
SettingNameformstringNo
ContentsformstringNo
PluginIDformstringNo
PluginNameformstringNo
WorkOrderInstruction Parameters:
NameParameterData TypeRequiredDescription
InstructionIDformstringNo
ItemNoformint?No
InstructionTextformstringNo
CustomFieldValuesformList<CustomFieldValue>No

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /WorkOrders/{WorkOrderID}/Stages/{StageID}/Instructions HTTP/1.1 
Host: api.jiwa.com.au 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"WorkOrderID":"String","StageID":"String","ItemNo":0,"InstructionText":"String","CustomFieldValues":[{"SettingID":"String","SettingName":"String","Contents":"String","PluginID":"String","PluginName":"String"}]}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"InstructionID":"String","ItemNo":0,"InstructionText":"String","CustomFieldValues":[{"SettingID":"String","SettingName":"String","Contents":"String","PluginID":"String","PluginName":"String"}]}