Ifd:addIllustrations

From dev.ifd-library.org

Jump to: navigation, search

API version 3

Function public IfdIllustration [] addIllustrations (
                                                  String session_id,
                                                  String concept_guid,
                                                  IfdDescription[] descriptions) 
                      throws IfdServerException

EXPRESS Heading

Query function addIllustrations(
                 concept_guid	: STRING;
                 illustrations	: LIST OF IfdIllustration) : LIST OF IfdIllustration;

The function adds illustrations to the specified concept. It was a lacuna in v.2.00 – illustrations were reserved in IfdConcept, but there were no any possibility to add them.

Input:

  • String concept_guid - global unique id of the target concept;

illustrations[] descriptions - list of fully specified illustrations to be added to the concept, with the following attributes for every element:

  • guid – (optional) global unique id of the existing in database illustrations. If the item defined yet in target population the attribute shall be set (as well as other attributes) and existing illustration will be assigned to the concept;
  • language – (optional) language of the description (shall be defined yet in target population), by default it is dedicated language with code equal to internal constant DEFAULT_LANGUAGE_CODE (‘en’ in current version);
  • mimetype – type of MIME type of the illustration representation;
  • illustration – MIME code of the illustration;
  • preferred_by – (optional) aggregate of organizations which will prefer the illustration, by default set with home organization of the logged user

Return: IfdIllustration - List of fully specified illustrations of the concept added with the function. Every element of the aggregate will have the following attributes:

  • guid - global unique id of the illustration;
  • language - language of the illustration;
  • mimetype - MIME type;
  • illustration - MIME code of the illustration;
  • preferred_by - aggregate of organizations which prefer the illustration



Back to the API