HR-XML 3.0 Standards, 2009 September 23.
Menu: [ Guidelines | BODs | Nouns | Global Elements | WSDL | Packages | Code Lists | Master Index ]
Element: List
| Name | List |
|---|---|
| Type | ListType |
| Documentation | In an effort to simpilify the usage of the verbs the List verb is being deprecated as of OAGIS 9.0, the List 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 Show verb which may serve the same function of the List verb has in the past. The purpose of the List verb is to enable a business software component to respond to a GetList request or to proactively send a listing of summary information containing many instances of occurrences of data for a noun to one or more other business software components.The results of a List may then be used as is, or they may be used to select a specific instance of a document or entity in order to issue a detail Get request.Although BODs based on this verb do not commonly cause updates to occur, there may be times when the component receiving the List decides to use the information it receives to update. This is entirely the decision of the receiving software component and is not forbidden.The behavior of the List verb is quite straight forward with a few exceptions. The List response to any GetList request needs to read the request carefully to ensure the response is returning the requested Data Types. The List needs to ensure the response to the GetList does not exceed the maxItems value.The List needs to find the specific Field Identifiers that are used for the Field-Based Selection or Range-Based Selection and process them accordingly. The attributes associated with the List BODs are as follows: o rsstart attribute is a number that idicates the starting record for the section of the resulting set returned in the list message. This value should always match the rsstart value in the originating GetList BOD. o rscount attribute is a number that indicates the number of records returned in the message. The subsequent request for additional records should have a rsstart value of rscount + 1. o rstotal attribute is a number that indicates the total number of records in the result set. o rscomplete attribute is a Boolean that indicates that the list provided exhaust the possible values. o rsref attribute is a string that represents the implementation-specific result set identifier for subsequent requests. |
XML Instance Representation
<List
recordSetStartNumber=" PositiveIntegerNumericType [0..1]"
recordSetCount=" PositiveIntegerNumericType [0..1]"
recordSetTotal=" PositiveIntegerNumericType [0..1]"
recordSetCompleteIndicator=" IndicatorType [0..1]"
recordSetReferenceId=" NormalizedStringType [0..1]">
</List>
recordSetStartNumber=" PositiveIntegerNumericType [0..1]"
recordSetCount=" PositiveIntegerNumericType [0..1]"
recordSetTotal=" PositiveIntegerNumericType [0..1]"
recordSetCompleteIndicator=" IndicatorType [0..1]"
recordSetReferenceId=" NormalizedStringType [0..1]">
</List>
Schema Component Representation