GetPartyMaster
The purpose of the GetPartyMaster is to facilitate keeping party information synchronized that exists on separate data bases. The GetPartyMaster allows a business application to request information about a given party. The ShowPartyMaster is the response to this request providing the specific information requested.
Element information
Namespace: http://www.openapplications.org/oagis/10
Schema document: GetPartyMaster.xsd
Type: GetPartyMasterType
Properties: Global, Qualified, ID: oagis-id-90ec253c02f64a8ab0e7bff529e60e6a
Content
- Sequence [1..1]
- ApplicationArea [1..1] Provides the information that an application may need to know in order to communicate in an integration of two or more business applications. The ApplicationArea is used at the applications layer of communication. While the integration frameworks web services and middleware provide the communication layer that OAGIS operates on top of.
- DataArea [1..1] Is where the information that the BOD message carries is provided, in this case GetPartyMaster. The information consists of a Verb and one or more Nouns. The verb (Get) indicates the action to be performed on the Noun (PartyMaster).
from type BusinessObjectDocumentType
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 |
Sample instance
<GetPartyMaster releaseID="normalizedString"> <ApplicationArea> <Sender> <LogicalID>normalizedString</LogicalID> <ComponentID>normalizedString</ComponentID> <TaskID>normalizedString</TaskID> <ReferenceID>normalizedString</ReferenceID> <ConfirmationCodes>... </ConfirmationCodes> <AuthorizationID>normalizedString</AuthorizationID> </Sender> <Receiver> <LogicalID>normalizedString</LogicalID> <ComponentID>normalizedString</ComponentID> <ID/> </Receiver> <CreationDateTime></CreationDateTime> <Signature> <!--any element--> </Signature> <ScenarioID>normalizedString</ScenarioID> <CorrelationID>normalizedString</CorrelationID> <BODID>normalizedString</BODID> <Extension> <AnyExtension> <!--any element--> </AnyExtension> <Amount/> <Code/> <DateTime></DateTime> <ID/> <Indicator>true</Indicator> <Measure/> <Name/> <Number>1.0</Number> <Quantity/> <Text/> <Time></Time> <ValueText>string</ValueText> </Extension> </ApplicationArea> <DataArea> <Get> <Expression>token</Expression> </Get> <PartyMaster> <ID/> <PartyIDSet>... </PartyIDSet> <TaxIDSet>... </TaxIDSet> <TaxID>normalizedString</TaxID> <DUNSID>normalizedString</DUNSID> <CAGEID>normalizedString</CAGEID> <DODAACID>normalizedString</DODAACID> <BICID>normalizedString</BICID> <SCACID>normalizedString</SCACID> <AccountID>normalizedString</AccountID> <Name/> <Location>... </Location> <Contact>... </Contact> <AccountIDs>... </AccountIDs> <PaymentTermID>normalizedString</PaymentTermID> <PaymentMethodCode>token</PaymentMethodCode> <TaxExemptCodes>... </TaxExemptCodes> <Description/> <Note/> <FinancialParty>... </FinancialParty> <CreationDateTime></CreationDateTime> <LastModificationDateTime></LastModificationDateTime> <Status>... </Status> <ParentParty>... </ParentParty> <ChildParty>... </ChildParty> <Party>... </Party> <PartnerRoleCodes>... </PartnerRoleCodes> <Extension>....................................... </Extension> </PartyMaster> </DataArea> </GetPartyMaster>