4.1 Getting Entity Instances

  • Article

To get a set of EntityInstances for a given search token, protocol client constructs the following SOAP message:

 <s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
   <s:Body>
     <GetEntityInstances xmlns="http://tempuri.org/"
                       xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
       <systemInstanceName>ContosoCustomers</systemInstanceName>
       <entityNamespace>http://www.contoso.com </entityNamespace>
       <entityName>Customer</entityName>
       <displayFieldName>CustomerName</displayFieldName>
       <searchToken/>
       <usedForPicking>true</usedForPicking>
       <maxResults>500</maxResults>
       <refreshInterval/>
     </GetEntityInstances>
   </s:Body>
 </s:Envelope>

The protocol server then responds with the following:

 <s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
   <s:Body xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
           xmlns:xsd="http://www.w3.org/2001/XMLSchema"><GetEntityInstancesResponse 
           xmlns="http://tempuri.org/">
   <GetEntityInstancesResult>3</GetEntityInstancesResult>
     <columnNames>
       <string>___identities</string>
       <string>___entityInstanceReference</string>
       <string>___displayName</string>
       <string>CustomerID</string>
       <string>CustomerName</string>
     </columnNames>
     <showInPicker>
       <boolean>false</boolean>
       <boolean>false</boolean>
       <boolean>false</boolean>
       <boolean>true</boolean>
       <boolean>true</boolean>
     </showInPicker>
     <values>
       <string>__bg40001300</string>
       <string>22:http://www.contoso.com8:Customer16:CustomerRead 
 Item16:ContosoCustomersiAQAAAA==</string>
       <string>Contoso</string>
       <string>1</string>
       <string>Contoso</string>
       <string>__bg40002300</string>
       <string>22:http://www.contoso.com8:Customer16:CustomerRead 
 Item16:ContosoCustomersiAQBBB==</string>
       <string>Fabrikam</string>
       <string>2</string>
       <string>Fabrikam</string>
       <string>__bg40003300</string>
       <string>22:http://www.contoso.com8:Customer16:CustomerRead 
 Item16:ContosoCustomersiAQACCC==</string>
       <string>Northwind</string>
       <string>1</string>
       <string>Northwind</string>
     </values>
     <hasEntityMetadata>true</hasEntityMetadata>
     <message>Search criteria cannot be met as filters are not defined for the 
 Query. Contact your system administrator.</message>
     <success>true</success>
   </GetEntityInstancesResponse>
   </s:Body>
 </s:Envelope>