PodporaAPI dokumentace

mailkit.profile.queries.list

Funkce mailkit.profile.queries.list vrací seznam uložených podmínek na daném účtu.

Ukázka volání API

XML-RPC

<?xml version="1.0"?>
<methodCall>
  <methodName>mailkit.profile.queries.list</methodName>
  <params>
    <param>
      <value>
        <int>client_id</int>
      </value>
    </param>
    <param>
      <value>
        <string>client_md5</string>
      </value>
    </param>
  </params>
</methodCall>

JSON

{  
   "function":"mailkit.profile.queries.list",
   "id":"client_id",
   "md5":"client_md5",
   "parameters":{  }   
}

Hodnoty

client_id * = API ID naleznete ve svém Mailkit účtu v menu Profil / Integrace / Nastavení API.
client_md5 * = MD5 kód naleznete ve svém Mailkit účtu v menu Profil / Integrace / Nastavení API.

* povinný parametr

Po úspěšném volání se vrací:

XML-RPC

<?xml version="1.0" encoding="utf-8"?>
<methodResponse>
 <params>
  <param>
   <value>
    <struct>
     <member>
      <name>error_status</name>
      <value>
       <i4>0</i4>
      </value>
     </member>
     <member>
      <name>data</name>
      <value>
       <array>
        <data>
         <value>
          <struct>
           <member>
            <name>DATE</name>
            <value>
             <string>2016-02-26 19:48:43</string>
            </value>
           </member>
           <member>
            <name>CHANGE_DATE</name>
            <value>
             <string>2016-02-26 20:05:57</string>
            </value>
           </member>
           <member>
            <name>CHANGE_NAME</name>
            <value>
             <string>change_name</string>
            </value>
           </member>
           <member>
            <name>ID_QUERY</name>
            <value>
             <i4>123</i4>
            </value>
           </member>
           <member>
            <name>NAME</name>
            <value>
             <string>name</string>
            </value>
           </member>
           <member>
            <name>DESCRIPTION</name>
            <value>
             <string>description</string>
            </value>
           </member>
           <member>
            <name>CREATE_NAME</name>
            <value>
             <string>create_name</string>
            </value>
           </member>
          </struct>
         </value>
        </data>
       </array>
      </value>
     </member>
    </struct>
   </value>
  </param>
 </params>
</methodResponse>

JSON

{
    "data": [

        {
            "CREATE_NAME": "create_name",
            "CHANGE_DATE": "0000-00-00 00:00:00",
            "CHANGE_NAME": "",
            "DESCRIPTION": "description",
            "DATE": "2017-10-09 09:31:04",
            "NAME": "name",
            "ID_QUERY": 123
        }
    ],
    "error_status": 0
}

Hodnoty

error_status = 0 - volání proběhlo bez chyby, 1 - volání se nepodařilo zpracovat

NAME = jméno pravidla

DESCRIPTION = popis pravidla

ID_QUERY = ID pravidla

CREATE_NAME = jméno uživatele, jež pravidlo uložil

DATE = datum uložení pravidla

CHANGE_NAME = jméno uživatele, jež pravidlo naposledy editoval

CHANGE_DATE = datum poslední editace pravidla