Kumar A. ADempiere 3.6 Cookbook

Web services

168

7. Go to the Business Partner window in ADempiere and verify that the details of the

newly created business partner appear in it.

Conguring a Web service to read a record

Now let us look at how to congure a Web service to read the newly created business partner

using the generic API—readData.

How to do it...

1. Log in to ADempiere using GardenUser/GardenUser with the GardenWorld

User role.

2. Go to the Web Service Security window.

3. Click on the New Record and enter the following, as shown in the next screenshot:

 Search Key: ReadBPartner (choose your text)

 Name: Read BPartner (choose your text)

 Web Service: Model Oriented Web Services

 Web Service Method: Read Data_Model Oriented Web Services

 Table: C_BPartner_Business Partner

Chapter 4

169

 Description: <your description of service>

 Comment/Help: <your text>

4. Go to the Web Service Parameter tab and create the following parameters, as shown

in the next screenshot:

 TableName: Set this to C_BPartner

 RecordID: The value for this will be passed from the Web service

request. You may get the RecordID from the response of the

CreateData service response, as shown in the previous recipe

 Action: Set this to Read

Web services

170

5. Go to the Web Service Field Output tab and create the following parameters as

shown in the following screenshot:

 Name_Name

 Name2_Name 2

6. Go to the soapUI client and run the following SOAP request:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/

envelope/" xmlns:adin="http://3e.pl/ADInterface">

<soapenv:Header/>

<soapenv:Body>

<adin:readData>

<adin:ModelCRUDRequest>

<adin:ModelCRUD>

<adin:serviceType>ReadBPartner</adin:serviceType>

<adin:TableName>C_BPartner</adin:TableName>

<adin:RecordID>1000002</adin:RecordID>

<adin:Action>Read</adin:Action>

</adin:ModelCRUD>

<adin:ADLoginRequest>

<adin:user>GardenUser</adin:user>

<adin:pass>GardenUser</adin:pass>

<adin:lang>192</adin:lang>

<adin:ClientID>11</adin:ClientID>

<adin:RoleID>103</adin:RoleID>

<adin:OrgID>11</adin:OrgID>

<adin:WarehouseID>103</adin:WarehouseID>

<adin:stage>0</adin:stage>

</adin:ADLoginRequest>

Chapter 4

171

</adin:ModelCRUDRequest>

</adin:readData>

</soapenv:Body>

</soapenv:Envelope>

In the preceding request, 1000002 is the RecordID returned as part of the

CreateBPartner service calls.

The following shall be the response showing the record detail:

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/

envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema"

xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">

<soap:Body>

<ns1:readDataResponse xmlns:ns1="http://3e.pl/ADInterface">

<WindowTabData NumRows="1" TotalRows="1" StartRow="1"

xmlns="http://3e.pl/ADInterface">

<val>Ajit Kumar</val>

</field>

<val>Walking Tree</val>

</field>

</DataRow>

</DataSet>

</WindowTabData>

</ns1:readDataResponse>

</soap:Body>

</soap:Envelope>

Conguring a Web service to read a list

of records

There may be instances where you may have to provide an API to return a list of records, for

example, list of purchase orders, list of products, list of business partners, and so on. In this

recipe, we will see how we can congure a Web service to return a list of records, say business

partners, using the generic API, queryData.

Web services

172

How to do it...

1. Log in to ADempiere using GardenUser/GardenUser with the GardenWorld

User role.

2. Go to the Web Service Security window.

3. Click on the New Record and enter the following, as shown in the next screenshot:

 Search Key: QueryBPartner (choose your text)

 Name: Query BPartner (choose your text)

 Web Service: Model Oriented Web Services

 Web Service Method: Query Data_Model Oriented Web Services

 Table: C_BPartner_Business Partner

 Description: <your description of service>

 Comment/Help: <your text>

4. Go to the Web Service Parameter tab and create the following parameters, as shown

in the following screenshot:

 TableName: Set this to C_BPartner

 RecordID: The value for this will be passed from the Web

service request

 Action: Set this to Read

Chapter 4

173

5. Go to the Web Service Field Input tab and enter the following Columns, as shown in

the following screenshot:

 Name_Name

6. Go to the Web Service Field Output tab and create the following parameters,

as shown in the following screenshot:

 Name_Name

 Name2_Name 2

 C_BP_Group_ID_Business Partner Group

Web services

174

7. Go to the soapUI client and run the following SOAP request:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/

envelope/" xmlns:adin="http://3e.pl/ADInterface">

<soapenv:Header/>

<soapenv:Body>

<adin:queryData>

<adin:ModelCRUDRequest>

<adin:ModelCRUD>

<adin:serviceType>QueryBPartner</adin:serviceType>

<adin:TableName>C_BPartner</adin:TableName>

<adin:RecordID>0</adin:RecordID>

<adin:Action>Read</adin:Action>

<adin:DataRow>

<adin:field column="Name">

<adin:val>Ajit Kumar</adin:val>

</adin:field>

</adin:DataRow>

</adin:ModelCRUD>

<adin:ADLoginRequest>

<adin:user>GardenUser</adin:user>

<adin:pass>GardenUser</adin:pass>

<adin:lang>192</adin:lang>

<adin:ClientID>11</adin:ClientID>

<adin:RoleID>103</adin:RoleID>

<adin:OrgID>11</adin:OrgID>

<adin:WarehouseID>103</adin:WarehouseID>

<adin:stage>0</adin:stage>

</adin:ADLoginRequest>

</adin:ModelCRUDRequest>

</adin:queryData>

</soapenv:Body>

</soapenv:Envelope>

The following is the response you shall receive, showing you the records of whose name

matches with the passed name:

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/

envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema"

xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">

<soap:Body>

<ns1:queryDataResponse xmlns:ns1="http://3e.pl/ADInterface">

<WindowTabData NumRows="2" TotalRows="2" StartRow="1"

xmlns="http://3e.pl/ADInterface">

Chapter 4

175

</field>

<val>Ajit Kumar</val>

</field>

<val>Walking Tree</val>

</DataRow>

</DataSet>

</field>

<val>Ajit Kumar</val>

</field>

</field>

</DataRow>

</DataSet>

</WindowTabData>

</ns1:queryDataResponse>

</soap:Body>

</soap:Envelope>

There's more...

There is another generic API, getList, which can be used to read a list of records using the

table reference.

Reading a list of records using getList

The getList API requires a table reference, which can be found from the ad_reference

table. For example, for the business partner table, the reference ID is 138. Now, congure a

Web service by following these steps:

1. Log in as GardeUser/GardenUser with the GardenWorld User role.

2. Open the Web Service Security window and click on New Record.

Down l o a d f r o m Wow ! e B o o k < www. w o w e b o o k . com>

Web services

176

3. Enter the following on the Web Service Type tab:

4. Enter the following on the Web Service Parameters tab:

5. Enter the following on the Web Service Field Output tab:

6. Run the following SOAP request in soapUI:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/

envelope/" xmlns:adin="http://3e.pl/ADInterface">

<soapenv:Header/>

<soapenv:Body>

Chapter 4

177

<adin:getList>

<adin:ModelGetListRequest>

<adin:ModelGetList>

<adin:serviceType>GetBPartnerList</

adin:serviceType>

<adin:AD_Reference_ID>138</adin:AD_Reference_ID>

</adin:ModelGetList>

<adin:ADLoginRequest>

<adin:user>GardenUser</adin:user>

<adin:pass>GardenUser</adin:pass>

<adin:lang>192</adin:lang>

<adin:ClientID>11</adin:ClientID>

<adin:RoleID>103</adin:RoleID>

<adin:OrgID>11</adin:OrgID>

<adin:WarehouseID>103</adin:WarehouseID>

<adin:stage>0</adin:stage>

</adin:ADLoginRequest>

</adin:ModelGetListRequest>

</adin:getList>

</soapenv:Body>

</soapenv:Envelope>

7. Verify that the response shows the records list.

Conguring a Web service to update

a record

This recipe describes the steps required to congure a Web service to update a record in a

table using the generic API, updateData.

How to do it...

1. Log in to ADempiere using GardenUser/GardenUser with the GardenWorld

User role.

2. Go to the Web Service Security window.

3. Click on the New Record and enter the following, as shown in the next screenshot:

 Search Key: UpdateBPartner (choose your text)

 Name: Update BPartner (choose your text)

 Web Service: Model Oriented Web Services

 Web Service Method: Update Data_Model Oriented Web Services

 Table: C_BPartner_Business Partner

Kumar A. ADempiere 3.6 Cookbook

Подождите немного. Документ загружается.