JiwaAPI

<back to all web services

InventoryComponentGETRequest

Requires Authentication
The following routes are available for this service:
GET/Inventory/{InventoryID}/Components/{ComponentID}Retrieves a component from an inventory item.
InventoryComponentGETRequest Parameters:
NameParameterData TypeRequiredDescription
InventoryIDpathstringNo
ComponentIDpathstringNo
InventoryComponent Parameters:
NameParameterData TypeRequiredDescription
ComponentQuantityformdecimal?No
ItemNoformint?No
ComponentIDformstringNo
ComponentInventoryIDformstringNo
ComponentInventoryPartNoformstringNo
ComponentInventoryDescriptionformstringNo

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

<InventoryComponent xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/JiwaFinancials.Jiwa.JiwaServiceModel.Inventory">
  <_x003C_ComponentID_x003E_k__BackingField>String</_x003C_ComponentID_x003E_k__BackingField>
  <_x003C_ComponentInventoryDescription_x003E_k__BackingField>String</_x003C_ComponentInventoryDescription_x003E_k__BackingField>
  <_x003C_ComponentInventoryID_x003E_k__BackingField>String</_x003C_ComponentInventoryID_x003E_k__BackingField>
  <_x003C_ComponentInventoryPartNo_x003E_k__BackingField>String</_x003C_ComponentInventoryPartNo_x003E_k__BackingField>
  <_x003C_ComponentQuantity_x003E_k__BackingField>0</_x003C_ComponentQuantity_x003E_k__BackingField>
  <_x003C_ItemNo_x003E_k__BackingField>0</_x003C_ItemNo_x003E_k__BackingField>
</InventoryComponent>