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 .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.

GET /Inventory/Categories/{CategoryID} HTTP/1.1 
Host: api.jiwa.com.au 
Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"CategoryID":"String","CategoryNo":0,"Description":"String","IsDefault":false,"LastSavedDateTime":"0001-01-01T00:00:00.0000000","Picture":"AA==","CustomFieldValues":[{"SettingID":"String","SettingName":"String","Contents":"String","PluginID":"String","PluginName":"String"}]}