Last Update: 2019-10-02

Get topics

Request:

<?xml version="1.0"?>
<gettopics customerid="">
  <language></language>
  <page></page>
  <pagesize></pagesize>
  <orderfield></orderfield>
  <orderdir></orderdir>
  <search></search>
</gettopics>
Description of XML-Tags:
Element Format Required Description
gettopics
↳ @customerid int CustomerID of customer used for request. Only usable with admin customer privileges.
↳ language de|en|... yes Get topics in given language
↳ page int
↳ pagesize int
↳ orderfield varchar Order by field
↳ orderdir ASC|DESC Order topics ascending or descending/td>
↳ search varchar

Response:

<?xml version="1.0"?>
<response>
  <code>2000</code>
  <description><![CDATA[OK]]></description>
  <data>
    <topic id="" externalid="">
      <title></title>
      <description></description>
    </topic>
    ...
  </data>
</response>

Get single topic

Request:

<?xml version="1.0" encoding="utf-8"?>
<gettopic id="" externalid="" customerid="">
  <language></language>
</gettopic>
Description of XML-Tags:
Element Format Description
gettopic
↳ @id int ID of topcic
↳ @externalid varchar External ID of topic (overruled by id)
↳ @customerid int Optional: CustomerID of customer used for request. Only usable with admin customer privileges.
↳ language de|en|... Get topics in given language

Response:

<?xml version="1.0"?>
<response>
  <code>2000</code>
  <description><![CDATA[OK]]></description>
  <data>
    <title></title>
    <description></description>
  </data>
</response>

Insert/update topic

Request:

<?xml version="1.0" encoding="utf-8"?>
<topicinsert id="" externalid="" customerid="">
  <title lang="de"></title>
  <description lang="de"></description>
  <title lang="en"></title>
  <description lang="en"></description>
  ...
</topicinsert>
Description of XML-Tags:
Element Format Description
topicinsert
↳ @id int ID of topcic
↳ @externalid varchar External ID of topic (overruled by id)
↳ @customerid int Optional: CustomerID of customer used for request. Only usable with admin customer privileges.
↳ title varchar(255) Title of topic
  ↳ @lang de|en|... Language of title
↳ description varchar(255) Description of topic
  ↳ @lang de|en|... Language of description

Response:

The internal ID of the topic record will be returned within response->data.

Delete topic

Request:

<?xml version="1.0" encoding="utf-8"?>
<topicdelete id="" externalid="" customerid="" />
Description of XML-Tags:
Element Format Description
topicdelete
↳ @id int ID of topcic
↳ @externalid varchar External ID of topic (overruled by id)
↳ @customerid int Optional: CustomerID of customer used for request. Only usable with admin customer privileges.

Response:

There is no return value in response->data.

Für Rückfragen stehen wir Ihnen jederzeit gerne unter support@eyepin.com zur Verfügung.