Versions Compared

Old Version 1

changes.mady.by.user Former user

Saved on

compared with

New Version Current

changes.mady.by.user Former user

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Table of Contents
maxLevel3
typeflat

...

Overview

The following operations allow you to work with "fetch". Click an operation name to see details on how to use it.

For a sample proxy service that illustrates how to work with "fetch", see Sample configuration.

OperationDescription

1Working with Fetch in Zuora SOAPgetUserInfo

Use to retrieve information about the user.

1Working with Fetch in Zuora SOAPqueryUse to retrieve a list of one or more zobjects.
1Working with Fetch in Zuora SOAPqueryMoreUse to request additional results from a previous query call.

Operation details

This section provides details on the operations.

Anchor
getUserInfo
getUserInfo
Getting the user information

The getUserInfo operation is used to retrieve information about the user.

...

Code Block
languagexml
titlegetUserInfo
<zuorasoap.getUserInfo/>
Anchor
request
request
Sample request

Following is a sample SOAP request that can be handled by the getUserInfo operation.

Code Block
languagexml
titleSample Request for getUserInfo
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="wso2.connector.zuora">
  <soapenv:Header/>
   <soapenv:Body>
      <urn:apiUrl>https://apisandbox.zuora.com/apps/services/a/74.0</urn:apiUrl>
      <urn:username>zuora@wso2.com</urn:username>
      <urn:password>Zuora#123</urn:password>
   </soapenv:Body>
</soapenv:Envelope>

Anchor
query
query
Querying records

The query operation can be used to retrieve a list of one or more zobjects by providing the queryString.

Code Block
languagexml
titlequery
<zuorasoap.query>
    <queryString>{$ctx:queryString}</queryString>
	<batchSize>{$ctx:batchSize}</batchSize>
</zuorasoap.query>
Properties

  • queryString: The query expression by specifying the object to query.

  • batchSize: The batch size of the query result.
  • caseSensitive: Indicates if the query filter results returned consider case-sensitivity.
Sample request

Following is a sample SOAP request that can be handled by the query operation.

Code Block
languagexml
titleSample Request for query
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="wso2.connector.zuora">
  <soapenv:Header/>
   <soapenv:Body>
      <urn:apiUrl>https://apisandbox.zuora.com/apps/services/a/74.0</urn:apiUrl>
      <urn:username>zuora@wso2.com</urn:username>
      <urn:password>Zuora#123</urn:password>
      <urn:queryString>Select Id From Account</urn:queryString>
      <urn:batchSize>200</urn:batchSize>
   </soapenv:Body>
</soapenv:Envelope>
Related Zuora documentation

https://knowledgecenter.zuora.com/DC_Developers/SOAP_API/E_SOAP_API_Calls/query_call

Anchor
queryMore
queryMore
 Querying more records

The queryMore operation can be used to request additional results from a previous query call by providing the queryLocator.

Code Block
languagexml
titlequeryMore
 <zuorasoap.query>
    <queryString>{$ctx:queryString}</queryString>
	<batchSize>{$ctx:batchSize}</batchSize>
</zuorasoap.query>
<iterate xmlns:zuora="http://wso2.org/zuorasoap/adaptor"
	continueParent="true"
    expression="//zuora:iterator">
    <target>
    	<sequence>
        	<zuorasoap.queryMore>
            	<batchSize>{$ctx:batchSize}</batchSize>
            </zuorasoap.queryMore>
        </sequence>
    </target>
</iterate>
Properties
  • batchSize: The batch size of the query result.
Anchor
sampleReq
sampleReq

Following is a sample SOAP request that can be handled by the queryMore operation.

Code Block
languagexml
titleSample Request for queryMore
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="wso2.connector.zuora">
  <soapenv:Header/>
   <soapenv:Body>
      <urn:apiUrl>https://apisandbox.zuora.com/apps/services/a/74.0</urn:apiUrl>
      <urn:username>zuora@wso2.com</urn:username>
      <urn:password>Zuora#123</urn:password>
      <urn:queryString>Select Id From Account</urn:queryString>
      <urn:batchSize>200</urn:batchSize>
   </soapenv:Body>
</soapenv:Envelope>
Related Zuora documentation

https://knowledgecenter.zuora.com/DC_Developers/SOAP_API/E_SOAP_API_Calls/queryMore_call

Anchor
sample
sample

Sample configuration

Following is a sample proxy service that illustrates how to connect to Zuora with the init operation and use the queryMore operation. The sample request for this proxy can be found in  queryMore sample request. You can use this sample as a template for using other operations in this category.

...