JiwaAPI

<back to all web services

InventoryCategoryGETRequest

Requires Authentication
The following routes are available for this service:
GET/Inventory/Categories/{CategoryID}Retrieves an inventory category.
InventoryCategoryGETRequest Parameters:
NameParameterData TypeRequiredDescription
CategoryIDpathstringNo
InventoryCategory Parameters:
NameParameterData TypeRequiredDescription
CategoryIDformstringNo
CategoryNoformint?No
DescriptionformstringNo
IsDefaultformbool?No
LastSavedDateTimeformDateTime?No
Pictureformbyte[]No
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 /Inventory/Categories/{CategoryID} HTTP/1.1 
Host: api.jiwa.com.au 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<InventoryCategory xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/JiwaFinancials.Jiwa.JiwaServiceModel.Inventory.Category">
  <_x003C_CategoryID_x003E_k__BackingField>String</_x003C_CategoryID_x003E_k__BackingField>
  <_x003C_CategoryNo_x003E_k__BackingField>0</_x003C_CategoryNo_x003E_k__BackingField>
  <_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_Description_x003E_k__BackingField>String</_x003C_Description_x003E_k__BackingField>
  <_x003C_IsDefault_x003E_k__BackingField>false</_x003C_IsDefault_x003E_k__BackingField>
  <_x003C_LastSavedDateTime_x003E_k__BackingField>0001-01-01T00:00:00</_x003C_LastSavedDateTime_x003E_k__BackingField>
  <_x003C_Picture_x003E_k__BackingField>AA==</_x003C_Picture_x003E_k__BackingField>
</InventoryCategory>