%VOSWARNING%


---++Addressbook OAuth REST API Example performed with the Virtuoso OAuth Testing Tool

The following example demonstrates creating and getting contact info by the ODS REST APIs *addressbook.new* and *addressbook.get* using the OAuth Test Tool. Full list of the ODS REST APIs for ODS Addressbook you can find [[VirtuosoOdsControllersAddressbook][here]].

   1. Go to http://demo.openlinksw.com/ods
   1. Log in as user demo with password demo
   1. Go to Settings->OAuth Keys
      * <img src="%ATTACHURLPATH%/o1.png" style="wikiautogen"/>
   1. Copy the Token value for an Addressbook instance or create such in not existing. For ex.: e0a49e54603740f67f8b8f3f58651ad772dc9b44
   1. Go to http://demo.openlinksw.com/ods/oauth_test.vsp
   1. In the shown form enter for:
      1. *Server*: http://demo.openlinksw.com/ods/api
      1. *Consumer Key*: e0a49e54603740f67f8b8f3f58651ad772dc9b44
      1. *API method*: addressbook.new
      1. *API parameters*: inst_id=36&name=TEST
         * An easy way to get the instance id is using the [[VirtuosoOdsUbiquity][ODS ubiquity commands]] sequence:
<verbatim>
ods-host http://demo.openlinksw.com/ods
ods-set-mode sid
ods-authenticate-user demo password demo
ods-get-instance-id demo's AddressBook
</verbatim>
      1. Select for *Query options*: "Generate URI and Submit".
      * <img src="%ATTACHURLPATH%/oa1.png" style="wikiautogen"/>
   1. Click the "Execute" button.
   1. In the shown authorization form click the "Authorize" button.
      * <img src="%ATTACHURLPATH%/oa2.png" style="wikiautogen"/>
   1. As result will be shown the generated URI and the output message of executing the ODS REST API. In our case, the id of the new created contact will be: 1046
      * <img src="%ATTACHURLPATH%/oa3.png" style="wikiautogen"/>
   1. Now lets get the data for the created contact. In the form enter:
      1. *API method*: addressbook.get
      1. *API parameters*: contact_id=1046
      1. Select for *Query options*: "Generate URI and Submit".
   1. Click the "Execute" button.
   1. As result in the "Response Body" text-area will be shown the retrieved details for the contact with the given above id.
      * <img src="%ATTACHURLPATH%/oa4.png" style="wikiautogen"/>  

CategoryAddressBook CategoryODS