MathDiLS v.1.1

Last updated September 3, 2007

Developer's Guide

MathDiLS has been developed on the .NET platform. Database Management system is SQL Server 2000 SP4. Web services have been implemented in C# language.

The rest of the document gives a detailed description of web services provided by MathDiLS. Web services are being presented as functions. All input arguments (variables) are case-sensitive. Description of these functions is made through providing the input arguments and return values for these functions. Moreover, a short description of the expected behavior of these functions is given. Please note that in our approach we adopt the usage of common data types like string, integer etc, which is not what WSDL file includes. For a brief overview of our data types, a mapping to WSDL types and the data type limitations, see table below:

One more limitation concerning the usage of MathDiLS is that web server hosting the web services is limited to accept HTTP SOAP and POST requests with max size of 100Mbytes (104,857,600 bytes). So, we could say that the maximum size of DDAfiles that MathDiLS supports is about 99Mbytes.

Contents

Authentication

In order to authenticate, you will to need to include a SOAP header at every HTTP request. In every SOAP object you have to declare a SOAP header, containing 2 fields (string): Username and password. The values of these fields are the same for the ReMath portal. A user will first have to register to the ReMath portal, register a username and password and then use them in the Web Services. The XML Schema of this header is the following:

<s:element name="AuthHeader" type="tns:AuthHeader"/>
<s:complexType name="AuthHeader">
<s:sequence>
<s:element minOccurs="0" maxOccurs="1" name="Username" type="s:string"/>
<s:element minOccurs="0" maxOccurs="1" name="password" type="s:string"/>
</s:sequence>

Return Values & Exception Handling

Exception handling takes place in every web service being executed. Each object being returned inherits object MathDiLSException, which contain 2 fields: _errorId and _errorMessage. The XML Schema for the exception object is the following:

<s:complexType name="MathDiLSException">
<s:sequence>
<s:element minOccurs="1" maxOccurs="1" name="_errorId" type="s:int"/>
<s:element minOccurs="0" maxOccurs="1" name="_errorMessage" type="s:string"/>
</s:sequence>

The following table describes the list of possible errorIds and errorMessages:

All MathDiLS web services return objects which inherit from MathDiLSException, i.e. web services that are supposed to return a single value (e.g. insertDDAFile, deleteDDAFile) return an object of type MathDiLSResponse. MathDiLSResponse inherits from MathDiLSException and contains one attribute: val which is a variable of type integer. The XML Schema for this object is the following:

<s:complexType name="MathDiLSResponse">
<s:complexContent mixed="false">
<s:extension base="tns:MathDiLSException">
<s:sequence>
<s:element minOccurs="1" maxOccurs="1" name="val" type="s:int"/>
</s:sequence>
</s:extension>
</s:complexContent>
</s:complexType>

Other web services (e.g. DDAFileRead) return more complex objects.

List of MathDiLS web services

DDA FILE MANAGEMENT

DDAs will mainly echange with MathDiLS DDA application files. DDA application files are also accompanied with some attributes. For this purpose an object name "DDAFile" has been defined, which includes the DDA application file as well as its attributes. The data members of DDAFile are the following:

DDA Files are files being handled by DDAs. DDA files are considered placeholders for handling (currently) binary objects. A DDA File is described through several meta-data, which are the following:

• ID: The DDA File ID (integer), which is unique and identifying every DDA File.
• author: Author (string) is the name of the user who has inserted the DDA File.
• DDAID: DDAID (integer) is the identifier for each of the DDAs. For a listing of the available DDAs, check listDDAs.
• filename: Filename (string) is the name for the file attached (see below cnt) at every DDA File.
• MIMEType: MIMEType (string) is an attribute that may be used by DDAs to deal more conveniently DDA Files, e.g. you may set the value ".dda1" so that that the client who downloads the DDA File may be associated with it.
• title: Title (string) is an attribute describing DDA File.
• desc: Desc (string of 1024 length bytes) is the description of the DDA File.
• cnt: Cnt (byte []) is the attribute where the content of the file resides.
• level: Level (integer) is an attribute which allows users to set the access level for the DDA File. Each user has an access level as well and he/she cannot set the level of a DDA File with a higher level of his/her own. At the moment, the level value may range from 0-2. In general, it may be argued, that the most usual level for DDA Files is 2:
  • level 0 means that it's free for everyone to access it (will appear for free access to the remath portal as well)
  • level 1 means that DDA File is available to registered users only (notice that everyone may register at the remath portal as well)
  • level 2 means that the file is availabel to authenticated users only. Authenticated users are users who have registered to the remath portal, but have been identified as internal partners of the project.

In the future, more levels may be defined, if necessary.

• catIds: CatIds (int []) is an array of DDA Category Ids, where the DDA File resides. In most cases, this field will contain one value, for DDA files which reside in only one category. There are some restrictions on who may place DDA files in each category. Please refer to User Management.
• language: Language is the name of the language for the DDA File. For a listing of the available languages, check listLanguages. This has been implemented in order to allow users to add a DDA application file in many languages. (see also next data member).
• DDAFiles_m: DDAFiles_m is an array of the languages available (as translation) to each DDA File. Each record in the array contains 2 fields: the first is the DDA File ID for the translated DDA File and the second is the name of the language for the translated DDA File. If no translation is available, this array is empty.

Please note that DDAFile inherits object MathDiLSException (and so web services which return this object, may also include errorId and errorMessage). The XML Schema for the DDA File is the following:

DDAFile

<s:complexType name="DDAFile">
<s:complexContent mixed="false">
<s:extension base="tns:MathDiLSException">
<s:sequence>
<s:element minOccurs="1" maxOccurs="1" name="ID" type="s:int"/>
<s:element minOccurs="0" maxOccurs="1" name="author" type="s:string"/>
<s:element minOccurs="1" maxOccurs="1" name="DDAID" type="s:int"/>
<s:element minOccurs="0" maxOccurs="1" name="filename" type="s:string"/>
<s:element minOccurs="0" maxOccurs="1" name="MIMEType" type="s:string"/>
<s:element minOccurs="0" maxOccurs="1" name="title" type="s:string"/>
<s:element minOccurs="0" maxOccurs="1" name="desc" type="s:string"/>
<s:element minOccurs="0" maxOccurs="1" name="cnt" type="s:base64Binary"/>
<s:element minOccurs="1" maxOccurs="1" name="level" type="s:int"/>
<s:element minOccurs="0" maxOccurs="1" name="catIds" type="tns:ArrayOfInt"/>
<s:element minOccurs="0" maxOccurs="1" name="language" type="s:string"/>
<s:element minOccurs="0" maxOccurs="1" name="DDAFiles_m" type="tns:ArrayOfAnyType"/>
</s:sequence>
</s:extension>
</s:complexContent>

• DDAFileRead
• Arguments:
  • DDAFileId : The DDA File ID (integer) of the DDA File which is going to be read.
• Return Value:
  • Object returned of type DDAFile. The XML Schema of the DDAFile is here.
• Description:
  • You have to provide the appropriate credentials. The DDAFileID must point to a valid DDA File and the user who makes the request must have access level higher or equal to level of the DDA File.
• Sample SOAP request
top
• DDAFileRead2
• Same as DDAFileRead. Object returned is DDAFile_s, which contains attribute cnt as a base 64 encoded string. The XML Schema for DDAFile_s is the following:

DDAFile_s

<s:complexType name="DDAFile_s">
<s:complexContent mixed="false">
<s:extension base="tns:MathDiLSException">
<s:sequence>
<s:element minOccurs="1" maxOccurs="1" name="ID" type="s:int" /> 
<s:element minOccurs="0" maxOccurs="1" name="author" type="s:string" /> 
<s:element minOccurs="1" maxOccurs="1" name="DDAID" type="s:int" /> 
<s:element minOccurs="0" maxOccurs="1" name="filename" type="s:string" /> 
<s:element minOccurs="0" maxOccurs="1" name="MIMEType" type="s:string" /> 
<s:element minOccurs="0" maxOccurs="1" name="title" type="s:string" /> 
<s:element minOccurs="0" maxOccurs="1" name="desc" type="s:string" /> 
<s:element minOccurs="0" maxOccurs="1" name="cnt" type="s:string" /> 
<s:element minOccurs="1" maxOccurs="1" name="level" type="s:int" /> 
<s:element minOccurs="0" maxOccurs="1" name="catIds" type="tns:ArrayOfInt" /> 
<s:element minOccurs="0" maxOccurs="1" name="language" type="s:string" /> 
<s:element minOccurs="0" maxOccurs="1" name="DDAFiles_m" type="tns:ArrayOfAnyType" /> 
</s:sequence>
</s:extension>
</s:complexContent>
</s:complexType>

• Sample SOAP request
top
• insertDDAFile
  • Arguments:
    • title: The title (string) of the DDA File to be inserted.
    • desc: The description text (1024 byte string) for the new DDA File.
    • level: The access level (integer) of the inserted DDA file.
    • file: The content (byte []) of the DDA file to be inserted.
    • filename: The filename (string) of the DDA File.
    • MIMEType: The MIMEType (string) of the DDA File.
    • DDAID: The DDAID (integer) for the DDA File. For a listing of the available DDAs, check listDDAs.
    • catIds: The category Ids (array of integers) where the DDA File resides.
    • language: The language (string) of the new DDA File. For a listing of the available languages, check listLanguages.
  • Return Value:
    • MathDiLSReponse: If no error code is returned, attribute val contains the ID for the DDA File inserted.
  • Description: Inserts a new DDA File. You must provide the appropriate credentials (username and password at the SOAP header). The level of the DDA File, must not be higher than the user's level. User must be author to all of the categories where the DDA File will reside. If you want to add a translation to an existing DDA file use insertDDAFileAsTranslation instead.
  • Sample SOAP request
top
• insertDDAFile2
  • Same as insertDDAFile. Attribute file_s is a base64 encoded string.
  • Sample SOAP request
top
• deleteDDAFile
  • Arguments:
    • DDAFileId : The Id (integer) of the DDA File to be deleted.
  • Return Value:
    • MathDiLSReponse: If no error code is returned, attribute val contains 1.
  • Description:
    • In order to delete a DDA File, you have to provide the appropriate credentials. Indicated DDA File must be valid and user must be author to all of the DDA categories where the DDA file resides.
  • Sample SOAP request
top
• updateDDAFile
  • Arguments:
    • DDAFileID: The DDA File ID (integer) of the DDA File to be updated. This attribute is read-only.
    • title: The title (string) of the DDA File.
    • desc: The description (1024-length string) of the DDA File.
    • level: The level (integer) of the DDA File.
    • file: The content (byte []) of the DDA file to be updated.
    • filename: The filename (string) of the DDA to be updated.
    • MIMEType: The MIMEType (string) of the DDA File to be updated.
    • DDAID: The DDA ID (integer) for the DDA File. For a listing of the available DDAs, check listDDAs.
    • catIds: The array (int []) of Category Ids where the DDA File belongs.
    • language: The language (string) of the DDA File. For a listing of the available languages, check listLanguages.
  • Return Value:
    • MathDiLSReponse: If no error code is returned, attribute val contains 1.
  • Description: Updates a DDA File. You must provide the appropriate credentials. Existing and new DDA File level must be equal or lower to the user level access. User must be author to all (existing and new) Categories where the DDA File resides. You have to provide values for all arguments, since the supplied values replace existing ones.
  • Sample SOAP request
top
• updateDDAFile2
  • Same as updateDDAFile. Attribute file_s is a base64 encoded string.
  • Sample SOAP request
top
• searchDDAFiles
  • Arguments:
    title: The title (string) for the DDA File Search query.
    • desc: The description (1024-legnth string) for the DDA File Search query.
    • catIds: The Category Ids (int []) array where DDA File could reside.
    • languages: The languages (string []) for the DDA File Search query.
    • authors: The authors (string []) for the DDA File Search query.
    • level: The maximum level for the DDA File Search query.
    • return_content: Boolean. If true, array DDAFiles will include content, else the field cnt (content) will not be provided.
  • Return Value:
    Return value is an array of DDAFiles. Note that the DDAFile object includes error handling information. If an error occurred (e.g. wrong login) an array containing one DDA File describing the error is returned. If no DDAFiles were found, the array is empty.
  • Description:
    SearchDDAFiles searches for DDA Files across MathDiLS. You must provide the appropriate credentials. At least one argument must be not null. If 2 or more arguments are provided, DDA Files must satisfy all the constraints. Of course, if 2 languages (or DDA Category IDs or authors) are provided, DDA File must satisfy at least one of the provided values. In other words, all provided arguments are logically conjected (AND) and multiple values for an argument are logically disjuncted (OR). Level is the maximum level (i.e. if you search for DDA Files of level 2, you get level 0 and 1 as well). Only DDAFiles with level equal or less than the user level are returned.
  • Sample SOAP request
• searchDDAFiles2
  • Same as searchDDAFiles. Returns an array of DDAFile_s, where attribute file is a base64 encoded string. The XML schema for DDAFile_s is here.
  • Sample SOAP request

DDA CATEGORY MANAGEMENT

DDA Files reside in DDA Categories. Each DDA Category may contain either DDA Categories or (exclusively) DDA Files. This means that the hierarchical organization of DDA Files resembles to a b+ tree. A DDA Category is an object which is described through several attributes:

• ID: The DDA Category ID (integer), which is unique and identifying every DDA Category.
• name: The name (string) for the DDA Category.
• parentID: The Category ID (integer) where DDA Category resides (i.e. it points to the "parent" DDA Category)
• desc: The description (1024-length string) for the DDA Category.
• lang: The name (string) for the language of the DDA Category. For a listing of the available languages, check listLanguages. This attribute is used in order to allow a category name and description to exists in different languages.
• DDACategories_m: DDACategories_m (like DDAFiles_m) is an array for the translations of the DDA Category. Each record in this array contains 3 fields: name (string), desc (1024-length string) and lang (string).

(Notice: Unlike DDA Files, translations for DDA Categories are not identified uniquely through their ID. In order to specify (at the maximum) one DDA Category, you must specify both ID and language. Moreover, navigation over the categories is free as long as users provide their credentials).

Please note that MathDiLSDDACategory inherits object MathDiLSException (and so web services which return this objectm, may alose include errorId and errorMessage). The XML Schema for the DDA Category is the following:

<s:complexType name="MathDiLSDDACategory">
<s:complexContent mixed="false">
<s:extension base="tns:MathDiLSException">
<s:sequence>
<s:element minOccurs="1" maxOccurs="1" name="ID" type="s:int"/>
<s:element minOccurs="0" maxOccurs="1" name="name" type="s:string"/>
<s:element minOccurs="1" maxOccurs="1" name="parentID" type="s:int"/>
<s:element minOccurs="0" maxOccurs="1" name="desc" type="s:string"/>
<s:element minOccurs="0" maxOccurs="1" name="lang" type="s:string"/>
<s:element minOccurs="0" maxOccurs="1" name="DDACategories_m" type="tns:ArrayOfAnyType"/>
</s:sequence>
</s:extension>
</s:complexContent>
</s:complexType>

• DDACAtegoryRead

• Arguments:
  • DDACategoryId: The DDA Category ID (integer) of the Category which is going to be read.
• Return Value: Object returned is the MathDiLSDDACategory. The XML Schema of MathDiLSDDACategory is here.
• Description: You have to provide the appropriate credentials.
• Sample SOAP request

• insertDDACategory

• Arguments:
  • name: The name (string) of the new DDA Category.
  • parentID: The Category ID (integer) where the new Category belongs.
  • desc: The description (1024-length string) of the DDA Category.
  • lang: The language (string) for the new DDA Category. For a listing of the available languages, check listLanguages.
• Return Value: Object returned is MathDiLSResponse. The XML Schema for MathDiLSResponse here.
• Description: Inserts a new DDA Category. Credentials provided require the corresponding privileges for the parent Category. If parent Category was "leaf" with DDA Files, all DDA Files, are automatically moved to the new category. The user who inserts the DDA Category is automatically granted author privileges for the new DDA Category.
• Sample SOAP request

• deleteDDACategory

• Arguments:
  • DDACategoryId : The Id (integer) of the category to be deleted.
• Return Value:
  • MathDiLSReponse: If no error code is returned, attribute val contains 1. If negative, there have been some errors (reported through exception handling).
• Description:
  • In order to delete a DDA Category, you have to provide the appropriate credentials. Authenticated user must be author to the DDA Category. Moreover, DDA Category must be empty (i.e. there must be neither DDA Categories nor DDA Files). All translations for the DDA Category are deleted.
• Sample SOAP request
top
• updateDDACategoryTranslation
  • Arguments:
    • categoryId : The DDA Category ID (integer) to be updated. This attribute is read-only.
    • name: The name (string) of the new DDA Category.
    • desc: The description (1024-legnth string) of the DDA Category.
    • language : The language (string) for the DDA Category. This attribute is read-only. For a listing of the available languages, check listLanguages.
  • Return Value:
    • MathDiLSReponse: If an error occured, attribute val is negative and the error is reported through exception handling. If update is succesful, attribute val is positive.
  • Description:
    • Updates the DDA Category. You have to provide the corresponding credentials. User must be author for the Category.
  • Sample SOAP request
top
• listDDACats
  • Arguments:
    • DDACategoryId: The DDA Category ID (integer) which contains the categories to be listed.
  • Return Value:
    • An array of MathDiLSDDACategory. The XML Schema of the DDA Category is here. In case of an error (e.g. invalid login, DDA Category ID not existing) an array containing one DDA Category is returned describing the error (reported through exception handling).
  • Description: Lists the DDA Categories under another DDA Category. User must provide credentials. If authenticated, this operation is free for all users. If DDACategoryId provided is negative, Categories placed in the root structure are returned . If DDACategoryId provided points to a "leaf" DDA Category, array returned is empty. Update: MathDiLS categories that reside in non-MathDiLS categories are returned as well.
  • Sample SOAP request

• listDDAFiles

• Arguments:
  • DDACategoryId : The DDA Category ID (integer) which contains the DDA Files to be listed.
  • return_content: Boolean. If true, array DDAFiles will include content, else the field cnt (content) will not be provided.
• Return Value:
  • An array of DDA Files. The XML Schema of the DDA File is here.
• Description:
  • If operation is not successful, an array containing one DDA File is returned describing the error (reported through exception handling). User must provide the appropriate credentials. DDA Files with level higher than the user level are excluded from the return value. If DDA Category has no DDAFiles (or DDA Category is not "leaf") array returned is empty.
• Sample SOAP request

• listDDAFiles2

• Same as listDDAFiles. Returns an array of DDAFile_s which contain attribute file as a base64 encoded string. The XML Schema for DDAFile_s is here.
• Sample SOAP request

USER MANAGEMENT

MathDiLS shares the same userbase with Remath Portal. Users are allowed to manage content the same way they do in the portal. A notion used here is the category author. A category may have multiple authors. A category author is the only user who may insert a DDA file in the category, update and delete the category, define more authors in the category as well as create a child category.

• listDDACategoryAccess
  • Arguments:
    • DDACategoryId: The DDA Category ID (integer) which contains the users being authors.
  • Return Value:
    • An array of MathDiLSUsers (see here). Each record contains 3 attributes:
      • username: The username (string) of the user.
      • fname: The first name (string) of the user.
      • lname: The last name (string) of the user.
  • Description:
    • Provides a list of the users who are authors to one DDA Category. User must provide the appropriate credentials.
  • Sample SOAP request
top
• addDDACategoryAuthors
  • Arguments:
    • DDACategoryId: The DDA Category ID (integer) for the DDA Category you want to add users as authors.
    • An array of usernames (authors). Each record contains one value (string) with the desired user name. For a listing of the users, check listUsers.
  • Return Value:
    • MathDiLSReponse: If no error code is returned, attribute val is positive. If negative, there have been some errors (reported through exception handling).
  • Description:
    • Grants access to one or more users to author one DDA Category. If requesting user is not an author, operation is not permitted. If one or more users provided are already authors to the DDA Category, no error code is returned. If one or more users are not valid/existing, operation is not performed.
  • Sample SOAP request
top
• removeDDACategoryAuthors
  • Arguments:
    • DDACategoryId: The DDA Category ID (integer) for the DDA Category you want to remove users from authors.
    • An array of users (authors). Each record contains one value (string) with the desiring user name. For a listing of the users, check listUsers.
  • Return Value:
    • MathDiLSReponse: If no error code is returned, attribute val is positive. If negative, there have been some errors (reported through exception handling)..
  • Description:
    • User requesting this service cannot remove himself from author (operation will continue skipping current user). If one or more users are not existing an error code is returned and the operation is not performed.
  • Sample SOAP request

GENERAL INFORMATION

This section contain several web services which provide general information about MathDiLS. These services are supportive to the rest of the web services presented here.

• listLanguages
  • Arguments:
    • None
  • Return Value:
    • An array of languages (string []).
  • Description:
    • User must provide the appropriate credentials. Access if free for all users. If an error occurs (e.g. invalid login) array is empty.
  • Sample SOAP request
top
• listDDAs
  • Arguments:
    • None.
  • Return Value:
    • An array of MathDiLSDDA (see below).
  • Description:
    • User must provide the appropriate credentials. Access if free for all users

   

DDA is a MathDiLS object comprising of 3 attributes:

• DDAID: The ID (integer) identifying uniquely each DDA.
• name: The name (string) for the DDA.
• description: The description (1024-length string) for the DDA.

The XML Schema for the DDA is the following:

<s:complexType name="MathDiLSDDA">
<s:complexContent mixed="false">
<s:extension base="tns:MathDiLSException">
<s:sequence>
<s:element minOccurs="1" maxOccurs="1" name="DDAID" type="s:int"/>
<s:element minOccurs="0" maxOccurs="1" name="name" type="s:string"/>
<s:element minOccurs="0" maxOccurs="1" name="description" type="s:string"/>
</s:sequence>
</s:extension>
</s:complexContent>
</s:complexType>

• Sample SOAP request

top
• listUsers

• Arguments:
  • None.
• Return Value:
  • An array of MathDiLSUsers (see below). If an error occurs (e.g. wrong login), an array containing one MathDiLSUser is returned, describing the error.
• Description:
  • User must provide the appropriate credentials. Access if free for all users.

MathDiLSUser is a MathDiLS object (inherits MathDiLSException) comprising of 3 attributes:

• username: The username (string) of the user.
• fname: The first name (string) of the user.
• lname: The Last name (string) of the user.

The XML Schema for MathDiLSUser is the following:

<s:complexType name="MathDiLSUser">
<s:complexContent mixed="false">
<s:extension base="tns:MathDiLSException">
<s:sequence>
<s:element minOccurs="0" maxOccurs="1" name="username" type="s:string"/>
<s:element minOccurs="0" maxOccurs="1" name="fname" type="s:string"/>
<s:element minOccurs="0" maxOccurs="1" name="lname" type="s:string"/>
</s:sequence>
</s:extension>
</s:complexContent>
</s:complexType>

• Sample SOAP request

MULTILINGUAL SERVICES

MathDiLS is designed to act as multilingual content repository. DDA Categories may have their names and descriptions in various languages and the same DDA Application Files may appear with some of their attributes in different languages. Of course the files themselves may have "translations" in the corresponding languages. It is not mandatory, of course for the users to exploit the multilingual services, but they are available for those who wish to do so. The services described below provide the desired functionality.

• insertDDAFileAsTranslation
  • Arguments:
    • cntID: The DDA File ID of the DDA File to be translated.
    • title: The title (string) of the DDA File to be inserted.
    • desc: The description text (1024 byte string) for the new DDA File.
    • DDAID: The DDAID (integer) for the DDA File. For a listing of the available DDAs, check listDDAs.
    • file: The content (byte []) of the DDA file to be inserted.
    • filename: The filename (string) of the DDA File.
    • MIMEType: The MIMEType (string) of the DDA File.
    • language: The language (string) of the new DDA File. For a listing of the available languages, check listLanguages.
  • Return Value:
    • MathDiLSReponse: If no error code is returned, attribute val contains the ID for the DDA File inserted. Each translation gets a new ID.
  • Description:
    • User must provide the appropriate credentials. User must be author of the categories where the DDA File to be translated resides and have level higher or equal to the originating DDA File. The DDA file may not have already a translation in the specified language (for modifying a translation check updateDDAFile).
  • Sample SOAP request
top
• insertDDAFileAsTranslation2
  • Same as insertDDAFileAsTranslation. Attribute file_s is a base64 encoded string.
  • Sample SOAP request
top
• updateDDACategoryTranslation
  • Arguments:
    • categoryId: The DDA Category ID (integer) of the category to be updated. This attribute is read-only.
    • name: The name for the DDA Category.
    • desc: The description (1024 byte string) for the DDA Category.
    • language: The language for the DDA Category. This attribute is read-only. For a listing of the available languages, check listLanguages.
  • Return Value:
    • MathDiLSReponse : If no error code is returned, attribute val is positive. If negative, there have been some errors (reported through exception handling).
  • Description: User must provide the appropriate credentials. User must be author to the DDA Category. Translation must be existing, or else nothing happens (for inserting a translation check insertDDACategoryAsTranslation).
  • Sample SOAP request
top
• insertDDACategoryAsTranslation
  • Arguments: The input argument is DDA Category and the DDA Category ID to be inserted
    catId: The DDA Category ID (integer) of the DDA Category to be translated. This attribute is read-only.
    • name: The name for the new DDA Category (string).
    • desc: The description for the new DDA Category (1024 byte string).
    • language: The language (string) of the new DDA Category. For a listing of the available languages, check listLanguages.
  • Return Value:
    • MathDiLSReponse : If no error code is returned, attribute val is positive (DDA Category ID). If negative, there have been some errors (reported through exception handling).
  • Description: User must provide the appropriate credentials. User must be author to both parent and current DDA Categories. Translation must not be existing.
  • Sample SOAP request

• deleteDDACategoryTranslation
  • Arguments:
    • DDACategoryId: The DDA Category ID of the DDA Category translation to be deleted.
    • language: The language (string) of the DDA Category to be deleted. For a listing of the available languages, check listLanguages.
  • Return Value:
    • MathDiLSReponse : If no error code is returned, attribute val is positive. If negative, there have been some errors (reported through exception handling)..
  • Description: User must provide the appropriate credentials. User must be author to the DDA Category. If translation not existing, no error code is returned and nothing happens.
  • Sample SOAP request

E-learning sector CTI