Navigation:  IVR Applications > Inventory Status Interface >

Server Protocol

 Previous pageReturn to chapter overviewNext page

The Inventory Status Interface (ISI) server protocol uses XML sent the HTML POST method.

 

HTTP Headers

In addition to the standard Content-type and Content-Length fields, the server sends the field User-Agent, which specifies both the DV2000/DV4 version number and the ISI version number (as a three-digit number).  See the example POST packet below.

 

Document Root

The document root is defined as inventory, and may contain one or more room elements.  See the Example POST Packet section, below, for an example of how this element is composed.

 

Room Element

The room element contains the information being update for a given room.  Depending on configuration, more than one room element may be contained in a single POST.  See the Example POST Packet section, below, for an example of how this element is composed.  The following table lists the possible attributes for a room element.

 

Attribute

Required

Description

number

Yes

Room number

date

Yes

Date item was posted; format:  YYYYMMDD

description

No

Description of room

time

Yes

Time item was posted; 24-hour format:  HH:MM:SS

status

No

Room clean status as defined in hospitality configuration

sequence

Yes

Message number; unique integer (per server)

result

Yes (response only)

On return result:  0 = Success, 1 = Reschedule

 

Item Element

The item element contains the data necessary to report the quantity for a single item ID.  A given room element may contain one or more item elements.  See the Example POST Packet section, below, for an example of how this element is composed.  The following table lists the possible attributes for an item element.

 

Attribute

Required

Description

id

Yes

Item ID number (specified by user)

category

No

Name of category to which the item is assigned

description

No

Item description

price

Yes

Price per unit

quantity

Yes

Number of units (specified by user)

 

User Element

A room element will contain a single user element which specifies the user who generated the posting.  The user's first and last name, if specified, will be included as separate elements within the user element and will be denoted as fname and lname, respectively.  See the Example POST Packet section, below, for an example of how this element is composed.  The following table lists the possible attributes for a user element.

 

Attribute

Required

Description

id

Yes

User's ID number

 

Example POST Packet

The following is an example POST packet demonstrating all possible elements and attributes previously described:

 

POST / HTTP/1.0

Content-type: text/xml

User-Agent: DuVoice/4.01.010 ISI/100

Content-Length: length

 

<?xml version="1.0" encoding="ISO-8859-1"?>

<inventory>

       <room number="600" date="20090916" time="15:58:39" description="Blue suite" status="4" sequence="76">

               <user id="999">

                       <fname>Ren</fname>

                       <lname>Hoek</lname>

               </user>

               <item id="3" quantity="1" category="alcohol" description="Bud Light" price="3.99"/>

               <item id="6" quantity="5" category="food" description="Bottled Water" price="1.95"/>

       </room>

</inventory>

</xml>

 

The following is an example response to the above POST packet:

 

HTTP/1.1 200 OK

Content-type: text/xml

Content-Length: length

 

<?xml version="1.0" encoding="ISO-8859-1"?>

<inventory>

       <room number="600" sequence="76" result="0"/>

</inventory>

</xml>