Abwesenheitsnotiz API

1 Abwesenheitsnotiz abrufen
2 Abwesenheitsnotizen eines Benutzers abfragen
3 Abwesenheitsnotiz erstellen
4 Abwesenheitsnotiz aktualisieren
5 Abwesenheitsnotiz löschen

Abwesenheitsnotiz abrufen

Endpunkt: GET - api/v1/mail/autoresponse/{autoResponseId}

Version: 2.24.30

Beschreibung: Gibt die angegebene Abewsenheitsnotiz zurück

Beispiel Request:

v1/mail/autoresponse/18

Beispiel Reponse:

{
    "Id": 18,
    "UserId": 2,
    "SignatureId": 0,
    "MailBoxId": 42,
    "StartDate": "2015-01-05T00:00:00",
    "EndDate": "2015-02-05T00:00:00",
    "Html": "Ich bin nicht da"
}

Abwesenheitsnotizen eines Benutzers abfragen

Endpunkt: GET- api/v1/mail/autoresponse?userId={userId}&skip={skip}&take={take}

Version: 2.24.30

Beschreibung: Gibt alle Abwesenheitsnotizen des Benutzers zurück

Beispiel Request:

v1/mail/autoresponse?userId=2&skip=0&take=2

Beispiel response:

[
    {
        "Id": 14,
        "UserId": 2,
        "SignatureId": 0,
        "MailBoxId": 42,
        "StartDate": "2023-10-26T00:00:00",
        "EndDate": "2023-10-26T00:00:00",
        "Html": "<html ><head></head><body style=\"\" >568</body></html>"
    },
    {
        "Id": 18,
        "UserId": 2,
        "SignatureId": 0,
        "MailBoxId": 42,
        "StartDate": "2015-01-05T00:00:00",
        "EndDate": "2015-02-05T00:00:00",
        "Html": "Mein test"
    }
]

Ab antony Version 2.24.100.51 gibt es die Parameter “fromDate” und “toDate”. Beide Parameter sind optional.

Beispiel:

Endpunkt: GET- api/v1/mail/autoresponse?userId={userId}&skip={skip}&take={take}&toDate={toDate}&fromDate={fromDate}

Beispiel Request:

v1/mail/autoresponse?userId=2&skip=0&take=2&fromDate=2015-28-04&toDate=2015-02-05

Beispiel response:

[
    {
        "Id": 18,
        "UserId": 2,
        "SignatureId": 0,
        "MailBoxId": 42,
        "StartDate": "2015-01-05T00:00:00",
        "EndDate": "2015-02-05T00:00:00",
        "Html": "Mein test"
    }
]

Das Format für das Datum muss yyyy-dd-mm sein!

Abwesenheitsnotiz erstellen

Endpunkt: POST- api/v1/mail/autoresponse

Version: 2.24.30

Beschreibung: Erstellt eine Abwesenheitsnotiz

Beispiel Request:

v1/mail/autoresponse

Body:

{
    "mailBoxId": 42,
    "userId":2,
    "signatureId":0,
    "startDate": "01.05.2015",
    "endDate":"02.05.2015",
    "html": "Mein test"
}

Beispiel response:

{
    "ReturnCode": 0,
    "AutoResponseId": 18,
    "Message": null
}

Abwesenheitsnotiz aktualisieren

Endpunkt: PUT- api/v1/mail/autoresponse?autoResponseId={autoResponseId}

Version: 2.24.30

Beschreibung: Aktualisiert die angegebene Abwesenheitsnotiz

Beispiel Request:

v1/mail/autoresponse?autoResponseId=224

Body:

{
    "mailBoxId": 42,
    "userId":2,
    "signatureId":0,
    "startDate": "01.05.2015",
    "endDate":"02.05.2015",
    "html": "Mein test 123"
}

Beispiel response:

{
    "Id": 18,
    "SignatureId": 0,
    "MailBoxId": 42,
    "StartDate": "01.05.2015",
    "EndDate":"02.05.2015",
    "Html": "Mein test 123"
    "UserId": 2
}

Abwesenheitsnotiz löschen

Endpunkt: DELETE- api/v1/mail/autoresponse/{autoResponseId}

Version: 2.24.30

Beschreibung: Löscht die angegebene Abwesenheitsnotiz

Beispiel Request:

v1/mail/autoresponse/18

Beispiel response:

{
    "ReturnCode": 0,
    "Message": null
}