This site contains the documentation that is relevant to older WSO2 product versions and offerings.
For the latest WSO2 documentation, visit https://wso2.com/documentation/.

Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

Version 1 Current »

Overview

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

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

OperationDescription
1Working with Email Groups in EloquaRetrieves all email groups that match the criteria specified in the parameters..
1Working with Email Groups in EloquaRetrieves the email group with the specified id.

Operation Details

This section provides further details on the operations related to email groups.

Get Email Groups

The getEmailGroups operation retrieves all email groups that match the specified criteria.

getEmailGroups
<eloqua.getEmailGroups>
    <limit>{$ctx:limit}</limit>
    <offset>{$ctx:offset}</offset>
    <orderBy>{$ctx:orderBy}</orderBy>
    <q>{$ctx:q}</q>
	<totalResults>{$ctx:totalResults}</totalResults>
</eloqua.getEmailGroups>
properties

  • limit: Specifies maximum number of records to return.

  • offset : Specifies an offset that allows to retrieve the next batch of records.

  • orderBy : Term to order the results by..

  • q : Specifies query criteria used to filter resultl.

  • totalResults: The total number of records that satisfy the request.
Sample request

Following is a sample REST/JSON request that can be handled by the getEmailGroups operation.

Sample request for getEmailGroups
{
    "refreshToken":"MTYXXXXU5MDoxc2FtZGNnazJWay03SYWhYflNJTlkxY2VtQ2M1RDFrVmpifjlXaEJFV35Ddk9qelplQXXXXXXVNoT25D",
    "redirectUri":"https://esbconnectors.blogspot.com",
    "clientId":"1dxxx80-3848-4a3f-a225-6s92fexxxa8",
    "clientSecret":"1K-yOHxxxgHr-Dm5saaskn0wsOj3eouQnbzXXXVT~NXXhdkldszB-dRad9TxHzcxxxFiiSSLtuL8zBZeXZ",
    "apiVersion":"2.0",
    "scope":"full",
    "totalResults":"true",
    "q":"name='Email*'",
    "orderBy":"name DESC",
    "offset":"0",
    "limit":"10"   
}
Related Eloqua documentation

http://docs.oracle.com/cloud/latest/marketingcs_gs/OMCBB/Content/D_Reference/endpoints/emailGroups/get.htm

Get Email Group By Id

The getEmailGroupById operation retrieves the email group with the specified id..

getEmailGroupById
<eloqua.getEmailGroupById>
	<emailGroupId>{$ctx:emailGroupId}</emailGroupId>
</eloqua.getEmailGroupById>
properties

  • emailGroupId: The id of the email group.

Sample Request

Following is a sample REST/JSON request that can be handled by the getEmailGroupById operation.

Sample request for getEmailGroupById
{
    "refreshToken":"MTYXXXXU5MDoxc2FtZGNnazJWay03SYWhYflNJTlkxY2VtQ2M1RDFrVmpifjlXaEJFV35Ddk9qelplQXXXXXXVNoT25D",
    "redirectUri":"https://esbconnectors.blogspot.com",
    "clientId":"1dxxx80-3848-4a3f-a225-6s92fexxxa8",
    "clientSecret":"1K-yOHxxxgHr-Dm5saaskn0wsOj3eouQnbzXXXVT~NXXhdkldszB-dRad9TxHzcxxxFiiSSLtuL8zBZeXZ",
    "apiVersion":"2.0",
    "scope":"full",
	"emailGroupId":"1"  
}
Related Eloqua documentation

http://docs.oracle.com/cloud/latest/marketingcs_gs/OMCBB/Content/D_Reference/endpoints/emailGroups/get-id.htm

Sample Configuration

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

Sample proxy
<?xml version="1.0" encoding="UTF-8"?>
<proxy xmlns="http://ws.apache.org/ns/synapse"
       name="getEmailGroups"
       transports="https http"
       startOnLoad="true"
       trace="disable">
   <description/>
   <target>
      <inSequence>
         <property name="refreshToken" expression="json-eval($.refreshToken)"/>
         <property name="scope" expression="json-eval($.scope)"/>
         <property name="redirectUri" expression="json-eval($.redirectUri)"/>
         <property name="clientId" expression="json-eval($.clientId)"/>
         <property name="apiVersion" expression="json-eval($.apiVersion)"/>
         <property name="clientSecret" expression="json-eval($.clientSecret)"/>
         <property name="limit" expression="json-eval($.limit)"/>
         <property name="offset" expression="json-eval($.offset)"/>
         <property name="orderBy" expression="json-eval($.orderBy)"/>
         <property name="q" expression="json-eval($.q)"/>
         <property name="totalResults" expression="json-eval($.totalResults)"/>
         <eloqua.getAccessTokenFromRefreshToken>
            <refreshToken>{$ctx:refreshToken}</refreshToken>
            <scope>{$ctx:scope}</scope>
            <redirectUri>{$ctx:redirectUri}</redirectUri>
            <clientId>{$ctx:clientId}</clientId>
            <clientSecret>{$ctx:clientSecret}</clientSecret>
            <apiVersion>{$ctx:apiVersion}</apiVersion>
         </eloqua.getAccessTokenFromRefreshToken>
         <eloqua.getEmailGroups>
            <limit>{$ctx:limit}</limit>
            <offset>{$ctx:offset}</offset>
            <orderBy>{$ctx:orderBy}</orderBy>
            <q>{$ctx:q}</q>
            <totalResults>{$ctx:totalResults}</totalResults>
         </eloqua.getEmailGroups>
         <respond/>
      </inSequence>
      <outSequence/>
      <faultSequence/>
   </target>
</proxy>
  • No labels