DataArea

Is where the information that the BOD message carries is provided, in this case GetListInventoryCount. The information consists of a Verb and one or more Nouns. The verb (GetList) indicates the action to be performed on the Noun (InventoryCount).

See http://www.openapplications.org/oagis/9.

Element information

Content

• Sequence [1..1]
  1. GetList [1..1]    In an effort to simpilify the usage of the verbs the GetList verb is being deprecated as of OAGIS 9.0, the GetList will still be provided for the next three releases at which time it is scheduled to be removed from OAGIS. As such for all new development we recommend that you use the Get verb which may serve the same function of the GetList verb has in the past. The purpose of the GetList verb is to enable a business software component to request summary information for one or more occurrences of a specific noun from another business software component. The GetList may be paired with most of the nouns in the OAGIS specification.The response to this request is a BOD using the List verb. The GetList is designed to retrieve multiple occurrences of data such as all of the sales orders or all of the purchase orders within a requested range. It does not require an exact match of the key fields in order to retrieve information. It may use a range selection criteria with a "from" and "to" selection capability. This behavior is quite different from the Get verb, which is designed to retrieve a specific noun using a specific key field.The GetList verb also enables the retrieval of information across several documents by using selection fields. An example of this could be requesting all sales order lines for a specific item. This type of functionality is limited to the capabilities of the responding application and needs to be determined during the implementation project. More details on this capability will be described below. GetList attributes: o maxitems attribute is a number that indicates the number of maximum items to be returned. o rssave attribute is a Boolean flag that indicates whether the result set should be saved on the sending system if maxitems is exceeded. o rsstart attribute is a number of the starting record for the next section of the result set. If it is omitted, it is to be assumed the first of the maxitems. o rsref attribute is a string that represents the implementation-specific result set identifier for subsequent requests. Selection Criteria: There are two types of selection capabilities enabled by the BODs that use the GetList verb. 1) Field-Based Selection Allows the requesting system to ask for information that matches the data provided. It also allows the requestor to indicate the information that to be returned by specifying the ReturnCriteria indicated on the GetList Verb. 2) Range Selection Allows the requesting system to provide a range of values for known data. This is accomplished by providing two occurances of the Noun. The first occurance indicates the "From" the second occurance indicates the "To" occurance. Again the requestor can indicate the information that to be returned by specifying the ReturnCriteria indicated on the GetList Verb.
  2. InventoryCount [1..*]    InventoryCount represents the results of a physical inventory or cycle count of the actual on-hand quantities of each item in each location. Compare to the noun InventoryBalance, which represents system-maintained on-hand quantities.

Attributes

None

Used in

• Type GetListInventoryCountType (Element GetListInventoryCount)

Sample instance

<DataArea>
   <GetList>
      <Expression>token</Expression>
   </GetList>
   <InventoryCount>
      <InventoryCountHeader>
         <DocumentID>...
         </DocumentID>
         <AlternateDocumentID>...
         </AlternateDocumentID>
         <LastModificationDateTime>2000-01-01</LastModificationDateTime>
         <DocumentDateTime>2000-01-01</DocumentDateTime>
         <Description>string</Description>
         <Note>string</Note>
         <DocumentReference>...
         </DocumentReference>
         <Attachment>...
         </Attachment>
         <UserArea>
            <!--any element-->
         </UserArea>
      </InventoryCountHeader>
      <InventoryCountLine>
         <LineNumber>normalizedString</LineNumber>
         <Description>string</Description>
         <Note>string</Note>
         <DocumentReference>...
         </DocumentReference>
         <Attachment>...
         </Attachment>
         <Item>...
         </Item>
         <SerialNumber>normalizedString</SerialNumber>
         <SerializedLot>...
         </SerializedLot>
         <UID>normalizedString</UID>
         <RFID>normalizedString</RFID>
         <Quantity>1.0</Quantity>
         <GLEntityID>normalizedString</GLEntityID>
         <Facility>...
         </Facility>
         <Status>...
         </Status>
         <ReasonCode>normalizedString</ReasonCode>
         <TransactionDateTime>2000-01-01</TransactionDateTime>
         <UserArea>
            <!--any element-->
         </UserArea>
      </InventoryCountLine>
   </InventoryCount>
</DataArea>