JiwaAPI

<back to all web services

InventoryDocumentGETRequest

Requires Authentication
The following routes are available for this service:
GET/Inventory/{InventoryID}/Documents/{DocumentID}Retrieves an inventory document.
InventoryDocumentGETRequest Parameters:
NameParameterData TypeRequiredDescription
InventoryIDpathstringNo
DocumentIDpathstringNo
Document Parameters:
NameParameterData TypeRequiredDescription
DocumentIDformstringNo
DocumentTypeformDocumentTypeNo
FileIDformstringNo
PhysicalFileNameformstringNo
FullPhysicalFileNameformstringNo
DescriptionformstringNo
LastSavedDateTimeformDateTime?No
LastModifiedByStaffIDformstringNo
LastModifiedByStaffUsernameformstringNo
LastModifiedByStaffTitleformstringNo
LastModifiedByStaffFirstNameformstringNo
LastModifiedByStaffSurnameformstringNo
FileBinaryformbyte[]No
DocumentType Parameters:
NameParameterData TypeRequiredDescription
DocumentTypeIDformstringNo
DescriptionformstringNo
DefaultTypeformbool?No
ItemNoformint?No

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

<Document xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/JiwaFinancials.Jiwa.JiwaServiceModel.Documents">
  <_x003C_Description_x003E_k__BackingField>String</_x003C_Description_x003E_k__BackingField>
  <_x003C_DocumentID_x003E_k__BackingField>String</_x003C_DocumentID_x003E_k__BackingField>
  <_x003C_DocumentType_x003E_k__BackingField>
    <_x003C_DefaultType_x003E_k__BackingField>false</_x003C_DefaultType_x003E_k__BackingField>
    <_x003C_Description_x003E_k__BackingField>String</_x003C_Description_x003E_k__BackingField>
    <_x003C_DocumentTypeID_x003E_k__BackingField>String</_x003C_DocumentTypeID_x003E_k__BackingField>
    <_x003C_ItemNo_x003E_k__BackingField>0</_x003C_ItemNo_x003E_k__BackingField>
  </_x003C_DocumentType_x003E_k__BackingField>
  <_x003C_FileBinary_x003E_k__BackingField>AA==</_x003C_FileBinary_x003E_k__BackingField>
  <_x003C_FileID_x003E_k__BackingField>String</_x003C_FileID_x003E_k__BackingField>
  <_x003C_FullPhysicalFileName_x003E_k__BackingField>String</_x003C_FullPhysicalFileName_x003E_k__BackingField>
  <_x003C_LastModifiedByStaffFirstName_x003E_k__BackingField>String</_x003C_LastModifiedByStaffFirstName_x003E_k__BackingField>
  <_x003C_LastModifiedByStaffID_x003E_k__BackingField>String</_x003C_LastModifiedByStaffID_x003E_k__BackingField>
  <_x003C_LastModifiedByStaffSurname_x003E_k__BackingField>String</_x003C_LastModifiedByStaffSurname_x003E_k__BackingField>
  <_x003C_LastModifiedByStaffTitle_x003E_k__BackingField>String</_x003C_LastModifiedByStaffTitle_x003E_k__BackingField>
  <_x003C_LastModifiedByStaffUsername_x003E_k__BackingField>String</_x003C_LastModifiedByStaffUsername_x003E_k__BackingField>
  <_x003C_LastSavedDateTime_x003E_k__BackingField>0001-01-01T00:00:00</_x003C_LastSavedDateTime_x003E_k__BackingField>
  <_x003C_PhysicalFileName_x003E_k__BackingField>String</_x003C_PhysicalFileName_x003E_k__BackingField>
</Document>