Versions Compared

Key

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

...

Code Block
languagexml
titlegetCurrentUser
<eloqua<eloquaStandardAPI.getCurrentUser>
    <depth>Complete</depth>
    <extensions></extensions>
</eloquaeloquaStandardAPI.getCurrentUser>
properties

...

Code Block
languagexml
titlegetAllUsers
<eloqua<eloquaStandardAPI.getAllUsers>
    <count>2</count>
    <depth>1</depth>
    <search></search>
    <page>1</page>
    <orderBy></orderBy>
    <lastUpdatedAt>1426066807</lastUpdatedAt>
    <extensions></extensions>
</eloquaeloquaStandardAPI.getAllUsers>
properties
  • count         : The number of results in a page to display. This must me in between 1 and 1000.

  • depth         : The RequestDepth. It can be 'Complete' or 'Reference' or 'Minimal' or 'Partial'.

  • search        : The search field, to search for that field.

  • page          : The page number to display. This must be greater than 1.

  • orderBy       : The order by property to order the fields.

  • lastUpdatedAt : The date time of the last update.

  • extensions    : The extensions to filter. Must follow the pattern : ^[A-Za-z0-9]+$.

...

Code Block
languagexml
titlegetAUser
<eloqua<eloquaStandardAPI.getAUser>
	<userId>10</userId>
	<depth>Complete</depth>
    <extensions></extensions>
</eloquaeloquaStandardAPI.getAUser>
properties
  • userId     : Unique identifier of the user.

  • depth      : The RequestDepth. It can be 'Complete' or 'Reference' or 'Minimal' or 'Partial'.

  • extensions : The extensions to filter. Must follow the pattern : ^[A-Za-z0-9]+$.

...

Code Block
languagexml
titleupdateAUser
<eloqua<eloquaStandardAPI.updateAUser>
	<name>new user</name>
	<userId>10</userId>
	<loginName>iamcool</loginName>
	<company>my company</company>
	<emailAddress>iamcoolmail@gmail.com</emailAddress>
	<preferences>{"type": "UserPreferences","isMasterViewDocked": "false","timezoneId": "64"}</preferences>
	<typePermissions>[{"type": "TypePermission","objectType": "Campaign","permissions": {"type": "TypePermissions","create": "true","read": "true"}},{"type": "TypePermission","objectType": "Email","permissions": {"type": "TypePermissions","create": "true","read": "true"}}]</typePermissions>
	<capabilities>["manageStrictWebTracking", "mailer.updateContacts"]</capabilities>
	<betaAccess>["chatter_inside", "sfdc_sso", "sfdcidp"]</betaAccess>
	<loggedInAt>1297278692</loggedInAt>
	<defaultContactViewId>1</defaultContactViewId>
	<defaultAccountViewId>1</defaultAccountViewId>
	<interfacePermissions>[{"type": "InterfacePermission","interfaceCode": "campaigns","nestedInterfacePermissions":[{"type": "InterfacePermission","interfaceCode": "campaigns","nestedInterfacePermissions":[{"type": "InterfacePermission","interfaceCode": "campaigns"}]}]}]</interfacePermissions>
	<productPermissions>[{"type": "ProductPermission","productCode": "EngageiPad"},{"type": "ProductPermission","productCode": "EngageWeb"}]</productPermissions>
</eloquaeloquaStandardAPI.updateAUser>
properties
  • userId               : Unique identifier of the user.

  • name                 : The name of the user to update the name as it is.

  • loginName            : Username of the user to log in.

  • company              : Company name of the user.

  • emailAddress         : Email address of the user.

  • loggedInAt           : Integer value, this indicates where the user logged in.

  • preferences          : User preferences object, this will contain timezoneId and isMasterViewDocked properties.

  • typePermissions      : List of type permission objects.

  • capabilities         : List of string values.

  • betaAccess            : List of string values.

  • defaultContactViewId : The default view id of Contacts.

  • defaultAccountViewId : The default view id of Accounts.

  • interfacePermissions : List of interfacePermission objects.

  • productPermissions   : List of productPermission objects.

...

Code Block
languagexml
titleSample proxy
<proxy xmlns="http://ws.apache.org/ns/synapse"
       name="eloqua_getAllUsers"
       transports="https,http"
       statistics="disable"
       trace="disable"
       startOnLoad="true">
    <target>
        <inSequence>
            <property name="siteName" expression="json-eval($.siteName)"/>
            <property name="username" expression="json-eval($.username)"/>
            <property name="password" expression="json-eval($.password)"/>
            <property name="count" expression="json-eval($.count)"/>
            <property name="depth" expression="json-eval($.depth)"/>
            <property name="search" expression="json-eval($.search)"/>
            <property name="page" expression="json-eval($.page)"/>
            <property name="orderBy" expression="json-eval($.orderBy)"/>
            <property name="lastUpdatedAt" expression="json-eval($.lastUpdatedAt)"/>
            <property name="extensions" expression="json-eval($.extensions)"/>
            <eloqua<eloquaStandardAPI.init>
                <siteName>{$ctx:siteName}</siteName>
                <username>{$ctx:username}</username>
                <password>{$ctx:password}</password>
            </eloquaeloquaStandardAPI.init>
            <eloqua<eloquaStandardAPI.getAllUsers>
                <count>{$ctx:count}</count>
                <depth>{$ctx:depth}</depth>
                <search>{$ctx:search}</search>
                <page>{$ctx:page}</page>
                <orderBy>{$ctx:orderBy}</orderBy>
                <lastUpdatedAt>{$ctx:lastUpdatedAt}</lastUpdatedAt>
                <extensions>{$ctx:extensions}</extensions>
            </eloquaeloquaStandardAPI.getAllUsers>
            <respond/>
        </inSequence>
        <outSequence/>
        <faultSequence/>
    </target>
    <description/>
</proxy>