Meetingswitch Core

XML-RPC Web Services

About

Meetingswitch Core offers an XML-RPC endpoint for communication with the system. For help, this server supports the XML-RPC introspection methods system.listMethods(), system.methodSignature(), and system.methodHelp().

Endpoints for XML-RPC Clients

https://api.meetingswitch.net/xmlrpc/{VERSION}/{APIKEY}

TODO

Beispieldatensatz
Liste der AREA Codes
Liste der Country Codes
Liste der möglichen Sprachen (de, en, fr, nl, es)

Versions

Errors

Code	Error	Description
204	No Content	There was no content found for client
400	Bad Request	Client request was not well formed
401	Unauthorized	API Key unknown / User unknown
403	Forbidden	API Key is not active / User is not active
404	Not Found	There was no content found
409	Conflict	External ID is not found for API Key
412	Precondition Failed	Client is not valid for choosen API Key
500	Internal Server Error	unexpected server condition
501	Not Implemented	used by test method (mice.getExceptionResponse)

Methods

system.listMethods
List all available XMLRPC methods
Returns an array of methods.
system.methodHelp
Display help message for an XMLRPC method
system.methodSignature
Return a method signature
system.multicall
Multicall - boxcar feature of XML-RPC for calling multiple methods
in a single request.
Expects a an array of structs representing method calls, each element
having the keys:
- methodName
- params
Returns an array of responses, one for each method called, with the value
returned by the method. If an error occurs for a given method, returns a
struct with a fault response.
core.hello
Returns service information

return
- (string)
core.whoAmI
Returns actual client information

return
- (string)
core.theAnswerToLife
Returns the answer to life

return
- (integer)
core.getExceptionResponse
throw Exception 501 Not Implemented
user.login
login user and return userToken

param
- $email (string)
- $password (string)
- $rrgId (integer) (optinale Angabe der Rechte/Rollen Gruppe)
return
- (string)
user.whoAmI
Returns actual user information

param
- $userToken (string)
return
- (string)
user.logout
logout user

param
- $userToken (string)
return
- (boolean)
user.register
Register new user

not implemented
asup.search
search supplier and get result list in json format

param
- $searchParams (string - json encoded)
  
  mögliche Parameter:
  - stars (integer)
  - persons (integer)
  - meetingrooms (integer)
  - bedrooms (integer)
  - country (string)
    ISO 3166-1-alpha-2
  - locode (string)
    UN/LOCODE
  - distance (integer)
    max. 100 (default: 25)
  - area (string)
    areaCode
  - rows (integer)
    max. 50 (default: 25)
  - offset (integer)
    (default: 0)
  - suppliertypes (HOT,HAL,EVL,DL)
    unsorted array with value/label pairs
  - keywords
    unsorted array with value/label pairs
- $language (string)
return
- (string - json encoded)
description
searchParams are an associative array in json representation

value : mandatory
label : optional (set by API)
```
array(4) {

		  ["country"] => array(2) {

		    ["value"] => string(2) "DE"

		    ["label"] => string(11) "Deutschland"

		  }

		  ["locode"] => array(1) {

		    ["value"] => string(5) "DEFRA"

		  }

		  ["suppliertype"] => array(1) {

		    [0] => array(2) {

		      ["value"] => string(2) "HO"

		      ["label"] => string(13) "Tagungshotel"

		    }

		  }

		}
```
asup.locodeList
list for locode
asup.specialList
Liste mit Anbieter die aktive Tipps & Specials haben
asup.prepareSearch
Returns serachParams in json format

param
- $searchString (string)
- $searchLocation (string)
- $language (string)
return
- (string)
asup.getPresentationById
XML Supplier Presentation by ID

param
- $id (string)
  Supplier CODE
- $language (string)
return
- (string)
asup.getPresentationByUrl
XML Supplier Presentation by URL

param
- $url (string)
  URL
- $language (string)
return
- (string)
asup.getTestimonials
XML Supplier-Score by ID
param
- $id (string)
  Supplier CODE
- $language (string)
return
- (string)
asup.getSpecials
specials
param
- $id (string)
  Supplier CODE
- $language (string)
return
- (string)
asup.getAvailability
Verfügbarkeiten
param
- $id (string)
  Supplier CODE
- $dateStart (datetime)
- $dateEnd (datetime)
- $type (string)
return
- (string)
geo.getCountryList
Returns country list

param
- $countySearchPart (string)
  mindestens 3 Zeichen
- $language (string)
return
- (string - json encoded)
geo.getAreaList
Returns area list

param
- $areaSearchPart (string)
  mindestens 3 Zeichen
- $language (string)
return
- (string - json encoded)
geo.getLocodeList
Returns locode list

param
- $locodeSearchPart (string)
  mindestens 3 Zeichen
- $language (string)
return
- (string - json encoded)
geo.getGeoList
Returns geo list
param
- $searchString (string)
  mindestens 3 Zeichen
- geo.getLocodeData
  Returns locode data
  
  param
  - $locode (string)
  - $language (string)
  return
  - (string - json encoded)
- geo.getAreaData
  Returns area data
  param
  - $area (string)
  - $language (string)
  return
  - (string - json encoded)
- geo.getCountry
  Returns country
  
  param
  - $country (string)
  - $language (string)
  return
  - (string - json encoded)
- geo.getNearestUrbanCenterListForCountry
  Returns locode list for country
  
  param
  - $country (string)
  - $language (string)
  return
  - (string - json encoded)
- geo.getCityListForSubdivision
  Returns locode list for subdivision
  param
  - $country (string)
  - $language (string)
  return
  - (string - json encoded)
- geo.getNearestUrbanCenterListForCountryBySubdivision
  Returns locode list for country by subdivision
  param
  - $country (string)
  - $language (string)
  return
  - (string - json encoded)
- geo.getTradefairValue
  Returns tradefair information
  
  param
  - $tradefairId (integer)
  - $language (string)
  return
  - (string - json encoded)
- survey.activateSurvey
  Returns service information
  
  return
  - (string)
- survey.getTestimonials
  Returns latest surveys
  return
  - (string)