Versions Compared

Key

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

...

Table of Contents
maxLevel3
typeflat

...

Overview

The following operations allow you to carry out search operations. Click an operation name to see details on how to use it. 

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

OperationDescription

1Working with Search in EvernotecreateSearch

Makes a new SavedSearch in the account.

1Working with Search in EvernotegetSearch

Retrieves the state of a single SavedSearch .

1Working with Search in EvernoteupdateSearch

Changes an existing SavedSearch.

1Working with Search in EvernoteexpungeSearch

Permanently removes an existing SavedSearch .

Operation details

This section provides details on each of the operations.

Anchor
createSearch
createSearch
createSearch 

This is make a saved search with a set of information. 

Code Block
languagexml
titlecreateSearch
<evernote.createSearch>
	<searchName>{$ctx:searchName}</searchName>
	<query>{$ctx:query}</query>
	<includeAccount>{$ctx:includeAccount}</includeAccount>
	<includePersonalLinkedNotebooks>{$ctx:includePersonalLinkedNotebooks}</includePersonalLinkedNotebooks>
	<includeBusinessLinkedNotebooks>{$ctx:includeBusinessLinkedNotebooks}</includeBusinessLinkedNotebooks>
</evernote.createSearch> 
Properties
  • searchName :-Required. The name of the saved search to display in the GUI. The account may only contain one search with a given name

  • query :-Required. A string expressing the search to be performed

  • includeAccount :- Optional. The search should include notes from the account that contains the SavedSearch.

  • includePersonalLinkedNotebooks :-Optional. The search should include notes within those shared notebooks.that the user has joined that are NOT business notebooks.

  • includeBusinessLinkedNotebooks :-Optional. The search should include notes within those shared notebooks that the user has joined that are business notebooks in the business that the user is currently a member of. 

Anchor
request
request
Sample request

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

Code Block
languagexml
titleSample Request for createSearch
 <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
    <soapenv:Envelope xmlns:evr="wso2.connector.evernote">
        <soapenv:Header></soapenv:Header>
            <soapenv:Body>
            <root>
                <evr:devToken>S=s424:U=48524b0:E=14e531dc27f:C=146fb6c9600:P=1cd:A=en-devtoken:V=2:H=4a4e288787109ed314ebce861c5c2c92</evr:devToken>
                <evr:noteStoreUrl>https://www.evernote.com/shard/s424/notestore</evr:noteStoreUrl>
                <evr:devTokenType>SANDBOX</evr:devTokenType>
                <evr:searchName>searchName1</evr:searchName>
                <evr:query>query1</evr:query>
            </root>
        </soapenv:Body>
    </soapenv:Envelope>
</soapenv:Body>
</soapenv:Envelope>
Related Evernote documentation

Anchor
getSearch
getSearch
getSearch

Returns the current state of the search with the provided GUID. 

Code Block
languagexml
titlegetSearch
<evernote.getSearch>
	<searchGuid>{$ctx:searchGuid}</searchGuid>
</evernote.getSearch>  

 

Properties

searchGuid :- Required. The GUID of the search to be retrieved 

Anchor
getSearch
getSearch
Sample request

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

Code Block
languagexml
titleSample Request for getSearch
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
    <soapenv:Envelope xmlns:evr="wso2.connector.evernote">
        <soapenv:Header></soapenv:Header>
            <soapenv:Body>
            <root>
                <evr:devToken>S=s424:U=48524b0:E=14e531dc27f:C=146fb6c9600:P=1cd:A=en-devtoken:V=2:H=4a4e288787109ed314ebce861c5c2c92</evr:devToken>
                <evr:noteStoreUrl>https://www.evernote.com/shard/s424/notestore</evr:noteStoreUrl>
                <evr:devTokenType>SANDBOX</evr:devTokenType>
				<evr:searchGuid>100</evr:searchGuid>           
			</root>
        </soapenv:Body>
    </soapenv:Envelope>
</soapenv:Body>
</soapenv:Envelope>
Related Evernote documentation

Anchor
expungeSearch
expungeSearch
expungeSearch

Permanently deletes the saved search with the provided GUID. 

Code Block
languagexml
titleexpungeSearch
<evernote.expungeSearch>
	<searchGuid>{$ctx:searchGuid}</searchGuid>
</evernote.expungeSearch> 
Properties
  • searchGuid :- Required. The GUID of the search to delete. 
Sample request

Following is a sample REST request that can be handled by the expungeSearch operation.

Code Block
languagexml
titleSample Request for expungeSearch
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
    <soapenv:Envelope xmlns:evr="wso2.connector.evernote">
        <soapenv:Header></soapenv:Header>
            <soapenv:Body>
            <root>
                <evr:devToken>S=s424:U=48524b0:E=14e531dc27f:C=146fb6c9600:P=1cd:A=en-devtoken:V=2:H=4a4e288787109ed314ebce861c5c2c92</evr:devToken>
                <evr:noteStoreUrl>https://www.evernote.com/shard/s424/notestore</evr:noteStoreUrl>
                <evr:devTokenType>SANDBOX</evr:devTokenType>
				<evr:searchGuid>100</evr:searchGuid>            
			</root>
        </soapenv:Body>
    </soapenv:Envelope>
</soapenv:Body>
</soapenv:Envelope>
Related Evernote documentation

Anchor
updateSearch
updateSearch
updateSearch   

Submits search changes to the service. The provided data must include the search's guid field for identification. 

Code Block
languagexml
titleupdateSearch
<evernote.updateSearch>
	<searchGuid>{$ctx:searchGuid}</searchGuid>
	<searchName>{$ctx:searchName}</searchName>
	<query>{$ctx:query}</query>
	<includeAccount>{$ctx:includeAccount}</includeAccount>
	<includePersonalLinkedNotebooks>{$ctx:includePersonalLinkedNote books}</includePersonalLinkedNotebooks>
	<includeBusinessLinkedNotebooks>{$ctx:includeBusinessLinkedNotebooks}</includeBusinessLinkedNotebooks>
</evernote.updateSearch>  

 

Properties 
  • searchGuid :- Required. The unique identifier of this search. Will be set by the service

  • searchName :-Optional. The name of the saved search to display in the GUI

  • query :-Optional. A string expressing the search to be performed.

  • includeAccount :- Optional. The search should include notes from the account thatcontains the SavedSearch.

  • includePersonalLinkedNotebooks :-Optional. The search should include notes within those shared notebooks.that the user has joined that are NOT business notebooks.

  • includeBusinessLinkedNotebooks :-Optional. The search should include notes within those shared notebooks that the user has joined that are business notebooks in the business that the user is currently a member of. 

Sample request

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

Code Block
languagexml
titleSample Request for updateSearch
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
    <soapenv:Envelope xmlns:evr="wso2.connector.evernote">
        <soapenv:Header></soapenv:Header>
            <soapenv:Body>
            <root>
                <evr:devToken>S=s424:U=48524b0:E=14e531dc27f:C=146fb6c9600:P=1cd:A=en-devtoken:V=2:H=4a4e288787109ed314ebce861c5c2c92</evr:devToken>
                <evr:noteStoreUrl>https://www.evernote.com/shard/s424/notestore</evr:noteStoreUrl>
                <evr:devTokenType>SANDBOX</evr:devTokenType>
                <evr:searchName>searchTest</evr:searchName>
				<evr:searchGuid>100</evr:searchGuid>            
            </root>
        </soapenv:Body>
    </soapenv:Envelope>
</soapenv:Body>
</soapenv:Envelope>
Related Evernote documentation

Anchor
sample
sample
Sample configuration

Following is a sample proxy service that illustrates how to connect to Evernote with the init operation and use the getSearch operation.You can use this sample as a template for other operation.The sample request for this proxy can be found in Sample Request for getSearch

Code Block
languagexml
titleSample Proxy
<?xml version="1.0" encoding="UTF­8"?>
<proxy xmlns="http://ws.apache.org/ns/synapse"
name="getSearch"
transports="https,http"
statistics="disable"
trace="disable"
startOnLoad="true">
<target>
<inSequence>
<property xmlns:ns="wso2.connector.evernote" name="devToken" expression="//ns:devToken"/>
<property xmlns:ns="wso2.connector.evernote" name="devTokenType" expression="//ns:devTokenType"/>
<property xmlns:ns="wso2.connector.evernote" name="noteStoreUrl" expression="//ns:noteStoreUrl"/>
<property xmlns:ns="wso2.connector.evernote" name="searchGuid" expression="//ns:searchGuid"/>				          
	<evernote.init>
		<devToken>{$ctx:devToken}</devToken>
		<noteStoreUrl>{$ctx:noteStoreUrl}</noteStoreUrl>
		<devTokenType>{$ctx:devTokenType}</devTokenType>
	</evernote.init>
	<evernote.getSearch>
		<evr:searchGuid>{$ctx:searchGuid}</evr:searchGuid> 
	</evernote.getSearch>
<respond/>
</inSequence>
<outSequence>
<send/>
</outSequence>
</target>
<description/>
</proxy>