API

Nieuwsbrieven ophalen

Dit voorbeeld laat zien hoe je alle nieuwsbrieven van een specifieke gebruiker kunt ophalen.

Parameters

Parameters
VeldTypeOmschrijvingVerplicht / Optioneel
usernamestring

De gebruikersnaam wordt gebruikt om in te loggen op de MailCamp.

Verplicht
usertokenstring

De unieke token toegewezen aan de hierboven genoemde gebruiker.

Verplicht
requesttypeint

De naam van het betreffende API-bestand.

Verplicht
requestmethodint

De naam van de functie die wordt aangeroepen.

Verplicht
responsetypestring

Het format van de response. Dit kan zijn 'xml' of 'json'.

Optioneel
details

Zie de velden hieronder.

Verplicht
details.owneridint

Het ID van de gebruiker waarvan je de nieuwsbrieven wilt ophalen.

Verplicht
details.sortinfo

Zie de velden hieronder.

Verplicht
details.sortinfo.SortBystring

Op welke volgorde de nieuwsbrieven in de array gesorteerd moeten zijn (Date, Subject, Name of Owner).

Verplicht
details.sortinfo.directionstring

Of de sortering van laag naar hoog of andersom moet worden gedaan (Down of Up).

Verplicht
details.Startint

De eerste nieuwsbrief waar vanaf moet worden geteld.

Verplicht
details.perpageint

De nieuwsbrieven kunnen met paginering worden opgehaald. Dit getal is het aantal nieuwsbrieven per pagina.

Verplicht
details.getLastSentDetailsboolean

Geef de gegevens terug van de laatste keer dat de nieuwsbrieven zijn verzonden.

Verplicht

Succesvolle response

Succesvolle response
VeldTypeOmschrijving
statusstring

De waarde van het status-veld wordt als “SUCCESS” teruggeven bij een succesvolle respons.

newsletteridint

Het ID nummer van de nieuwsbrief.

namestring

De naam van de nieuwsbrief.

formatstring

Het format van de nieuwsbrief (t = text, h = html, b = both/multipart).

subjectstring

Het onderwerp van de nieuwsbrief.

textbodystring

De text-body van de nieuwsbrief.

htmlbodystring

De HTML-body van de nieuwsbrief.

createdateint

De UNIX-timestamp van het moment van het aanmaken van de nieuwsbrief.

activeint

Of de status van de nieuwsbrief actief is of niet.

textbodystring

De text-body van de nieuwsbrief.

archiveboolean

Of de nieuwsbrief in het RSS archief van de mailinglijst staat.

owneridint

Het ID van de gebruiker die de nieuwsbrief heeft toegevoegd.

usernamestring

De gebruikersnaam van de gebruiker.

fullnamestring

De volledige naam van de gebruiker.

ownerstring

De naam van de gebruiker.

queueidint

Het ID aangemaakt voor de wachtrij bij verzending.

jobidint

Het ID aangemaakt bij verzending.

starttimeint

De begintijd van het verzenden van de nieuwsbrief.

finishtimeint

De eindtijd bij het verzenden van de nieuwsbrief.

total_recipientsint

Totaal aantal ontvangers van de nieuwsbrief.

sendsizeint

Verzendvolume van de nieuwsbrief.

Foutmelding

Foutmelding
VeldTypeOmschrijving
statusstring

De waarde van het status-veld zal “FAILED” zijn.

errormessagestring

Een tekstuele boodschap om uit te leggen waarom het verzoek is mislukt.

Request voorbeeld
<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>