Ifd:IFD API

From dev.ifd-library.org

Jump to: navigation, search

An overview of the object model and a list of functions available through the standard WSDL API. The API is the result of the LexiCon - BARBi unification project.

2.0 version of API up and running, get the WSDL at: http://services.ifd-library.org/api/2.0?wsdl

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

Image:Step.gif For step by step examples of how to use the API see: Step by Step guide to use of the IFD api

Contents

[edit] Object model

[edit] Classes

[edit] Types

[edit] Enumerations

[edit] Functions

Functions defined for the ODIN project (many of them are implemented in the old WSDL interface (version 1.0)): http://odin.byggforsk.no/index.php/IFD_input_API

Icon explanation

  • RED- means not ready
  • OLIVE - means started on but not yet ready
  • GREEN - means finished
  • image:JA3.jpg - J means the Java layer
  • image:EX3.jpg - E means the EXPESS layer
  • image:TE3.jpg - T means testing and verification
  • image:US3.jpg - U means user rights
  • image:QUE.jpg - ? means that the function is being discussed

The icons might be followed by a short notice about the last change or status.


Overview of methods impimented in the current (v.1.1) version of the WSDL API: Old_API_Method_List

[edit] Search functions

[edit] Get functions

  • getConstrainedValues - get all measures and contexts with constrained values that are constrained in the combination of a property and an object image:EX2.jpgimage:TE3.jpgimage:JA2.jpgimage:US1.jpg
  • getConstrainedMeasures - get all measures with constrained values that are constrained in the combination of a property and an object image:EX2.jpgimage:TE3.jpgimage:JA2.jpgimage:US1.jpg

[edit] 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.

  • addConstrainedValues - add a set of values to constrain a measure of a property image:EX3.jpgimage:TE3.jpgimage:JA1.jpgimage:US1.jpg
  • addPreference - adds the current users organisation to the list of organisations preferring the name, description or illustration image:EX2.jpgimage:TE3.jpgimage:JA1.jpgimage:US1.jpg

[edit] 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.

[edit] Remove functions

[edit] Merge functions

  • mergeDuplicates -merges two identical concepts. One of the guid's is kept while the other get the status. "TRANSFERRED" image:EX1.jpgimage:TE2.jpgimage:JA1.jpgimage:US1.jpg

[edit] Miscellaneous functions

[edit] Postponed functions

The following list of functions will not be implemented in version 2 of the WSDL interface. They are subject for discussions and will have to be implemented in later versions of the API.

  • getValueAttributes - get additional attribute for the value-concept (sub function lacks proper is_preferred implementation)image:QUE.jpg
  • getMeasureAttributes - get additional attribute for the measure-concept (sub function lacks proper is_preferred implementation)image:QUE.jpg
  • getNames - list all names of the selected languages and of the selected types image:QUE.jpg
  • getConceptsWithName - list all concepts with the selected name image:QUE.jpg
  • getConceptTypes - list all concept types in the enumeration image:QUE.jpg
  • makeIfdGuid - make a GUID suitable for the IFDimage:EX1.jpgimage:TE2.jpgimage:JA3.jpgimage:US1.jpg

[edit] EXPRESS-X documentation


Return to the LexiCon - BARBi unification page