IBM Support

A Sample XML Payload for Member Search via REST Web Service

Question & Answer


Question

The documentation is not clear on what the XML request payload should look like to perform a Member Search via REST Web Service. Do you have an example of such a payload and a resource for finding other web services?

Cause

Amongst other things, the IBM Initiate Enterprise Service Oriented Architecture (ESOA) Toolkit generates REST and SOAP based web services to perform tasks such as searching and retrieving member and entity data. For the REST web services, the information center does not provide detailed explanation on how to determine which objects can be accessed, manipulated and which HTTP calls can be made. For this, ESOA toolkit is bundled with its own documentation which is available once we deploy the toolkit. This documentation can be accessed at the following location: server:port/madappsvcs/ where server and port refer to the server and port where the toolkit is deployed e.g. localhost:7378/madappsvcs/. In it there's a direct link to the Web Application Description Language (WADL) document (for all web services) and contains machine-readable XML description for that particular web service.

Based on that WADL document, we can create a web service pay load to perform web services operations related to members, entities, relationships, tasks, etc.

Answer

Following is a XML web service payload that the reader can use to search for members or entities that specify a search criteria based on Social Security Number, Name, Phone , and birth date.


<genericRecord>
<attrListMap>
<attrList attrCode="SSN">
<attr>
<fieldMap>
<field name="idnumber">
<value xsi:type="xs:string"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xs="http://www.w3.org/2001/XMLSchema">555667777</value>
</field>
</fieldMap>

<fieldMap>
<field name="idissuer">
<value xsi:type="xs:string"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xs="http://www.w3.org/2001/XMLSchema">SSA</value>
</field>
</fieldMap>
</attr>
</attrList>


<attrList attrCode="PATNAME">
<attr>
<fieldMap>
<field name="onmFirst">
<value xsi:type="xs:string"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xs="http://www.w3.org/2001/XMLSchema">Mario</value>
</field>

<field name="onmLast">
<value xsi:type="xs:string"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xs="http://www.w3.org/2001/XMLSchema">Bros</value>
</field>
</fieldMap>
</attr>
</attrList>


<attrList attrCode="BIRTHDT">
<attr>
<fieldMap>
<field name="dateval">
<value xsi:type="xs:string"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xs="http://www.w3.org/2001/XMLSchema">1912-02-14</value>
</field>
</fieldMap>
</attr>
</attrList>

<attrList attrCode="HOMEPHON">
<attr>
<fieldMap>
<field name="phnumber">
<value xsi:type="xs:string"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xs="http://www.w3.org/2001/XMLSchema">101-123-7654</value>
</field>
</fieldMap>
</attr>
</attrList>

</attrListMap>
</genericRecord>


In this example, the four attributes that we are using to search have the following attrCodes: SSN, BIRTHDT, HOMEPHON, and LGLNAME. These will need to be adjusted to match the deployed configuration. The fields used within the fieldMaps may be changed to match the Attribute Types. If one of these attributes is an instance of an IDS (Implementation Defined Segment) then you need to match the field data type in the request with the field type in the segment definition.

[{"Product":{"code":"SSLVY3","label":"Initiate Master Data Service"},"Business Unit":{"code":"BU059","label":"IBM Software w\/o TPS"},"Component":"--","Platform":[{"code":"PF025","label":"Platform Independent"}],"Version":"Version Independent","Edition":"Edition Independent","Line of Business":{"code":"LOB10","label":"Data and AI"}}]

Product Synonym

MDS;Master Data Service;MDM;Master Data Management;IBM Infosphere Master Data Service;MDM Advanced Edition;MDM Hybrid Edition

Document Information

Modified date:
16 June 2018

UID

swg21652928