Definition Type: Element
Name: GetList
Namespace: http://www.starstandard.org/STAR/5
Type: oagis:GetListType
Containing Schema: Meta.xsd
Abstract
Documentation:
In an effort to simpilify the usage of the verbs the GetList verb is being depricated 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. The OAGIS Meta Data documentation has more information in regards to this verbs usage and structure.
Collapse XSD Schema Diagram:
Drilldown into Expression in schema meta_xsd1 Drilldown into VerbType in schema meta_xsd1 Drilldown into RequestVerbType in schema meta_xsd1 Drilldown into recordSetReferenceId in schema meta_xsd1 Drilldown into recordSetStartNumber in schema meta_xsd1 Drilldown into recordSetSaveIndicator in schema meta_xsd1 Drilldown into maxItems in schema meta_xsd1 Drilldown into uniqueIndicator in schema meta_xsd1 Drilldown into GetType in schema meta_xsd1 Drilldown into GetListType in schema meta_xsd1XSD Diagram of GetList in schema meta_xsd (Standards for Technology in Automotive Retail)
Collapse XSD Schema Code:
<xsd:element name="GetList" type="oagis:GetListType">
    <xsd:annotation>
        <xsd:documentation source="http://www.openapplications.org/oagis/9.0">In an effort to simpilify the usage of the verbs the GetList verb
            is being depricated 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.
         </xsd:documentation>
        <xsd:documentation>The OAGIS Meta Data documentation has more information in regards to this verbs usage and
            structure.</xsd:documentation>
    </xsd:annotation>
</xsd:element>
Collapse Child Elements:
Name Type Min Occurs Max Occurs
Expression oagis:Expression (1) unbounded
Collapse Child Attributes:
Name Type Default Value Use
uniqueIndicator oagis:uniqueIndicator Optional
maxItems oagis:maxItems Optional
recordSetSaveIndicator oagis:recordSetSaveIndicator Optional
recordSetStartNumber oagis:recordSetStartNumber Optional
recordSetReferenceId oagis:recordSetReferenceId Optional
Collapse Derivation Tree: