Omni-Gen™ API Services Reference Guide > Instance and Master Services > Query for a Master

Query for a Master

Topics:

Use the following REST call to check if subject data matches any currently mastered subject. This service expects data in the form of a subject OID with data used for the defined matching criteria. This service will NOT cause changes in any instance or master data, including the matching indexes.

The implementation of this service will cause execution of defined cleansing plans against the input data to ensure it is standardized before the match attempt. After cleansing, the READ ONLY matching service will be executed to see if a high confidence match and associated master are available.

If a match is available this service can respond with the master ID or the full master XML document based on the responseType parameter. If a match is not found, the service will respond with an HTTP status of 404 (Not Found).

POST: /api/v1/server/master?responseType=oid|masterId

Topics:

The body of the post must be a properly formatted XML OID. Only the data used for the matching service is evaluated and other data will simply be ignored.

Note: This will NOT create data in Omni-Gen.

Example:

POST https://localhost:9514/server/api/v1/server/master?responseType=oid

Content-Type: application/xml

<customer>  
    <cu_first_name>SCOTT</cu_first_name>  
    <cu_middle_name>W</cu_middle_name>  
    <cu_last_name>BISHOPP</cu_last_name>  
    <cu_gender>M</cu_gender>  
    <cu_dob format="yyyy-MM-dd hh:mm:ss">1965-02-21 01:34:09</cu_dob>  
    <cu_ssn>874-98-4546</cu_ssn>  
</customer>

-- response --

200 OK
Server:  Apache-Coyote/1.1
X-Application-Context:  application:9500
Content-Type:  application/xml;charset=UTF-8
Content-Length:  1146
Date:  Tue, 08 May 2018 16:00:47 GMT
<RestResponse>  
<status>0</status>  
<statusText></statusText>  
<responseType>java.lang.String</responseType>  
<response>
<customerMaster>
  <MasterId>26</MasterId>  
  <cu_title>Developer</cu_title>  
  <cu_salutation>Mr</cu_salutation>  
  <cu_suffix>Phd</cu_suffix>  
  <cu_first_name>Scott</cu_first_name>  
  <cu_middle_name>W</cu_middle_name>  
  <cu_last_name>Bishopp</cu_last_name>  
  <cu_full_name>Mr Scott W Bishopp Phd</cu_full_name>  
  <cu_gender>M</cu_gender>  
  <cu_dob format="yyyy-MM-dd">1965-02-21</cu_dob>  
  <cu_ssn>874-98-4546</cu_ssn>  
  <cu_type>P</cu_type>  
  <cu_bus_name>IBI</cu_bus_name>  
  <cu_dba_name>SCOTTYB</cu_dba_name>  
  <cust_addressOmniCollection> 
    <customercust_addressMaster>
      <MasterChildId>customer:26:cust_address:1</MasterChildId>  
      <ad_1>4212 S LIVONIA RD</ad_1>  
      <ad_2>ATTN: SCOTT BISHOPP</ad_2>  
      <ad_city>LIVONIA</ad_city>  
      <ad_state>NY</ad_state>  
      <ad_zip>14487</ad_zip>  
      <ad_zip4>0212</ad_zip4>  
      <ad_country>US</ad_country> 
    </customercust_addressMaster>
  </cust_addressOmniCollection> 
</customerMaster>
</response>
</RestResponse>