API
Nieuwsbrieven ophalen
Dit voorbeeld laat zien hoe je alle nieuwsbrieven van een specifieke gebruiker kunt ophalen.
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 | int | De naam van het betreffende API-bestand. | Verplicht |
requestmethod | int | 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 | |
details.ownerid | int | Het ID van de gebruiker waarvan je de nieuwsbrieven wilt ophalen. | Verplicht |
details.sortinfo | Zie de velden hieronder. | Verplicht | |
details.sortinfo.SortBy | string | Op welke volgorde de nieuwsbrieven in de array gesorteerd moeten zijn (Date, Subject, Name of Owner). | Verplicht |
details.sortinfo.direction | string | Of de sortering van laag naar hoog of andersom moet worden gedaan (Down of Up). | Verplicht |
details.Start | int | De eerste nieuwsbrief waar vanaf moet worden geteld. | Verplicht |
details.perpage | int | De nieuwsbrieven kunnen met paginering worden opgehaald. Dit getal is het aantal nieuwsbrieven per pagina. | Verplicht |
details.getLastSentDetails | boolean | Geef de gegevens terug van de laatste keer dat de nieuwsbrieven zijn verzonden. | Verplicht |
Succesvolle response
| Veld | Type | Omschrijving |
|---|---|---|
status | string | De waarde van het status-veld wordt als “SUCCESS” teruggeven bij een succesvolle respons. |
newsletterid | int | Het ID nummer van de nieuwsbrief. |
name | string | De naam van de nieuwsbrief. |
format | string | Het format van de nieuwsbrief (t = text, h = html, b = both/multipart). |
subject | string | Het onderwerp van de nieuwsbrief. |
textbody | string | De text-body van de nieuwsbrief. |
htmlbody | string | De HTML-body van de nieuwsbrief. |
createdate | int | De UNIX-timestamp van het moment van het aanmaken van de nieuwsbrief. |
active | int | Of de status van de nieuwsbrief actief is of niet. |
textbody | string | De text-body van de nieuwsbrief. |
archive | boolean | Of de nieuwsbrief in het RSS archief van de mailinglijst staat. |
ownerid | int | Het ID van de gebruiker die de nieuwsbrief heeft toegevoegd. |
username | string | De gebruikersnaam van de gebruiker. |
fullname | string | De volledige naam van de gebruiker. |
owner | string | De naam van de gebruiker. |
queueid | int | Het ID aangemaakt voor de wachtrij bij verzending. |
jobid | int | Het ID aangemaakt bij verzending. |
starttime | int | De begintijd van het verzenden van de nieuwsbrief. |
finishtime | int | De eindtijd bij het verzenden van de nieuwsbrief. |
total_recipients | int | Totaal aantal ontvangers van de nieuwsbrief. |
sendsize | int | Verzendvolume van de nieuwsbrief. |
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>newsletters</requesttype>
<requestmethod>GetNewsletters</requestmethod>
<responsetype>xml</responsetype>
<details>
<ownerid>99</ownerid>
<sortinfo>
<SortBy>Date</SortBy>
<Direction>desc</Direction>
</sortinfo>
<start>0</start>
<perpage>10</perpage>
<getLastSentDetails>false</getLastSentDetails>
</details>
</xmlrequest>