API
Tags ophalen
Dit voorbeeld laat zien hoe je tags ophaalt.
Parameters
| Veld | Type | Omschrijving | Verplicht / Optioneel |
|---|---|---|---|
username | string | De gebruikersnaam wordt gebruikt om in te loggen op de MailCamp. | Verplicht |
usertoken | string | De unieke token toegewezen aan de hierboven genoemde gebruiker. | Verplicht |
requesttype | string | De naam van het betreffende API-bestand. | Verplicht |
requestmethod | string | De naam van de functie die wordt aangeroepen. | Verplicht |
responsetype | string | Het format van de response. Dit kan zijn 'xml' of 'json'. | Optioneel |
details | Zie de velden hieronder. | Verplicht | |
tags | tags | De ID's van de tags die je wilt ophalen. Kommagescheiden indien je meerdere tags wilt ophalen. | Optioneel |
ownerid | int | Het ID van de gebruiker waarvan de tags moeten worden opgehaald. | Verplicht |
countonly | string | Of alleen het aantal moet worden teruggegeven. Default: false. | Optioneel |
countonly.SortBy | string | Op welke volgorde de tags in de array gesorteerd moeten zijn (name, createdate). | Optioneel |
countonly.Direction | string | Of de sortering van laag naar hoog of andersom moet worden gedaan (Down of Up). | Optioneel |
start | int | Geef het getal vanaf welk punt het resultaat moet worden teruggegeven. Default: 0 (eerste resultaat). | Optioneel |
perpage | string | Het aantal lijsten dat per result moet worden teruggeven. Kies 'all' voor alle lijsten. Default: 10 | Optioneel |
Succesvolle response
| Veld | Type | Omschrijving |
|---|---|---|
status | string | De waarde van het status-veld wordt als “SUCCESS” teruggeven bij een succesvolle respons. |
data | Indien de statistieken worden gevonden wordt het object teruggegeven. |
Foutmelding
| Veld | Type | Omschrijving |
|---|---|---|
status | string | De waarde van het status-veld zal “FAILED” zijn. |
errormessage | string | Een tekstuele boodschap om uit te leggen waarom het verzoek is mislukt. |
<xmlrequest>
<username>admin</username>
<usertoken>0123456789abcdef0123456789abcdef01234567</usertoken>
<requesttype>tags</requesttype>
<requestmethod>GetTags</requestmethod>
<responsetype>xml</responsetype>
<details>
<tags>99</tags>
<ownerid>99</ownerid>
<countonly>false</countonly>
<sortdetails>
<SortBy>name</SortBy>
<Direction>asc</Direction>
</sortdetails>
<start>0</start>
<perpage>10</perpage>
</details>
</xmlrequest>