API

Contactpersoon ophalen

Dit voorbeeld geeft een XML terug met het totaal aantal contactpersonen van een bepaalde mailinglijst, alsmede een overzicht van alle contactpersonen in de betreffende lijst.

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
requesttypestring

De naam van het betreffende API-bestand.

Verplicht
requestmethodstring

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.Listint

Het ID van de mailinglijst waarop de contactpersoon staat.

Verplicht
details.List.Emailstring

Het e-mailadres van de contactpersoon die u probeert te vinden

Optioneel
details.List.Confirmedboolean

De bevestigingsstatus van de contactpersoon die u probeert te vinden (0 of 1)

Optioneel
details.List.Statusboolean

De status van de contactpersoon; a (active), b (bounced) of u (unsubscribed)

Verplicht
details.List.DateSearch / DateUpdatedSearch

Filter op een specifieke datum interval gebaseerd op de inschrijfdatum. Vul de datum in als unix timestamp in het StartDate en optioneel in het EndDate veld. 5 verschillende types:

Optioneel
details.List.DateSearch / DateUpdatedSearch.afterstring

Alle contactpersonen ingeschreven ná de opgegeven datum.

Optioneel
details.List.DateSearch / DateUpdatedSearch.betweenstring

Alle contactpersonen ingeschreven tussen 2 bepaalde datums. Geef de eind datum op in het veld EndDate.

Optioneel
details.List.DateSearch / DateUpdatedSearch.beforestring

Alle contactpersonen ingeschreven vóór de opgegeven datum.

Optioneel
details.List.DateSearch / DateUpdatedSearch.exact/exactlystring

Alle contactpersonen ingeschreven precies op de opgegeven datum.

Optioneel
details.List.DateSearch / DateUpdatedSearch.notstring

Alle contactpersonen ingeschreven die niet zijn ingeschreven op de opgegeven datum.

Optioneel
details.List.Newsletterint

Het ID van een nieuwsbrief die de contactpersoon moet hebben geopend.

Optioneel
details.List.Tagsint

Het ID van de tag van een contactpersoon.

Optioneel
details.List.SortBystring

Op welke volgorde de nieuwsbrieven in de array gesorteerd moeten zijn (subscribedate, emailaddress, format, status of confirmed).

Optioneel
details.List.Directionstring

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

Optioneel
details.List.startint

Eerste pagina vanaf waar gezocht moet worden.

Optioneel
details.List.perpagestring

Aantal contacten per resultaat. Standaard is 10. Waarde 'all' geeft alle records terug.

Optioneel

Succesvolle response

Succesvolle response
VeldTypeOmschrijving
statusstring

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

countint

Het totale aantal contactpersonen.

subscriberlistint

Een overzicht van alle e-mailadressen van de contactpersonen.

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>subscribers</requesttype>
	<requestmethod>GetSubscribers</requestmethod>
	<responsetype>xml</responsetype>
	<details>
		<countonly>false</countonly>
		<searchinfo>
			<List>99</List>
			<Email>@uwdomein.nl</Email>
			<Confirmed>1</Confirmed>
			<DateSearch>
				<filter>true</filter>
				<type>after</type>
				<StartDate>1483228800</StartDate>
			</DateSearch>
			<DateUpdatedSearch>
				<filter>true</filter>
				<type>between</type>
				<StartDate>1483228800</StartDate>
				<EndDate>1559347200</EndDate>
			</DateUpdatedSearch>
			<Newsletter>99</Newsletter>
			<Tags>99</Tags>
		</searchinfo>
		<sortdetails>
			<SortBy>subscribedate</SortBy>
			<Direction>asc</Direction>
		</sortdetails>
		<start>0</start>
		<perpage>10</perpage>
	</details>
</xmlrequest>