Ifd3:IFD API

From dev.ifd-library.org

This is the definition for the upcoming version of the API. The API is under development so this page will change.

A testversion of the 3.0 API is up running here: 
http://services.ifd-library.org/ifdws57/earlybinding/options_2097152/IFD/IFDLibrary_v2/QEX/IFD_WSDL_EXPRESS
You also need a WSDL access for log-in: 
http://services.ifd-library.org/ifdws57/WSDLGenerator?accesscontrol=yes&user=[Your Username]&password=[Your Password]

WSDL here: http://services.ifd-library.org/ifdws57/ifd-service.wsdl

You need a user name in order to use the API. Here is information about how to get one.

Object model

Classes

Types

string

Enumerations

API overview

Search functions

searchForConcepts - the standard search for objects in the library
searchForNames - search for names.
searchForDuplicates - a search to see if the objects already exist in the Ifd library

Get functions

getConcept - get the concept
getMeasuresForProperty - get measure information with values and unit. Takes a property as input.
getMeasure - get measure infomation with values and unit. Takes a measure as input.
getLanguages - list all languages available in the library
getParentConcepts - list all parent (relating) concepts of the current concept
getChildrenConcepts - list all children (related) concepts of the current concept
getOrganizations - list all organizations in the system
getConstrainedValues - get all measures and contexts with constrained values that are constrained in the combination of a property and an object
getConstrainedMeasures - get all measures with constrained values that are constrained in the combination of a property and an object
getContexts - list all contexts available in the library
getContextOwners - returns all owners of a context.
getContextUsers - returns all users of a context.
getOrganizationMembers - returns all users that are members of a given organization.
getUsers - list all users in the system

Add functions

Add functions will carry out functions on all concepts and their sub-concepts. E.g if an IfdConcept contains both a new concepts and new names for that concept, all of these will be created.

addConcepts - add new concepts (subjects, activitys, actors, documents, properties, values or units)
addParents - add a list of parents to a concept.
addChildren - add a list of children to a concept.
addNamesToConcept - add new names (one or more) to a concept
addCommentsToConcept - add one or more new comments to a concept
addDefinitionsToConcept - add new definitions to a concept
addUser - add user to system
addOrganizations - add organization to system
addLanguages - add languages to system
addConstrainedValues - add a set of values to constrain a measure of a property
addPreference - adds the current users organisation to the list of organisations preferring the name, description or illustration
addContexts - adds a new context.
addContextOwners - adds owners to a context.
addContextUsers - adds users to a context.
addValues - adds new values.
addNamesToContext - Add one or more names to a context.

Update functions

Add functions will carry out functions only on the concept itself. Nothing will be done on the sub concepts. E.g when updating an IfdConcept that contains both a concepts and updated names for that concept, then ONLY the concept will be updated.

updateConcept - update one or more attributes of an existing concept
updateName - update the name for the current concept
updateDescription - update the description for the current concept
updateUser - update user
updateOrganization - update organization
updateLanguage - update language
updateValue - update value
updateContext - update context
updatePasswordForUser- update password for user
updatePasswordForCurrentUser- update password for current user
correctSpellingForName - update the name for all concept using the name
correctSpellingForDescription - update the description for all concept using the name

Remove functions

removeChildFromConcept - remove a child from a concept (to remove a parent, move to the parent and then remove this child from the parent using this function). This do not delete the Child from the library
removeParentFromConcept -
removeNameFromConcept -
removeDefinitionFromConcept -
removeCommmentFromConcept -
removeIllustrationFromConcept -
removeNameFromContext - remove name from context
removePreference - removes the current users organisation to the list of organisations preferring the name, description or illustration
removeConstrainedValues - remove constrained values
removeContextOwner - removes a owner from a context.
removeContextUser - removes a user from a context.

Merge functions

mergeDuplicates -merges two identical concepts. One of the guid's is kept while the other get the status. "TRANSFERRED"

Miscellaneous functions

sendPasswordToEmail - send password to users email
getAPIVersion - return version of this API
login - login to the system
logout - logout from the system
getLoggedInUserList - get a list of users currently logged in to the system
getCurrentUser - get the current user
getCurrentUserRights - get current user rights
getErrorMessage - get the error message for error code returned from one of the methods if something went wrong
getTestBuffer - test function

Development

Return to the LexiCon - BARBi unification page