Wysyłanie żądań do iCOMM

Żądanie "zaszyte" w odpowieniej strukturze opisanje poniżej muszą być wysyłane na adres https://mojanazwa.icomm.pl/api , gdzie "mojanazwa" powinno zostać zastąpione nazwą odpowiedniej instancji iCOMM. Wynikiem wysłania żądania jest XML zawierający odpwiedź o strukturze opisanej poniżej.

Struktura XML dla wysyłanych żądąń

Przykładowy plik XML zawierający poprawne żądanie dla iCOMM wygląda następująco:

<?xml version="1.0" encoding="UTF-8"?>
<data>
    <username>test@icomm.pl</username>
    <password>1e8520cd4cdf360bdc9988c185313b78</password>
    <object>message</object>
    <operation>add</operation>
    <params>
        <threadid>14</threadid>
        <content><![CDATA[Zgadzam się. Według mnie to jest bardzo dobry pomysł]]></content>
    </params>
</data>

W strukturze tej występują następujące elementy:

username - nazwa użytkownika iCOMM
password - zapisane w postaci MD5 hasło użytkownika
object - obiekt iCOMM którego funkcję chcemy wywołać
operation - nazwa wywoływanej funkcji
params - zestaw parametrów, które mają zostać przekazane do wywoływanej funkcji, które są opisane w sekcji "Parametry" każdej udostępnionej funkcji

Struktura XML dla otrzymywanych odpowiedzi

Przykładowa odpowiedź uzyskana z systemu iCOMM wygląda następująco:

<?xml version="1.0" encoding="UTF-8"?>
<data>
    <code>1</code>
    <msg>OK</msg>
    <result>
        <threadid>13</threadid>
        <messageid>41</messageid>
    </result>
</data>

W strukturze tej wyróżniamy następujące elementy:

code - kod wykonania operacji. 1 oznacza zawsze poprawne wykonanie
msg - komunikat związany z otrzymanym kodem
result - zawiera dodatkowe elementy zwracane przez konkretną funkcję (opisane w sekcji "Dodatkowa odpowiedź" każdej udostępnionej funkcji)