Mimore XML-RPC service

Available methods

method mimore.getTitlesForFullResultsText
description Get titles for mimore.getFullResultsTextByID

Parameter 1 (optional): array of strings, with each string containing a resource name
signatures
1.
return struct
parameters  
2.
return struct
parameters
array
method mimore.getFullResultsTextByID
description Get full results

Parameter 1 (obligatory): array of structs, with each struct
- resource (obligatory) : a string containing the resource name
- id (obligatory) : a string or integer with an id
signatures
1.
return array
parameters
array
method mimore.getRecordIDsForText
description Search text in several sources.

Parameter 1 (obligatory): struct with
- string (obligatory) : a string containing the search key
- kloekecodes (optional) : an array of strings

Parameter 2 (optional): integer defining a limit on the total number of results

Parameter 3 (optional): array of structs, with for each struct:
- name (obligatory) : a string containing the resource name
- limit (optional) : an integer containing the limit on the number of results for this resource.

Example methodcall:

<methodCall> <methodName>mimore.getRecordIDsForText</methodName> <params> <param> <value> <struct> <member> <name>string</name> <value> <string>Koe</string> </value> </member> </struct> </value> </param> <param> <value> <int>10</int> </value> </param> </params></methodCall>
signatures
1.
return struct
parameters
struct
2.
return struct
parameters
struct
int
3.
return struct
parameters
struct
array
4.
return struct
parameters
struct
int
array
method mimore.getTitlesForFullResultsTags
description Get titles for mimore.getFullResultsTagsByID

Parameter 1 (optional): array of strings, with each string containing a resource name
signatures
1.
return struct
parameters  
2.
return struct
parameters
array
method mimore.getFullResultsTagsByID
description Get full results

Parameter 1 (obligatory): array of structs, with each struct
- resource (obligatory) : a string containing the resource name
- id (obligatory) : a string or integer with an id
signatures
1.
return array
parameters
array
method mimore.getRecordIDsForTags
description Search tags in several sources.

Parameter 1 (obligatory): struct with
- tags (obligatory) : an array of structs, with each struct describing a tag (see below)
- kloekecodes (optional) : an array of strings
- syntacticphenomena (optional) : struct with resource name as key, and an array of strings containing syntactic phenomena as value

Parameter 2 (optional): integer defining a limit on the total number of results

Parameter 3 (optional): array of structs, with for each struct:
- name (obligatory) : a string containing the resource name
- limit (optional) : an integer containing the limit on the number of results for this resource.

Struct describing a Tag:
- category (obligatory) : a string
- features (obligatory) : an array of strings

Example methodcall:

<methodCall> <methodName>mimore.searchTags</methodName> <params> <param> <value> <struct> <member><name>tags</name> <value><array> <data> <value><struct> <member><name>category</name> <value><string>N</string></value> </member> <member><name>features</name> <value><array> <data> <value><string>sg</string></value> </data> </array></value> </member> </struct></value> </data> </array></value> </member> </struct> </value> </param> <param> <value> <int>10</int> </value> </param> </params></methodCall>
signatures
1.
return struct
parameters
struct
2.
return struct
parameters
struct
int
3.
return struct
parameters
struct
array
4.
return struct
parameters
struct
int
array
method mimore.getTitlesForFullResultsSyntacticPhenomena
description Get titles for mimore.getFullResultsSyntacticPhenomenaByID

Parameter 1 (optional): array of strings, with each string containing a resource name
signatures
1.
return struct
parameters  
2.
return struct
parameters
array
method mimore.getFullResultsSyntacticPhenomenaByID
description Get full results

Parameter 1 (obligatory): array of structs, with each struct
- resource (obligatory) : a string containing the resource name
- id (obligatory) : a string or integer with an id
signatures
1.
return array
parameters
array
method mimore.getRecordIDsForSyntacticPhenomena
description Search syntactic phenomena in several sources.

Parameter 1 (obligatory): struct with
- syntacticphenomena (obligatory) : struct with resource name as key, and an array of strings containing syntactic phenomena as value
- kloekecodes (optional) : an array of strings

Parameter 2 (optional): integer defining a limit on the total number of results

Parameter 3 (optional): array of structs, with for each struct:
- name (obligatory) : a string containing the resource name
- limit (optional) : an integer containing the limit on the number of results for this resource.

Example methodcall:

<methodCall> <methodName>mimore.searchSyntacticPhenomena</methodName> <params> <param> <value> <struct> <member><name>diddd</name> <value><array> <data> <value> <string>genitive possessive</string> </value> </data> </array></value> </member> </struct> </value> </param> <param> <value> <int>10</int> </value> </param> </params></methodCall>
signatures
1.
return struct
parameters
struct
2.
return struct
parameters
struct
int
3.
return struct
parameters
struct
array
4.
return struct
parameters
struct
int
array
method mimore.createMap
description Only used by the Mimore Search Interface.

Parameter 1-3 : methodIds, methodData, parameters for methodIds
Parameter 4 : format
Parameter 5 : options (optional)

OR

Parameter 1 : list with kloekecodes
Parameter 2 : format
Parameter 3 : options (optional)
signatures
1.
return base64
parameters
string
string
array
string
2.
return base64
parameters
string
string
array
string
struct
3.
return base64
parameters
array
string
4.
return base64
parameters
array
string
struct
method mimore.getClientValues
description Only used by the Mimore Search Interface
signatures
1.
return struct
parameters
string
method mimore.getTagValues
description Returns the allowed values for tag categories, tag features, and a list of predefined tags
signatures
1.
return struct
parameters  
method mimore.getSyntacticPhenomena
description Returns for all relevant clients the allowed values for syntactic phenomena
signatures
1.
return struct
parameters  
method mimore.getKloekecodes
description Only used by the Mimore Search Interface
signatures
1.
return array
parameters  
2.
return array
parameters
struct
method mimore.getCommunities
description Only used by the Mimore Search Interface
signatures
1.
return array
parameters  
2.
return array
parameters
struct
method mimore.getProvinces
description Only used by the Mimore Search Interface
signatures
1.
return array
parameters  
2.
return array
parameters
struct
method mimore.getRegions
description Only used by the Mimore Search Interface
signatures
1.
return array
parameters  
2.
return array
parameters
struct
method mimore.getCountries
description Only used by the Mimore Search Interface
signatures
1.
return array
parameters  
2.
return array
parameters
struct
method system.listMethods
description This method lists all the methods that the XML-RPC server knows how to dispatch
signatures
1.
return array
parameters
string
2.
return array
parameters  
method system.methodHelp
description Returns help text if defined for the method passed, otherwise returns an empty string
signatures
1.
return string
parameters
string
method system.methodSignature
description Returns an array of known signatures (an array of arrays) for the method name passed. If no signatures are known, returns a none-array (test for type != array to detect missing signature)
signatures
1.
return array
parameters
string