JiwaAPI

<back to all web services

BillInstructionPATCHRequest

Requires Authentication
The following routes are available for this service:
PATCH/Bills/{BillID}/Stages/{StageID}/Instructions/{InstructionID}Updates an instruction for a bill stage.
BillInstructionPATCHRequest Parameters:
NameParameterData TypeRequiredDescription
BillIDpathstringNo
StageIDpathstringNo
InstructionIDpathstringNo
BillInstruction Parameters:
NameParameterData TypeRequiredDescription
InstructionIDformstringNo
ItemNoformint?No
InstructionTextformstringNo
CustomFieldValuesformList<CustomFieldValue>No
CustomFieldValue Parameters:
NameParameterData TypeRequiredDescription
SettingIDformstringNo
SettingNameformstringNo
ContentsformstringNo
PluginIDformstringNo
PluginNameformstringNo
BillInstruction 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 .csv suffix or ?format=csv

HTTP + CSV

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

PATCH /Bills/{BillID}/Stages/{StageID}/Instructions/{InstructionID} HTTP/1.1 
Host: api.jiwa.com.au 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

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

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