API
Contactpersoon extra velden
Dit voorbeeld geeft een XML terug met de extra veld gegevens en tags van één specifieke contactpersoon van een bepaalde mailinglijst.
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 | |
details.subscriberid | int | Het ID van de contactpersoon. | Verplicht |
details.listid | int | Het ID van de mailinglijst waarop de contactpersoon staat. | Verplicht |
details.activeonly | string | Hiermee kan worden aangegeven of alleen op actieve contacten moet worden gezocht. Default: false. | Optioneel |
details.include_customfields | string | Hiermee kan worden aangegeven of ook de extra veld data moet worden teruggegeven. Default: true. | Optioneel |
details.include_tags | string | Hiermee kan worden aangegeven of ook de tags moet worden teruggegeven. Default: true. | Optioneel |
details.include_bouncedetails | string | Hiermee kan worden aangegeven of ook de bounce data moet worden teruggegeven. Default: false. | Optioneel |
Succesvolle response
| Veld | Type | Omschrijving |
|---|---|---|
status | string | De waarde van het status-veld wordt als “SUCCESS” teruggeven bij een succesvolle respons. |
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>subscribers</requesttype>
<requestmethod>LoadSubscriberList</requestmethod>
<responsetype>xml</responsetype>
<details>
<subscriberid>99</subscriberid>
<listid>99</listid>
<activeonly>false</activeonly>
<include_customfields>true</include_customfields>
<include_tags>true</include_tags>
<include_bouncedetails>false</include_bouncedetails>
</details>
</xmlrequest>