JiwaAPI

<back to all web services

BillInstructionCustomFieldGETRequest

Requires Authentication
The following routes are available for this service:
GET/Bills/Instructions/CustomFields/{SettingID}Retrieves a bill instruction custom field.
BillInstructionCustomFieldGETRequest Parameters:
NameParameterData TypeRequiredDescription
SettingIDpathstringNo
CustomField Parameters:
NameParameterData TypeRequiredDescription
SettingIDformstringNo
SettingNameformstringNo
PluginIDformstringNo
PluginNameformstringNo
CellTypeformCellTypesNo
DisplayOrderformintNo

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 /Bills/Instructions/CustomFields/{SettingID} HTTP/1.1 
Host: api.jiwa.com.au 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<CustomField xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/JiwaFinancials.Jiwa.JiwaServiceModel.CustomFields">
  <_x003C_CellType_x003E_k__BackingField>Date</_x003C_CellType_x003E_k__BackingField>
  <_x003C_DisplayOrder_x003E_k__BackingField>0</_x003C_DisplayOrder_x003E_k__BackingField>
  <_x003C_PluginID_x003E_k__BackingField>String</_x003C_PluginID_x003E_k__BackingField>
  <_x003C_PluginName_x003E_k__BackingField>String</_x003C_PluginName_x003E_k__BackingField>
  <_x003C_SettingID_x003E_k__BackingField>String</_x003C_SettingID_x003E_k__BackingField>
  <_x003C_SettingName_x003E_k__BackingField>String</_x003C_SettingName_x003E_k__BackingField>
</CustomField>