ODS.VirtuosoOdsControllersAddressbook

Addressbook Controllers

Controller Demo LinksSort in ascending order Description

addressbook.get (
  contact_id integer )
  *  cURL Example Get contact details

addressbook.new (
  inst_id integer,
  name varchar,
  category_id integer := null,
  kind integer := 0,
  title varchar := null,
  fName varchar := null,
  mName varchar := null,
  lName varchar := null,
  fullName varchar := null,
  gender varchar := null,
  birthday datetime := null,
  iri varchar := null,
  foaf varchar := null,
  mail varchar := null,
  web varchar := null,
  icq varchar := null,
  skype varchar := null,
  aim varchar := null,
  yahoo varchar := null,
  msn varchar := null,
  hCountry varchar := null,
  hState varchar := null,
  hCity varchar := null,
  hCode varchar := null,
  hAddress1 varchar := null,
  hAddress2 varchar := null,
  hTzone varchar := null,
  hLat real := null,
  hLng real := null,
  hPhone varchar := null,
  hMobile varchar := null,
  hFax varchar := null,
  hMail varchar := null,
  hWeb varchar := null,
  bCountry varchar := null,
  bState varchar := null,
  bCity varchar := null,
  bCode varchar := null,
  bAddress1 varchar := null,
  bAddress2 varchar := null,
  bTzone varchar := null,
  bLat real := null,
  bLng real := null,
  bPhone varchar := null,
  bMobile varchar := null,
  bFax varchar := null,
  bIndustry varchar := null,
  bOrganization varchar := null,
  bDepartment varchar := null,
  bJob varchar := null,
  bMail varchar := null,
  bWeb varchar := null,
  tags varchar := null )
  *  cURL Example Create new contact

addressbook.edit (
  contact_id integer,
  name varchar,
  category_id integer := null,
  kind integer := 0,
  title varchar := null,
  fName varchar := null,
  mName varchar := null,
  lName varchar := null,
  fullName varchar := null,
  gender varchar := null,
  birthday datetime := null,
  iri varchar := null,
  foaf varchar := null,
  mail varchar := null,
  web varchar := null,
  icq varchar := null,
  skype varchar := null,
  aim varchar := null,
  yahoo varchar := null,
  msn varchar := null,
  hCountry varchar := null,
  hState varchar := null,
  hCity varchar := null,
  hCode varchar := null,
  hAddress1 varchar := null,
  hAddress2 varchar := null,
  hTzone varchar := null,
  hLat real := null,
  hLng real := null,
  hPhone varchar := null,
  hMobile varchar := null,
  hFax varchar := null,
  hMail varchar := null,
  hWeb varchar := null,
  bCountry varchar := null,
  bState varchar := null,
  bCity varchar := null,
  bCode varchar := null,
  bAddress1 varchar := null,
  bAddress2 varchar := null,
  bTzone varchar := null,
  bLat real := null,
  bLng real := null,
  bPhone varchar := null,
  bMobile varchar := null,
  bFax varchar := null,
  bIndustry varchar := null,
  bOrganization varchar := null,
  bDepartment varchar := null,
  bJob varchar := null,
  bMail varchar := null,
  bWeb varchar := null,
  tags varchar := null )
  *  cURL Example Edit contact details

addressbook.delete (
  contact_id integer )
  *  cURL Example Delete contact

addressbook.import (
  inst_id integer,
  source varchar,
  sourceType varchar,
  contentType varchar := 'vcard',
  tags varchar := '' )
  *  cURL Example Import contact(s)

addressbook.export (
  inst_id integer )
  *  cURL Example Export contact(s)

addressbook.annotation.get (
  annotation_id integer )
  *  cURL Example Get annotation details

addressbook.annotation.new (
  contact_id integer,
  author varchar,
  body varchar )
  *  cURL Example Create annotation

addressbook.annotation.claim (
  annotation_id integer,
  claimRelation varchar,
  claimValue varchar )
  *  cURL Example Make annotation claim

addressbook.annotation.delete (
  annotation_id integer )
  *  cURL Example Delete annotation

addressbook.comment.get (
  comment_id integer )
  *  cURL Example Get comment details

addressbook.comment.new (
  contact_id integer,
  parent_id integer := null,
  title varchar,
  text varchar,
  name varchar,
  email varchar,
  url varchar )
  *  cURL Example Create comment

addressbook.comment.delete (
  comment_id integer, )
  *  cURL Example Delete comment

addressbook.publication.new (
  inst_id integer,
  name varchar,
  updateType varchar := 1,
  updatePeriod varchar := 'hourly',
  updateFreq integr := 1,
  destinationType varchar := null,
  destination varchar,
  userName varchar := null,
  userPassword varchar := null,
  tagsInclude varchar := '',
  tagsExclude varchar := '' )
  *  cURL Example Create new publication

addressbook.publication.get (
  publication_id integer )
  *  cURL Example Get publication details

addressbook.publication.edit (
  publication_id integer,
  name varchar,
  updateType varchar := 1,
  updatePeriod varchar := 'hourly',
  updateFreq integr := 1,
  destinationType varchar := null,
  destination varchar,
  userName varchar := null,
  userPassword varchar := null,
  tagsInclude varchar := '',
  tagsExclude varchar := '' )
  *  cURL Example Edit publication details

addressbook.publication.sync (
  publication_id integer )
  *  cURL Example Perform publication synchronization

addressbook.publication.delete (
  publication_id integer )
  *  cURL Example Delete publication

addressbook.subscription.new (
  inst_id integer,
  name varchar,
  updateType varchar := 1,
  updatePeriod varchar := 'hourly',
  updateFreq integr := 1,
  sourceType varchar := null,
  source varchar,
  userName varchar := null,
  userPassword varchar := null,
  tagsInclude varchar := '',
  tagsExclude varchar := '' )
  *  cURL Example Create new subscription

addressbook.subscription.get (
  subscription_id integer )
  *  cURL Example Get subscription details

addressbook.subscription.edit (
  subscription_id integer,
  name varchar,
  updateType varchar := 1,
  updatePeriod varchar := 'hourly',
  updateFreq integr := 1,
  sourceType varchar := null,
  source varchar,
  userName varchar := null,
  userPassword varchar := null,
  tagsInclude varchar := '',
  tagsExclude varchar := '' )
  *  cURL Example Edit subscription details

addressbook.subscription.sync (
  subscription_id integer )
  *  cURL Example Perform subscription synchronization

addressbook.subscription.delete (
  subscription_id integer )
  *  cURL Example Delete subscription

addressbook.options.set (
  inst_id integer,
  options any )
  *  cURL Example Set Addressbook Instance options
Options parameters names can be:
  - chars
  - rows
  - tbLabels
  - hiddens
  - atomVersion

addressbook.options.get (
  inst_id integer, )
  *  cURL Example Get Addressbook Instance options details

Examples

References