Inhoudsopgave



Xanti API



Met de Xanti Application Programming Interface (API) kan data geëxporteerd en gedownload worden.

De web service is RESTful en geeft bij een fout een response in JSON (JavaScript Object Notation) terug met altijd de volgende drie velden:

  • error - Boolean
  • message - String
  • result - Mixed

De web service kan de volgende HTTP response codes terug geven:
  • 200 OK
  • 400 Bad Request
  • 401 Unauthorized
  • 404 Not Found
  • 500 Internal Server Error
  • 501 Not Implemented
Alle API calls hebben een Authorization header nodig met daarin een API key.
Neem contact met ons op indien u gebruik wilt maken van de Xanti API.

Functions

Export Query

GET /api/export_query

Export data from a given query name.

Parameters:

  • name - String: (required)
  • type - String: 'json' (default), 'tsv', 'csv' or 'xls'

Export Object

GET /api/export_obj

Export generic folder/object data.

Parameters:

  • tpl - String: Template name (required) like 'news', 'agenda' or 'user'.
  • pid - Integer: Parent ID
  • type - String: 'tsv' (default), 'csv' or 'xls'
  • skip_text_fields - Integer: 1

Export Answer

GET /api/export_answer

Export all survey results which let you see how each respondent answered a survey.

Parameters:

  • pid - Integer: Parent ID (required)
  • type - String: 'tsv' (default), 'csv', 'xls' or 'sps'
  • skip_text_fields - Integer: 1