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 notebook operations. Click an operation name to see details on how to use it. 

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

OperationDescription

1Working with NoteBook in EvernotecreateNotebook

Makes a new Notebook in the account.

1Working with NoteBook in EvernotecreateSharedNotebook

Used to construct a shared notebook object.

1Working with NoteBook in EvernoteexpungeNotebook

Permanently removes an existing Notebook.

1Working with NoteBook in EvernotegetNotebook

Retrieves the state of a single Notebook.

1Working with NoteBook in EvernotelistNotebooks

Returns a list of all of the Notebooks in the account.

1Working with NoteBook in EvernoteupdateNotebook

Changes an existing Notebook.

1Working with NoteBook in EvernoteupdateSharedNotebook

Update a SharedNotebook object.

Operation details

This section provides details on each of the operations.

Anchor
createNotebook
createNotebook
Create a Notebook 

The createNotebook  method allows you to create a new notebook. 

Code Block
languagexml
titlecreateNotebook
<evernote.createNotebook>
	<notebookName>{$ctx:notebookName}<notebookName>
	<defaultNotebook>{$ctx:defaultNotebook}</defaultNotebook>
</evernote.createNotebook>  
Properties
  • notebookName : required. The name of the notebook must be set.

  • defaultNotebook : Optional.If true,this notebook should be used for new notes  whenever the user has not (or cannot) specify a desired target notebook. 

Anchor
request
request
Sample request

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

Code Block
languagexml
titleSample Request for createNotebook
<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:notebookName>testNoteBook</evr:notebookName>
            </root>
        </soapenv:Body>
    </soapenv:Envelope>
</soapenv:Body>
</soapenv:Envelope>
Related Evernote documentation

Anchor
createSharedNotebook
createSharedNotebook
creating a SharedNotebook

Used to construct a shared notebook object. The constructed notebook will contain a "share key" which serve as a unique identifier and access token for a user to access the notebook of the shared notebook owner. 

Code Block
languagexml
titlecreateSharedNotebook
<evernote.createSharedNotebook>
	<notebookGuid>{$ctx:notebookGuid}</notebookGuid>
	<email>{$ctx:email}</email>
</evernote.createSharedNotebook>  
Properties
  • notebookGuid :- Required. Sever return the guid of the notebook when we create a notebook. use the guid for share the notebook.

  • mail:-Required. email address of the share recipient.

Sample request

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

Code Block
languagexml
titleSample Request for createSharedNotebook
<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:notebookGuid>1@1</evr:notebookGuid>
                <evr:email>elilsiva3@gmail.com</evr:email>
            </root>
        </soapenv:Body>
    </soapenv:Envelope>
</soapenv:Body>
</soapenv:Envelope>
Related Evernote documentation

Anchor
expungeNotebook
expungeNotebook
expungeNotebook

Permanently removes the notebook from the user's account. After this action, the notebook is no longer available for undeletion  

Code Block
languagexml
titleexpungeNotebook
<evernote.expungeNotebook>
	<notebookGuid>{$ctx:notebookGuid}</notebookGuid>
</evernote.expungeNotebook> 
Properties
  • notebookGuid :- Required. Sever return the guid of the notebook when we create a notebook. use that guid for expunge the notebook. 

Sample request

Following is a sample request that can be handled by the expung e Notebook operation.

Code Block
languagexml
titleSample Request for expungeNotebook
<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:notebookGuid>1@1</evr:notebookGuid>
            </root>
        </soapenv:Body>
    </soapenv:Envelope>
</soapenv:Body>
</soapenv:Envelope>
Related Evernote documentation

Anchor
getNotebook
getNotebook
Get NoteBook

Returns the current state of the notebook with the provided GUID. The notebook may be active or deleted (but not expunged).  

Code Block
languagexml
titlegetNotebook
<evernote.getNotebook>
	<noteGuid>{$ctx:noteGuid}</noteGuid>
</evernote.getNotebook> 
Properties
  • noteGuid :Required. The GUID of  the notebook

Anchor
getNoteBook
getNoteBook
Sample request

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

Code Block
languagexml
titleSample Request for getNotebook
<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:notebookGuid>1@1</evr:notebookGuid>
            </root>
        </soapenv:Body>
    </soapenv:Envelope>
</soapenv:Body>
</soapenv:Envelope>
Related Evernote documentation

Anchor
listNotebooks
listNotebooks
listNotebooks

Returns a list of all of the notebooks in the account 

Code Block
languagexml
titlelistNotebooks
<evernote.listNotebooks/>
Sample request

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

Code Block
languagexml
titleSample Request for listNotebooks
<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>
            </root>
        </soapenv:Body>
    </soapenv:Envelope>
</soapenv:Body>
</soapenv:Envelope>
Related Evernote documentation

Anchor
updateNotebook
updateNotebook
updateNotebook   

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

Code Block
languagexml
titleupdateNotebook
<evernote.updateNotebook>
	<notebookGuid>{$ctx:notebookGuid}</notebookGuid>
	<newname>{$ctx:newname}</newname>
	<defaultNotebook>{$ctx:defaultNotebook}</defaultNotebook>
</evernote.updateNotebook> 
Properties
  • notebookGuid :- Required. Sever return the guid of the notebook when we create a notebook. use that guid for update the notebook.

  • newname :-Required. Optional. To update the notebook name .

  • defaultNotebook Required. If true, this notebook should be used for new notes whenever the user has not (or cannot) specify a desired target notebook. 

Sample request

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

Code Block
languagexml
titleSample Request for updateNotebook
<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:notebookGuid>1@1</evr:notebookGuid>
				<evr:notebookName>notebookNameUpdated</evr:notebookName>
                <evr:defaultNotebook>false</evr:defaultNotebook>          
			</root>
        </soapenv:Body>
    </soapenv:Envelope>
</soapenv:Body>
</soapenv:Envelope>
Related Evernote documentation

Anchor
updateSharedNotebook
updateSharedNotebook
updateSharedNotebook

The updateSharedNotebook operation is used to update a SharedNotebook object.

Code Block
languagexml
titleupdateSharedNotebook
<evernote.updateSharedNotebook>
	<id>{$ctx:id}</id>
	<email>{$ctx:email}</email>
	<allowPreview>{$ctx:allowPreview}</allowPreview>
</evernote.updateSharedNotebook> 

 

Properties
  • id :-Required. Sever return the sharekey of the notebook after create a shared Notebook. use this sharekey to update the shared notenook.

  • email :-Required. To update the notebook name.

  • allowPreview : -Required. Shared notebook can be modified to require login. See "allowPreview" for information on privileges and shared notebooks. 

Sample request

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

Code Block
languagexml
titleSample Request for updateSharedNotebook
<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:id>121</evr:id>
                <evr:email>elilsiva3@gmail.com</evr:email>
                <evr:allowPreview>true</evr:allowPreview>        
			</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 getNoteBook 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 getNoteBook

Code Block
languagexml
titleSample Proxy
<?xml version="1.0" encoding="UTF­8"?>
<proxy xmlns="http://ws.apache.org/ns/synapse"
name="getNoteBook"
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="notebookGuid" expression="//ns:notebookGuid"/>
<property xmlns:ns="wso2.connector.evernote" name="noteStoreUrl" expression="//ns:noteStoreUrl"/>
<evernote.init>
	<devToken>{$ctx:devToken}</devToken>
	<noteStoreUrl>{$ctx:noteStoreUrl}</noteStoreUrl>
	<devTokenType>{$ctx:devTokenType}</devTokenType>
</evernote.init>
<evernote.getNoteBook>
	<notebookGuid>{$ctx:notebookGuid}</notebookGuid>
</evernote.getNoteBook>
<respond/>
</inSequence>
<outSequence>
<send/>
</outSequence>
</target>
<description/>
</proxy> 

...