ProSonata API

Kontakte: Ansprechpartner

Folgende HTTP-Methoden stehen für Ansprechpartner zur Verfügung:

• GET: Ressource lesen
• POST: Ressource erstellen
• PUT: Ressource bearbeiten

Zugriff ab Benutzergruppe Zeiterfasser 2.

GET /api/v1/contacts

Antwort:

{
  "meta": {
    "status": 200,
    "perPage": 100,
    "page": 1,
    "totalCount": 85,
    "requestUserID": 1,
    "requestUsername": "Admin1",
    "usergroupName": "Administrator",
    "apiLimitRemaining": 436,
    "apiLimitReset": 516
  },
  "data": [
    {
      "contactID": 48,
      "title": "Herr",
      "firstName": "Karl",
      "lastName": "Schmidt",
      "customerID": 10,
      "customerName": "ABC Versicherung",
      "addressID": 36,
      "name1": "ABC Versicherung AG",
      "name2": "",
      "street": "Unfallstraße",
      "streetNo": 23,
      "postalCode": 12345,
      "city": "Hamburg",
      ...
    },
    ...
  ]
}

Über Parameter kann gefiltert werden:

GET /api/v1/contacts?lastName=Meier

Nach folgenden Parametern kann sortiert werden (Sortierrichtung ggf. mit ASC bzw. DESC ergänzen):

contactID, customerID, addressID, firstName, lastName, birthday, postalCode, city, country, accountManagerUserID, active

GET /api/v1/contacts/{id}

Antwort:

{
  "meta": {
    "status": 200,
    "requestUserID": 1,
    "requestUsername": "Admin1",
    "usergroupName": "Administrator",
    "apiLimitRemaining": 446,
    "apiLimitReset": 723
  },
  "data": {
    "contactID": 48,
    "title": "Herr",
    "firstName": "Karl",
    "lastName": "Schmidt",
    "customerID": 10,
    "customerName": "ABC Versicherung",
    "addressID": 36,
    "name1": "ABC Versicherung AG",
    "name2": "",
    "street": "Unfallstraße",
    "streetNo": 23,
    "postalCode": 12345,
    "city": "Hamburg",
    "country": "",
    "position": "",
    "department": "",
    "email": "karl.schmidt@versicherung.de",
    "email2": "",
    "telephone": "01234 5678945",
    "fax": "",
    "mobile": "",
    "telephonePrivate": "",
    "mobilePrivate": "",
    "streetPrivate": "",
    "streetNoPrivate": "",
    "postalCodePrivate": "",
    "cityPrivate": "",
    "countryPrivate": "",
    "usePrivateForCSV": 0,
    "messenger": "",
    "socialMedia": "",
    "website": "",
    "comments": "",
    "birthday": "1967-02-07",
    "contactFilter1": 0,
    "contactFilter2": 1,
    "contactFilter3": 1,
    "contactFilter4": 1,
    "contactFilter5": 0,
    "contactFilter6": 0,
    "contactFilter7": 0,
    "contactFilter8": 0,
    "contactFilter9": 0,
    "contactFilter10": 0,
    "accountManagerUserID": null,
    "createdByUserID": 1,
    "contactCreationDate": null,
    "editedByUserID": 1,
    "active": 1,
    "isLocked": 0,
    "contactViaApi": 0
  }
}

POST /api/v1/contacts

Eine neue Firma/Gruppe bzw. eine neue Adresse muss zunächst über die entsprechende Ressource erstellt werden!

Notwendige und mögliche Parameter im Body:

Beispiel:

{
    "title": "Herr",
    "firstName": "Karl",
    "lastName": "Schmidt",
    "customerID": 10,
    "addressID": 36,
    "email": "karl.schmidt@versicherung.de",
    "telephone": "01234 5678945",
    "birthday": "1967-02-07",
    "contactFilter1": 1,
    "contactFilter3": 1
}

PUT /api/v1/contacts/{id}

Es müssen nicht alle Parameter für eine Bearbeitung übergeben werden.

Es stehen die Parameter zum Erstellen der Ressource zur Verfügung (s.o.).