API
Extra velden ophalen
De XML document structuur voor het ophalen van extra velden van een mailinglijst is als volgt:
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 | |
listid | int | De ID's van de mailinglijst waarvoor de extra veld gegevens worden opgevraagd. | Verplicht |
Succesvolle response
| Veld | Type | Omschrijving |
|---|---|---|
status | string | De waarde van het status-veld wordt als “SUCCESS” teruggeven bij een succesvolle respons. |
data | int | Indien de statistieken worden gevonden wordt het object teruggegeven. |
fieldid | int | Het ID nummer van het betreffende extra veld. |
name | string | De naam van het extra veld. |
fieldtype | int | Het extra veld type (tekst, getal etc.). |
defaultvalue | string | Indien u een standaard waarde heeft ingevuld zal die hier worden weergegeven. |
required | string | Indien het een verplicht veld is zal dit hier worden weergegeven (1 of 0). |
fieldsettings | int | Seriële versie van de extra velden instellingen. |
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>lists</requesttype>
<requestmethod>GetCustomFields</requestmethod>
<responsetype>xml</responsetype>
<details>
<listids>
99
</listids>
</details>
</xmlrequest>