SyncResponse
The SyncResponse verb is used to communicate the results of a Sync BOD.
Element information
Namespace: http://www.openapplications.org/oagis/10
Schema document: Common.xsd
Type: RespondType
Properties: Global, Qualified, ID: oagis-id-804e190ec09145b1872717b0a7af2866
Content
- OriginalApplicationArea [0..1] A copy of the ApplicationArea for the original BOD that was processed. Present either as additional reference information, or for use in identifying the BOD in situations where a BODReference is not known.
- ResponseCriteria [0..*] ResponseCriteria identifies the content that is to be returned, given query success. In essence, the expression here has the effect of filtering the part(s) of the found element(s) that are to be returned. ReturnCriteria plays no role in the query itself. That is handled as a match against the request BOD's noun exemplar. ReturnCriteria allows the sender of the BOD to indicate which information (down to the field level) is requested to be returned, given that the query has been successful in matching the exemplar to existing nouns. That is, in a GetListPurchaseOrder, if one or more PurchaseOrders with a TotalPrice = $1M were found, ReturnCriteria tells the BOD recipient which parts of the PurchaseOrder should be populated with content when the response (ShowPurchaseOrder) is formulated. The expressionLanguage indicates the expression language being used. In order for the ReturnCriteria expression to be evaluable by the BOD recipient, the recipient must be capable of processing and interpreting the specified expression language. XPath is the default, due to its ubiquity among XML processing technologies.
from type ResponseVerbType
Attributes
None
Used in
- Type SyncResponseAllocateResourceDataAreaType (Element DataArea)
- Type SyncResponseBOMDataAreaType (Element DataArea)
- Type SyncResponseBatchCertificateOfAnalysisDataAreaType (Element DataArea)
- Type SyncResponseCarrierRouteDataAreaType (Element DataArea)
- Type SyncResponseCatalogDataAreaType (Element DataArea)
- Type SyncResponseChartOfAccountsDataAreaType (Element DataArea)
- Type SyncResponseCommercialInvoiceDataAreaType (Element DataArea)
- Type SyncResponseConfigurationDataAreaType (Element DataArea)
- Type SyncResponseConfirmWIPDataAreaType (Element DataArea)
- Type SyncResponseCreditDataAreaType (Element DataArea)
- Type SyncResponseCreditStatusDataAreaType (Element DataArea)
- Type SyncResponseCreditTransferDataAreaType (Element DataArea)
- Type SyncResponseCreditTransferISTDataAreaType (Element DataArea)
- Type SyncResponseCurrencyExchangeRateDataAreaType (Element DataArea)
- Type SyncResponseCustomerPartyMasterDataAreaType (Element DataArea)
- Type SyncResponseDebitTransferDataAreaType (Element DataArea)
- Type SyncResponseDebitTransferISTDataAreaType (Element DataArea)
- Type SyncResponseDispatchListDataAreaType (Element DataArea)
- Type SyncResponseEmployeeWorkScheduleDataAreaType (Element DataArea)
- Type SyncResponseEmployeeWorkTimeDataAreaType (Element DataArea)
- Type SyncResponseEngineeringChangeOrderDataAreaType (Element DataArea)
- Type SyncResponseEngineeringWorkDocumentDataAreaType (Element DataArea)
- Type SyncResponseFieldDataAreaType (Element DataArea)
- Type SyncResponseFreightInvoiceDataAreaType (Element DataArea)
- Type SyncResponseHazardousMaterialShipmentDocumentDataAreaType (Element DataArea)
- Type SyncResponseInspectDeliveryDataAreaType (Element DataArea)
- Type SyncResponseInventoryBalanceDataAreaType (Element DataArea)
- Type SyncResponseInventoryConsumptionDataAreaType (Element DataArea)
- Type SyncResponseInventoryCountDataAreaType (Element DataArea)
- Type SyncResponseInvoiceDataAreaType (Element DataArea)
- Type SyncResponseIssueInventoryDataAreaType (Element DataArea)
- Type SyncResponseItemCertificateOfAnalysisDataAreaType (Element DataArea)
- Type SyncResponseItemMasterDataAreaType (Element DataArea)
- Type SyncResponseItemNonconformanceDataAreaType (Element DataArea)
- Type SyncResponseLocationDataAreaType (Element DataArea)
- Type SyncResponseLocationServiceDataAreaType (Element DataArea)
- Type SyncResponseMaintenanceOrderDataAreaType (Element DataArea)
- Type SyncResponseMergeWIPDataAreaType (Element DataArea)
- Type SyncResponseMoveInventoryDataAreaType (Element DataArea)
- Type SyncResponseMoveProductDataAreaType (Element DataArea)
- Type SyncResponseMoveProductForecastDataAreaType (Element DataArea)
- Type SyncResponseMoveWIPDataAreaType (Element DataArea)
- Type SyncResponseOnlineOrderDataAreaType (Element DataArea)
- Type SyncResponseOnlineSessionDataAreaType (Element DataArea)
- Type SyncResponseOperationDataAreaType (Element DataArea)
- Type SyncResponseOpportunityDataAreaType (Element DataArea)
- Type SyncResponsePartyMasterDataAreaType (Element DataArea)
- Type SyncResponsePartyScreenDataAreaType (Element DataArea)
- Type SyncResponsePartyScreenResponseDataAreaType (Element DataArea)
- Type SyncResponsePaymentStatusDataAreaType (Element DataArea)
- Type SyncResponsePaymentStatusISTDataAreaType (Element DataArea)
- Type SyncResponsePersonnelDataAreaType (Element DataArea)
- Type SyncResponsePickListDataAreaType (Element DataArea)
- Type SyncResponsePlanningScheduleDataAreaType (Element DataArea)
- Type SyncResponsePriceListDataAreaType (Element DataArea)
- Type SyncResponseProductAvailabilityDataAreaType (Element DataArea)
- Type SyncResponseProductionOrderDataAreaType (Element DataArea)
- Type SyncResponseProductionPerformanceDataAreaType (Element DataArea)
- Type SyncResponseProductionScheduleDataAreaType (Element DataArea)
- Type SyncResponseProjectMasterDataAreaType (Element DataArea)
- Type SyncResponsePurchaseOrderDataAreaType (Element DataArea)
- Type SyncResponseQuoteDataAreaType (Element DataArea)
- Type SyncResponseRFQDataAreaType (Element DataArea)
- Type SyncResponseReceiveDeliveryDataAreaType (Element DataArea)
- Type SyncResponseReceiveItemDataAreaType (Element DataArea)
- Type SyncResponseRecoverWIPDataAreaType (Element DataArea)
- Type SyncResponseRemittanceAdviceDataAreaType (Element DataArea)
- Type SyncResponseRequireProductDataAreaType (Element DataArea)
- Type SyncResponseRequisitionDataAreaType (Element DataArea)
- Type SyncResponseRiskControlLibraryDataAreaType (Element DataArea)
- Type SyncResponseRoutingDataAreaType (Element DataArea)
- Type SyncResponseSalesLeadDataAreaType (Element DataArea)
- Type SyncResponseSalesOrderDataAreaType (Element DataArea)
- Type SyncResponseSequenceScheduleDataAreaType (Element DataArea)
- Type SyncResponseShipmentDataAreaType (Element DataArea)
- Type SyncResponseShipmentScheduleDataAreaType (Element DataArea)
- Type SyncResponseShipmentUnitDataAreaType (Element DataArea)
- Type SyncResponseShippersExportDeclarationDataAreaType (Element DataArea)
- Type SyncResponseShippersLetterOfInstructionDataAreaType (Element DataArea)
- Type SyncResponseSplitWIPDataAreaType (Element DataArea)
- Type SyncResponseSupplierPartyMasterDataAreaType (Element DataArea)
- Type SyncResponseTableDataAreaType (Element DataArea)
- Type SyncResponseUOMGroupDataAreaType (Element DataArea)
- Type SyncResponseWIPStatusDataAreaType (Element DataArea)
- Type SyncResponseWarehouseShippingAdviceDataAreaType (Element DataArea)
- Type SyncResponseWarehouseShippingOrderDataAreaType (Element DataArea)
- Type SyncResponseWarrantyClaimDataAreaType (Element DataArea)
Sample instance
<SyncResponse> <OriginalApplicationArea> <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> </OriginalApplicationArea> <ResponseCriteria> <ResponseExpression actionCode="token">token</ResponseExpression> <ChangeStatus> <ID/> <IDSet>... </IDSet> <Code/> <Description/> <ReasonCode>normalizedString</ReasonCode> <Reason/> <EffectiveTimePeriod>.................. </EffectiveTimePeriod> <StateChange>... </StateChange> <Extension>....................................... </Extension> </ChangeStatus> </ResponseCriteria> </SyncResponse>