GetListSalesOrder

In an effort to simpilify the usage of the verbs the GetListSalesOrder BOD is being deprecated as of OAGIS 9.0, the GetListSalesOrder 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 GetSalesOrder BOD which may serve the same function of the GetListSalesOrder BOD.

The purpose of the GetList SalesOrder is to enable a business application module to request information containing summary information for one or more SalesOrder from another business application.

The response to this request is the List SalesOrder.

The GetList SalesOrder also enables the retrieval of information across several documents by using selection fields.  An example of this could be requesting all SalesOrder 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. 

This BOD does not usually cause updates to occur.  It may be used as part of a large integration scenario or as a single tool for requesting information on existing demands for goods or services.

For example, a Sales Automation application may use this BOD to ask for information from a Customer Order application.

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

Element information

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

Schema document: org_openapplications_oagis/9_4_1/Developer/BODs/GetListSalesOrder.xsd

Type: GetListSalesOrderType

Properties: Global, Qualified

Content

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

Attributes

Name	Occ	Type	Description	Notes
releaseID	[1..1]	NormalizedStringType	OAGIS Release this BOD Instances belongs or the OAGIS release that the derivative work is based on.	from type BusinessObjectDocumentType
versionID	[0..1]	NormalizedStringType	Indicates the version of the given BOD definition.	from type BusinessObjectDocumentType
systemEnvironmentCode	[0..1]	SystemEnvironmentCodeContentType	Indicates whether this BOD is being sent in a "Test" or a "Production" mode. If the BOD is being sent in a test mode, it's information should not affect the business operation. However, if the BOD is sent in "Production" mode it is assumed that all test has been complete and the contents of the BOD are to affect the operation of the receiving business application(s).	Default value is "Production". from type BusinessObjectDocumentType
languageCode	[0..1]	LanguageCodeContentType	Indicates the language that the contents of the BOD is in unless otherwise stated.	Default value is "en-US". from type BusinessObjectDocumentType

Used in

Type OAGIS9BODsType (Element OAGIS9BODs)

Sample instance

<GetListSalesOrder releaseID="normalizedString">
   <ApplicationArea>
      <Sender>
         <LogicalID>normalizedString</LogicalID>
         <ComponentID>normalizedString</ComponentID>
         <TaskID>normalizedString</TaskID>
         <ReferenceID>normalizedString</ReferenceID>
         <ConfirmationCode>Always</ConfirmationCode>
         <AuthorizationID>normalizedString</AuthorizationID>
      </Sender>
      <Receiver>
         <LogicalID>normalizedString</LogicalID>
         <ComponentID>normalizedString</ComponentID>
         <ID>normalizedString</ID>
      </Receiver>
      <CreationDateTime>2000-01-01</CreationDateTime>
      <Signature>
         <!--any element-->
      </Signature>
      <BODID>normalizedString</BODID>
      <UserArea>
         <!--any element-->
      </UserArea>
   </ApplicationArea>
   <DataArea>
      <GetList>
         <Expression>token</Expression>
      </GetList>
      <SalesOrder>
         <SalesOrderHeader>...
         </SalesOrderHeader>
         <SalesOrderLine>...
         </SalesOrderLine>
      </SalesOrder>
   </DataArea>
</GetListSalesOrder>