Kontakte über Parameter abrufen (veraltet ab V3.95)

Für die Verwendung der Tesseron REST API benötigen Sie einen API Key. Bitte wenden Sie sich hierfür an Ihren Systemadministrator.

Sie haben die Möglichkeit Kontakte über die unterschiedlichen Kontakt Parameter wie beispielsweise den Suchnamen (searchName) abzurufen. Dabei können Sie festlegen wie viele Ergebnisse Sie erhalten möchten. Alle Nutzlasten und Eigenschaften finden Sie unter Erklärung der Werte und Schlüssel von Nutzlasten.

Abfrage

URL: http://Instanz-URL:Port/ApiContact/SearchContactByParameter
Methode: POST
Payload:

{
    "Filter": string,    
    "searchParam": string,
    "take": integer,
    "skip": integer,
    "apikey": string
}

Beispiel:

{
"Filter": null,
"searchParam": "ForeName = \"Philipp\" OR SearchName = \"1020221109\"",
"take": 10,
"skip": 0,
"apikey": "ABCXYZ"
}

Bitte beachten Sie, dass die Suchbegriffe in dem String searchParam escaped werden müssen \“ Suchbegriff\“.

Das aufgeführte Beispiel gibt Ihnen Kontakte zurück, welche den Vornamen Philipp oder den Suchnamen 1020221109 aufweisen.

Antwort

Um die Ticketinformationen über einen API Call zu erhalten, müssen Sie mindestens über Sichtberechtigungen für die Tickets verfügen.

{
    "Success": true,
    "Message": null,
    "Count": 24,
    "Filtered": 23,
    "Contacts": [
        {
            "FormOfAddress": "Herr",
            "ForeName": "Philipp",
            "ForeName2": null,
            "SureName": "Quero",
            "SearchName": "1020221109",
            "Status": null
        }
    ]
}