Verstuur email

<< Klik hier om de inhoudsopgave te tonen >>

Navigatie:  API aanroepen >

Verstuur email

Aanroep

Naam: SendEmail

 

Aanroep structuur

<?xml version="1.0" encoding="utf-8"?>

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/" xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">

<SOAP-ENV:Header/>

<S:Body>

  <ns2:SendEmail xmlns:ns2="https://api.stip-t.nl/v1/">

    <securityToken></securityToken>

    <emailtemplateName></emailtemplateName>

    <relationNo></relationNo>

    <emailInvoice>

      <invoiceNo></invoiceNo>

      <attachPdf></attachPdf>

      <attachUbl></attachUbl>

    </emailInvoice>

    <attachments>

      <attachment>

        <filename></filename>

        <content></content>

      </attachment>

    </attachments>

    <replaceKeyValues>

      <keyValue>

        <key></key>

        <value></value>

      </keyValue>

    </replaceKeyValues>

  </ns2:SendEmail>

</S:Body>

</S:Envelope>

 

Verklaring

Tag/veldnaam

Type

Opmerkingen/beperkingen

Omschrijving

securityToken

string

verplicht

securityToken verkregen bij login

relationNo1)

string

optioneel: invullen indien een email naar een relatie moet worden verzonden.

relatienummer

emailInvoice

EmailInvoice (optioneel: invullen indien een email over een factuur moet worden verzonden).

Tag/veldnaam

Type

Opmerkingen/beperkingen

Omschrijving

invoiceNo1)

string

Vul een invoiceNo, indien een email over een factuur moet worden verzonden.

factuurnummer

attachPdf

boolean

Moet de factuur als pdf worden bijgesloten (true/false)?

pdf factuur bijvoegen

attachUbl

boolean

Moet de factuur als ubl worden bijgesloten (true/false)?

ubl factuur bijvoegen

attachments

List<Attachment> (0 of meer)

Hiermee kunnen extra bestanden worden bijgesloten.

Tag/veldnaam

Type

Opmerkingen/beperkingen

Omschrijving

filename

string

verplicht. De bestandsnaam (zonder pad), bijv: test.pdf (niet C:\temp\test.pdf)

bestandsnaam

content

byte[]

base64 encoded byte array

de inhoud van het bestand

replaceKeyValues

List<KeyValue> (o of meer)

Vervang stukken tekst in de inhoud van het e-mailbericht.

Tag/veldnaam

Type

Opmerkingen/beperkingen

Omschrijving

key

string

Deze tekst wordt opgezocht in het e-mailbericht en vervangen door de value.

sleutel

value

string

De tekst die in het bericht moet komen op de plaats van de key.

waarde

1) Het is verplicht om een relationNo óf een invoiceNo in te vullen.  

 

Antwoord

Naam: SendEmailResponse

 

Antwoord structuur

<?xml version="1.0" encoding="utf-8"?>

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/" xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">

<SOAP-ENV:Header/>

<S:Body>

  <ns2:SendEmailResponse xmlns:ns2="https://api.stip-t.nl/v1/">

    <result>

      <error/>

      <errorMessage/>

    </result>

  </ns2:SendEmailResponse>

</S:Body>

</S:Envelope>

 

Verklaring

Tag/veldnaam

Type

result

RequestResult

Tag/veldnaam

Type

Omschrijving

error

boolean

false indien geen fouten, true indien er fouten zijn opgetreden

errorMessage

string

foutboodschap, alleen gevuld indien error = true