‘inventory’ Structure

The 'inventory' structure contains customer inventory or resource inventory and its properties. Specific pool is specified every time the structure is mentioned. The 'inventory' structure contains the following elements:

'inventory' structure elements

Name

Required

Type

Description

properties

Yes

struct

array of 'property' structures that contain inventory properties, where 'label' can be any company-defined inventory property, with read/write visibility for the Inbound API and its corresponding 'value'

OR

'label' can be one of the following: 'invsn' — inventory serial number ('value' — string(32)) or 'invtype' — inventory type ('value' – int) or 'invtype_label' – inventory type label (value – string)

userdata

No

string

string returned in SOAP response without change. It is not used by the Inbound Interface, but intended for it (e.g. client may use this to store an ID in SOAP request and then quickly find record in SOAP response using this ID)

default value: none

files

No

struct

array of 'file' structures containing inventory file properties

default value: none

  • 'inventory' Structure Example

<inventory> 
			<properties> 
						<property> 
										<label>invsn</label> 
										<value>SN34634987</value> 
						</property> 
						<property> 
										<label>PORT_INFO</label> 
										<value>1:C:1</value> 
						</property> 
			</properties> 
</inventory>