JiwaAPI

<back to all web services

WorkOrderInstructionGETRequest

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

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

HTTP + XML

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

GET /WorkOrders/{WorkOrderID}/Stages/{StageID}/Instructions/{InstructionID} HTTP/1.1 
Host: api.jiwa.com.au 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<WorkOrderInstruction xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/JiwaFinancials.Jiwa.JiwaServiceModel.WorkOrders">
  <_x003C_CustomFieldValues_x003E_k__BackingField xmlns:d2p1="http://schemas.datacontract.org/2004/07/JiwaFinancials.Jiwa.JiwaServiceModel.CustomFields">
    <d2p1:CustomFieldValue>
      <d2p1:_x003C_Contents_x003E_k__BackingField>String</d2p1:_x003C_Contents_x003E_k__BackingField>
      <d2p1:_x003C_PluginID_x003E_k__BackingField>String</d2p1:_x003C_PluginID_x003E_k__BackingField>
      <d2p1:_x003C_PluginName_x003E_k__BackingField>String</d2p1:_x003C_PluginName_x003E_k__BackingField>
      <d2p1:_x003C_SettingID_x003E_k__BackingField>String</d2p1:_x003C_SettingID_x003E_k__BackingField>
      <d2p1:_x003C_SettingName_x003E_k__BackingField>String</d2p1:_x003C_SettingName_x003E_k__BackingField>
    </d2p1:CustomFieldValue>
  </_x003C_CustomFieldValues_x003E_k__BackingField>
  <_x003C_InstructionID_x003E_k__BackingField>String</_x003C_InstructionID_x003E_k__BackingField>
  <_x003C_InstructionText_x003E_k__BackingField>String</_x003C_InstructionText_x003E_k__BackingField>
  <_x003C_ItemNo_x003E_k__BackingField>0</_x003C_ItemNo_x003E_k__BackingField>
</WorkOrderInstruction>