Addressbook's Programmers Guide

Addressbook Controllers

Addressbook get

• Description: get contact by given id
• API name: ODS.ODS_API."addressbook.get"
• Parameters:
  • contact_id

Addressbook new

• Description: creates new contact
• API name: ODS.ODS_API."addressbook.new"
• Parameters:
  • inst_id
  • name
  • category_id
  • kind
  • title
  • fName
  • mName
  • lName
  • fullName
  • gender
  • birthday
  • iri
  • foaf
  • photo
  • interests
  • relationships
  • mail
  • web
  • icq
  • skype
  • aim
  • yahoo
  • msn
  • hCountry
  • hState
  • hCity
  • hCode
  • hAddress1
  • hAddress2
  • hTzone
  • hLat
  • hLng
  • hPhone
  • hMobile
  • hFax
  • hMail
  • hWeb
  • bCountry
  • bState
  • bCity
  • bCode
  • bAddress1
  • bAddress2
  • bTzone
  • bLat
  • bLng
  • bPhone
  • bMobile
  • bFax
  • bIndustry
  • bOrganization
  • bDepartment
  • bJob
  • bMail
  • bWeb
  • tags

Addressbook edit

• Description: edits contact
• API name: ODS.ODS_API."addressbook.edit"
• Parameters:
  • contact_id
  • name
  • category_id
  • kind
  • title
  • fName
  • mName
  • lName
  • fullName
  • gender
  • birthday
  • iri
  • foaf
  • photo
  • interests
  • relationships
  • mail
  • web
  • icq
  • skype
  • aim
  • yahoo
  • msn
  • hCountry
  • hState
  • hCity
  • hCode
  • hAddress1
  • hAddress2
  • hTzone
  • hLat
  • hLng
  • hPhone
  • hMobile
  • hFax
  • hMail
  • hWeb
  • bCountry
  • bState
  • bCity
  • bCode
  • bAddress1
  • bAddress2
  • bTzone
  • bLat
  • bLng
  • bPhone
  • bMobile
  • bFax
  • bIndustry
  • bOrganization
  • bDepartment
  • bJob
  • bMail
  • bWeb
  • tags

Addressbook delete

• Description: deletes contact by given id
• API name: ODS.ODS_API."addressbook.delete"
• Parameters:
  • contact_id

Import

• Description: imports contacts
• API name: ODS.ODS_API."addressbook.import"
• Parameters:
  • inst_id
  • source
  • sourceType
  • contentType
  • tags

Export

• Description: export contacts
• API name: ODS.ODS_API."addressbook.export"
• Parameters:
  • inst_id
  • contentType

Annotation get

• Description: gets annotation by given id
• API name: ODS.ODS_API."addressbook.annotation.get"
• Parameters:
  • annotation_id

Annotation new

• Description: creates new annotation
• API name: ODS.ODS_API."addressbook.annotation.new"
• Parameters:
  • contact_id
  • author
  • body

Annotation claim

• Description: creates annotation claim
• API name: ODS.ODS_API."addressbook.annotation.claim"
• Parameters:
  • annotation_id
  • claimRelation
  • claimValue

Annotation delete

• Description: deletes annotation
• API name: ODS.ODS_API."addressbook.annotation.delete"
• Parameters:
  • annotation_id

Comment get

• Description: gets comment by given id
• API name: ODS.ODS_API."addressbook.comment.get"
• Parameters:
  • comment_id

Comment new

• Description: creates new comment
• API name: ODS.ODS_API."addressbook.comment.new"
• Parameters:
  • contact_id
  • parent_id
  • title
  • text
  • name
  • email
  • url

Comment delete

• Description: deletes comment by given id
• API name: ODS.ODS_API."addressbook.comment.delete"
• Parameters:
  • comment_id

Publication new

• Description: creates new publication
• API name: ODS.ODS_API."addressbook.publication.new"
• Parameters:
  • inst_id
  • name
  • updateType
  • updatePeriod
  • updateFreq
  • destinationType
  • destination
  • userName
  • userPassword
  • tagsInclude
  • tagsExclude

Publication edit

• Description: edits existing publications
• API name: ODS.ODS_API."addressbook.publication.edit"
• Parameters:
  • publication_id
  • name
  • updateType
  • updatePeriod
  • updateFreq
  • destinationType
  • destination
  • userName
  • userPassword
  • tagsInclude
  • tagsExclude

Publication delete

• Description: deletes publication by given id
• API name: ODS.ODS_API."addressbook.publication.delete"
• Parameters:
  • publication_id

Subscription new

• Description: creates new subscription
• API name: ODS.ODS_API."addressbook.subscription.new"
• Parameters:
  • inst_id
  • name
  • updateType
  • updatePeriod
  • updateFreq
  • sourceType
  • source
  • userName
  • userPassword
  • tagsInclude
  • tagsExclude

Subscription edit

• Description: edits subscription
• API name: ODS.ODS_API."addressbook.ssubscription.edit"
• Parameters:
  • subscription_id
  • name
  • updateType
  • updatePeriod
  • updateFreq
  • sourceType
  • source
  • userName
  • userPassword
  • tagsInclude
  • tagsExclude

Subscription delete

• Description: deletes subscription by given id
• API name: ODS.ODS_API."addressbook.subscription.delete"
• Parameters:
  • subscription_id

Options set

• Description: sets options
• API name: ODS.ODS_API."addressbook.options.set"
• Parameters:
  • inst_id
  • options

Options get

• Description: gets option
• API name: ODS.ODS_API."addressbook.options.get"
• Parameters:
  • inst_id

CategoryODS CategoryOpenSource CategoryAddressBook CategoryOdsAddressBook