Example: Find Action
Important
This content is archived and is not being updated. For the latest documentation, see Microsoft Dynamics 365 product documentation. For the latest release plans, see Dynamics 365 and Microsoft Power Platform release plans.
Applies To: Microsoft Dynamics AX 2012 R2, Microsoft Dynamics AX 2012 Feature Pack, Microsoft Dynamics AX 2012
This topic describes sample inbound and outbound messages for the find action in Application Integration Framework (AIF) document services. You can use the find action to obtain the values of all fields in the target table, for the records that match your query criteria.
The outbound message contains an <entityName> tag for each found record.
Inbound Find Message Sample
The following inbound Find message specifies one <CriteriaElement> tag. The Equal operator is used, and the <FieldName> value is the key field. Therefore, at most one record can be returned in the outbound message from the target table. Records from a child table could also be returned in the outbound message.
There are no XML tags that are specific to this inbound message. However, the value for <DataSourceName> is specific to this message, and it must be compatible with the service that is listed in the <Action> tag. Line breaks have been added for readability.
<?xml version="1.0" encoding="utf-8"?>
<Envelope xmlns = "https://schemas.microsoft.com/
dynamics/2011/01/documents/Message">
<Header>
<MessageId>{d1e4853a-0311-1233-0008
-e84804976b33}</MessageId>
<Action>https://schemas.microsoft.com/dynamics/
2008/01/services/CustomerService/find</Action>
</Header>
<Body>
<MessageParts xmlns="https://schemas.microsoft.com/
dynamics/2011/01/documents/Message">
<QueryCriteria xmlns = "https://schemas.microsoft.com/
dynamics/2006/02/documents/QueryCriteria">
<CriteriaElement>
<DataSourceName>CustTable</DataSourceName>
<FieldName>AccountNum</FieldName>
<Operator>Equal</Operator>
<Value1>4507</Value1>
<Value2/>
</CriteriaElement>
</QueryCriteria>
</MessageParts>
</Body>
</Envelope>
Corresponding Outbound Message
The outbound message contains a <serviceExternalName> tag, which is <Customer>. The message also contains an <entityName> tag named <CustTable>, which is for the record that was found in the target table. Nested underneath is another <entityName> tag for a child table. The <DirParty> tag indicates subsequent tags that contain information about the customer. This includes the postal address. For more information about the DirParty class and the global address book (GAB) framework, see Global Address Framework.
The following outbound message is generated from the previous inbound message.
<?xml version="1.0" encoding="UTF-8" ?>
<Envelope xmlns="https://schemas.microsoft.com/dynamics/2011/01/documents/Message">
<Header>
<MessageId>{93FE7B5F-99E6-45D6-BAA5-654699EFF0EA}</MessageId>
<Action>https://schemas.microsoft.com/dynamics/2008/01/services/CustomerService/find</Action>
<RequestMessageId>{d1e4853a-0311-1233-0008-e84804976b33}</RequestMessageId>
</Header>
<Body>
<MessageParts xmlns="https://schemas.microsoft.com/dynamics/2011/01/documents/Message">
<Customer xmlns="https://schemas.microsoft.com/dynamics/2008/01/documents/Customer">
<DocPurpose>Original</DocPurpose>
<SenderId>DMO</SenderId>
<ValidAsOfDateTime>2012-04-19T19:42:40Z</ValidAsOfDateTime>
<ValidTimeStateType>AsOf</ValidTimeStateType>
<CustTable class="entity">
<_DocumentHash>261dcc95694f19ee9010b1866237b4a2</_DocumentHash>
<AccountNum>4507</AccountNum>
<AccountStatement>Always</AccountStatement>
<Blocked>No</Blocked>
<CashDisc>14D1%</CashDisc>
<CompanyType_MX>Blank</CompanyType_MX>
<CreditCardAddressVerification>None</CreditCardAddressVerification>
<CreditCardAddressVerificationLevel>Accept</CreditCardAddressVerificationLevel>
<CreditCardAddressVerificationVoid>No</CreditCardAddressVerificationVoid>
<CreditCardCVC>None</CreditCardCVC>
<Currency>USD</Currency>
<CustExcludeCollectionFee>No</CustExcludeCollectionFee>
<CustExcludeInterestCharges>No</CustExcludeInterestCharges>
<CustFinalUser_BR>No</CustFinalUser_BR>
<CustGroup>60</CustGroup>
<EInvoice>No</EInvoice>
<ExportSales_PL>No</ExportSales_PL>
<FedNonFedIndicator>None</FedNonFedIndicator>
<FiscalDocType_PL>Invoice</FiscalDocType_PL>
<ForecastDMPInclude>No</ForecastDMPInclude>
<ForeignResident_RU>No</ForeignResident_RU>
<GenerateIncomingFiscalDocument_BR>No</GenerateIncomingFiscalDocument_BR>
<GiroType>None</GiroType>
<GiroTypeAccountStatement>None</GiroTypeAccountStatement>
<GiroTypeCollectionletter>None</GiroTypeCollectionletter>
<GiroTypeFreeTextInvoice>None</GiroTypeFreeTextInvoice>
<GiroTypeInterestNote>None</GiroTypeInterestNote>
<GiroTypeProjInvoice>None</GiroTypeProjInvoice>
<ICMSContributor_BR>No</ICMSContributor_BR>
<InclTax>No</InclTax>
<InterCompanyAllowIndirectCreation>No</InterCompanyAllowIndirectCreation>
<InterCompanyAutoCreateOrders>No</InterCompanyAutoCreateOrders>
<InterCompanyDirectDelivery>No</InterCompanyDirectDelivery>
<InventProfileType_RU>NotSpecified</InventProfileType_RU>
<InvoiceAddress>InvoiceAccount</InvoiceAddress>
<InvoicePostingType_RU>Standard</InvoicePostingType_RU>
<IRS1099CIndicator>No</IRS1099CIndicator>
<MandatoryCreditLimit>No</MandatoryCreditLimit>
<MandatoryVatDate_PL>No</MandatoryVatDate_PL>
<OneTimeCustomer>No</OneTimeCustomer>
<PackageDepositExcempt_PL>No</PackageDepositExcempt_PL>
<Party>1310</Party>
<PaymTermId>D14</PaymTermId>
<PdsFreightAccrued>No</PdsFreightAccrued>
<RecId>5637144600</RecId>
<RecVersion>1</RecVersion>
<RFIDCaseTagging>No</RFIDCaseTagging>
<RFIDItemTagging>No</RFIDItemTagging>
<RFIDPalletTagging>No</RFIDPalletTagging>
<ServiceCodeOnDlvAddress_BR>No</ServiceCodeOnDlvAddress_BR>
<ShipCarrierBlindShipment>Yes</ShipCarrierBlindShipment>
<ShipCarrierFuelSurcharge>No</ShipCarrierFuelSurcharge>
<Suframa_BR>No</Suframa_BR>
<SuframaPISCOFINS_BR>No</SuframaPISCOFINS_BR>
<SyncEntityId>{00000000-0000-0000-0000-000000000000}</SyncEntityId>
<TaxWithholdCalculate_IN>No</TaxWithholdCalculate_IN>
<TaxWithholdCalculate_TH>No</TaxWithholdCalculate_TH>
<UnitedVATInvoice_LT>No</UnitedVATInvoice_LT>
<UseCashDisc>Normal</UseCashDisc>
<UsePurchRequest>No</UsePurchRequest>
<WebSalesOrderDisplay>WebEntered</WebSalesOrderDisplay>
<DirParty xsi:type="AxdEntity_DirParty_DirOrganization" class="entity" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<LanguageId>En-us</LanguageId>
<Name>3 Company</Name>
<NameAlias>3</NameAlias>
<PartyNumber>1310</PartyNumber>
<RecId>5637145091</RecId>
<RecVersion>1</RecVersion>
<DirPartyPostalAddressView class="entity">
<Address>522 West 5th Street New York, NY 10032 US</Address>
<City>New York</City>
<CountryRegionId>US</CountryRegionId>
<County>New York</County>
<IsLocationOwner>Yes</IsLocationOwner>
<ISOcode>US</ISOcode>
<IsPrimary>Yes</IsPrimary>
<IsPrivate>No</IsPrivate>
<Location>5637146387</Location>
<Party>1310</Party>
<PartyLocation>5637145688</PartyLocation>
<RecId>5637145688</RecId>
<Roles>Invoice;Primary postal address</Roles>
<State>NY</State>
<Street>522 West 5th Street</Street>
<TimeZone xsi:nil="true" />
<ValidFrom>2009-07-09T00:43:51Z</ValidFrom>
<ValidTo>2154-12-31T23:59:59Z</ValidTo>
<ZipCode>10032</ZipCode>
</DirPartyPostalAddressView>
<ABC>None</ABC>
<OrganizationName class="entity">
<Name>3 Company</Name>
<RecId>5637144581</RecId>
<RecVersion>1</RecVersion>
<ValidFrom>2009-06-13T00:17:00Z</ValidFrom>
<ValidTo>2154-12-31T23:59:59Z</ValidTo>
</OrganizationName>
</DirParty>
</CustTable>
</Customer>
</MessageParts>
</Body>
</Envelope>