Zum Inhalt springen
Developer

Session

Offene Daten4 EndpunktePublic / Session

Neue öffentliche Sitzung abrufen oder starten

GET/api/cp/public_session

Antworten

200Neue öffentliche Sitzung abrufen oder startenPublicSession

Felder anzeigen (22)
  • tokenstring

    Token, das die öffentliche Sitzung identifiziert.

  • person_first_namestring

    Vorname der Person, die in der Sitzung erfasst wurde.

  • person_last_namestring

    Nachname der in der Sitzung eingegebenen Person.

  • person_emailstring

    E-Mail-Adresse der Person, die in der Sitzung eingegeben wurde.

  • person_phonestring

    In der Sitzung erfasste Telefonnummer der Person.

  • company_namestring

    Name der in der Sitzung erfassten Firma.

  • company_emailstring

    E-Mail-Adresse der Firma, die in der Sitzung eingegeben wurde.

  • company_phonestring

    In der Sitzung erfasste Telefonnummer des Unternehmens.

  • company_addressstring

    Adresse des Unternehmens als Text.

  • company_address_street_levelstring

    Straße und Hausnummer der Unternehmensadresse.

  • company_address_costring

    Care-of-Zeile der Unternehmensadresse.

  • company_address_citystring

    Ort der Unternehmensadresse.

  • company_address_zipstring

    Postleitzahl der Unternehmensadresse.

  • company_address_countrystring

    Land der Unternehmensadresse.

  • person_addressstring

    Adresse der Person als Text.

  • person_address_street_levelstring

    Straße und Hausnummer der Personenadresse.

  • person_address_costring

    Care-of-Zeile der Personenadresse.

  • person_address_citystring

    Ort der Personenadresse.

  • person_address_zipstring

    Postleitzahl der Personenadresse.

  • person_address_countrystring

    Land der Personenadresse.

  • person_birthdaystring (date-time)

    Geburtstag der in der Sitzung erfassten Person.

  • person_genderstring

    Geschlecht der Person, die in der Sitzung erfasst wurde.

Anfrage
curl --request GET \
  --url https://eure-instanz.iw-erp.de/api/cp/public_session
Antwort 200 application/json
{
  "person_first_name": "Beispiel",
  "person_last_name": "Beispiel",
  "person_email": "lena.hartmann@example.org",
  "person_phone": "+49 511 123456",
  "company_name": "Beispiel",
  "company_email": "lena.hartmann@example.org",
  "company_phone": "+49 511 123456",
  "company_address_city": "Hannover",
  "company_address_zip": "30163",
  "company_address_country": "DE"
}

Felder der öffentlichen Sitzung aktualisieren / anlegen

POST/api/cp/public_session

Request-Body application/json

  • dataPublicSession2
    Felder anzeigen (21)
    • person_first_namestring

      Vorname der Person, die in der Sitzung erfasst wurde.

    • person_last_namestring

      Nachname der in der Sitzung eingegebenen Person.

    • person_emailstring

      E-Mail-Adresse der Person, die in der Sitzung eingegeben wurde.

    • person_phonestring

      In der Sitzung erfasste Telefonnummer der Person.

    • company_namestring

      Name der in der Sitzung erfassten Firma.

    • company_emailstring

      E-Mail-Adresse der Firma, die in der Sitzung eingegeben wurde.

    • company_phonestring

      In der Sitzung erfasste Telefonnummer des Unternehmens.

    • company_addressstring

      Adresse des Unternehmens als Text.

    • company_address_street_levelstring

      Straße und Hausnummer der Unternehmensadresse.

    • company_address_costring

      Care-of-Zeile der Unternehmensadresse.

    • company_address_citystring

      Ort der Unternehmensadresse.

    • company_address_zipstring

      Postleitzahl der Unternehmensadresse.

    • company_address_countrystring

      Land der Unternehmensadresse.

    • person_addressstring

      Adresse der Person als Text.

    • person_address_street_levelstring

      Straße und Hausnummer der Personenadresse.

    • person_address_costring

      Care-of-Zeile der Personenadresse.

    • person_address_citystring

      Ort der Personenadresse.

    • person_address_zipstring

      Postleitzahl der Personenadresse.

    • person_address_countrystring

      Land der Personenadresse.

    • person_birthdaystring (date-time)

      Geburtstag der in der Sitzung erfassten Person.

    • person_genderstring

      Geschlecht der Person, die in der Sitzung erfasst wurde.

Antworten

200Felder der öffentlichen Sitzung aktualisierenPublicSession3

Felder anzeigen (25)
  • idinteger

    Primärschlüssel der öffentlichen Sitzung. Interne ID.

  • tokenstring

    Token, das die öffentliche Sitzung identifiziert.

  • person_first_namestring

    Vorname der Person, die in der Sitzung erfasst wurde.

  • person_last_namestring

    Nachname der in der Sitzung eingegebenen Person.

  • person_emailstring

    E-Mail-Adresse der Person, die in der Sitzung eingegeben wurde.

  • person_phonestring

    In der Sitzung erfasste Telefonnummer der Person.

  • company_namestring

    Name der in der Sitzung erfassten Firma.

  • company_emailstring

    E-Mail-Adresse der Firma, die in der Sitzung eingegeben wurde.

  • company_phonestring

    In der Sitzung erfasste Telefonnummer des Unternehmens.

  • company_addressstring

    Adresse des Unternehmens als Text.

  • company_address_street_levelstring

    Straße und Hausnummer der Unternehmensadresse.

  • company_address_costring

    Care-of-Zeile der Unternehmensadresse.

  • company_address_citystring

    Ort der Unternehmensadresse.

  • company_address_zipstring

    Postleitzahl der Unternehmensadresse.

  • company_address_countrystring

    Land der Unternehmensadresse.

  • person_addressstring

    Adresse der Person als Text.

  • person_address_street_levelstring

    Straße und Hausnummer der Personenadresse.

  • person_address_costring

    Care-of-Zeile der Personenadresse.

  • person_address_citystring

    Ort der Personenadresse.

  • person_address_zipstring

    Postleitzahl der Personenadresse.

  • person_address_countrystring

    Land der Personenadresse.

  • person_birthdaystring (date-time)

    Geburtstag der in der Sitzung erfassten Person.

  • person_genderstring

    Geschlecht der Person, die in der Sitzung erfasst wurde.

  • createdstring (date-time)

    Zeitpunkt, zu dem der Datensatz angelegt wurde.

  • updatedstring (date-time)

    Zeitpunkt, zu dem der Datensatz zuletzt aktualisiert wurde.

Anfrage
curl --request POST \
  --url https://eure-instanz.iw-erp.de/api/cp/public_session \
  --header 'content-type: application/json' \
  --data '
{
  "data": {
    "person_first_name": "Beispiel",
    "person_last_name": "Beispiel",
    "person_email": "lena.hartmann@example.org",
    "person_phone": "+49 511 123456",
    "company_name": "Beispiel",
    "company_email": "lena.hartmann@example.org"
  }
}
'
Antwort 200 application/json
{
  "id": 42,
  "person_first_name": "Beispiel",
  "person_last_name": "Beispiel",
  "person_email": "lena.hartmann@example.org",
  "person_phone": "+49 511 123456",
  "company_name": "Beispiel",
  "company_email": "lena.hartmann@example.org",
  "company_phone": "+49 511 123456",
  "company_address_city": "Hannover",
  "company_address_zip": "30163"
}

Felder der öffentlichen Sitzung aktualisieren / anlegen

PUT/api/cp/public_session

Request-Body application/json

  • dataPublicSession2
    Felder anzeigen (21)
    • person_first_namestring

      Vorname der Person, die in der Sitzung erfasst wurde.

    • person_last_namestring

      Nachname der in der Sitzung eingegebenen Person.

    • person_emailstring

      E-Mail-Adresse der Person, die in der Sitzung eingegeben wurde.

    • person_phonestring

      In der Sitzung erfasste Telefonnummer der Person.

    • company_namestring

      Name der in der Sitzung erfassten Firma.

    • company_emailstring

      E-Mail-Adresse der Firma, die in der Sitzung eingegeben wurde.

    • company_phonestring

      In der Sitzung erfasste Telefonnummer des Unternehmens.

    • company_addressstring

      Adresse des Unternehmens als Text.

    • company_address_street_levelstring

      Straße und Hausnummer der Unternehmensadresse.

    • company_address_costring

      Care-of-Zeile der Unternehmensadresse.

    • company_address_citystring

      Ort der Unternehmensadresse.

    • company_address_zipstring

      Postleitzahl der Unternehmensadresse.

    • company_address_countrystring

      Land der Unternehmensadresse.

    • person_addressstring

      Adresse der Person als Text.

    • person_address_street_levelstring

      Straße und Hausnummer der Personenadresse.

    • person_address_costring

      Care-of-Zeile der Personenadresse.

    • person_address_citystring

      Ort der Personenadresse.

    • person_address_zipstring

      Postleitzahl der Personenadresse.

    • person_address_countrystring

      Land der Personenadresse.

    • person_birthdaystring (date-time)

      Geburtstag der in der Sitzung erfassten Person.

    • person_genderstring

      Geschlecht der Person, die in der Sitzung erfasst wurde.

Antworten

200Felder der öffentlichen Sitzung aktualisierenPublicSession3

Felder anzeigen (25)
  • idinteger

    Primärschlüssel der öffentlichen Sitzung. Interne ID.

  • tokenstring

    Token, das die öffentliche Sitzung identifiziert.

  • person_first_namestring

    Vorname der Person, die in der Sitzung erfasst wurde.

  • person_last_namestring

    Nachname der in der Sitzung eingegebenen Person.

  • person_emailstring

    E-Mail-Adresse der Person, die in der Sitzung eingegeben wurde.

  • person_phonestring

    In der Sitzung erfasste Telefonnummer der Person.

  • company_namestring

    Name der in der Sitzung erfassten Firma.

  • company_emailstring

    E-Mail-Adresse der Firma, die in der Sitzung eingegeben wurde.

  • company_phonestring

    In der Sitzung erfasste Telefonnummer des Unternehmens.

  • company_addressstring

    Adresse des Unternehmens als Text.

  • company_address_street_levelstring

    Straße und Hausnummer der Unternehmensadresse.

  • company_address_costring

    Care-of-Zeile der Unternehmensadresse.

  • company_address_citystring

    Ort der Unternehmensadresse.

  • company_address_zipstring

    Postleitzahl der Unternehmensadresse.

  • company_address_countrystring

    Land der Unternehmensadresse.

  • person_addressstring

    Adresse der Person als Text.

  • person_address_street_levelstring

    Straße und Hausnummer der Personenadresse.

  • person_address_costring

    Care-of-Zeile der Personenadresse.

  • person_address_citystring

    Ort der Personenadresse.

  • person_address_zipstring

    Postleitzahl der Personenadresse.

  • person_address_countrystring

    Land der Personenadresse.

  • person_birthdaystring (date-time)

    Geburtstag der in der Sitzung erfassten Person.

  • person_genderstring

    Geschlecht der Person, die in der Sitzung erfasst wurde.

  • createdstring (date-time)

    Zeitpunkt, zu dem der Datensatz angelegt wurde.

  • updatedstring (date-time)

    Zeitpunkt, zu dem der Datensatz zuletzt aktualisiert wurde.

Anfrage
curl --request PUT \
  --url https://eure-instanz.iw-erp.de/api/cp/public_session \
  --header 'content-type: application/json' \
  --data '
{
  "data": {
    "person_first_name": "Beispiel",
    "person_last_name": "Beispiel",
    "person_email": "lena.hartmann@example.org",
    "person_phone": "+49 511 123456",
    "company_name": "Beispiel",
    "company_email": "lena.hartmann@example.org"
  }
}
'
Antwort 200 application/json
{
  "id": 42,
  "person_first_name": "Beispiel",
  "person_last_name": "Beispiel",
  "person_email": "lena.hartmann@example.org",
  "person_phone": "+49 511 123456",
  "company_name": "Beispiel",
  "company_email": "lena.hartmann@example.org",
  "company_phone": "+49 511 123456",
  "company_address_city": "Hannover",
  "company_address_zip": "30163"
}

Felder der öffentlichen Sitzung aktualisieren / anlegen

PATCH/api/cp/public_session

Request-Body application/json

  • dataPublicSession2
    Felder anzeigen (21)
    • person_first_namestring

      Vorname der Person, die in der Sitzung erfasst wurde.

    • person_last_namestring

      Nachname der in der Sitzung eingegebenen Person.

    • person_emailstring

      E-Mail-Adresse der Person, die in der Sitzung eingegeben wurde.

    • person_phonestring

      In der Sitzung erfasste Telefonnummer der Person.

    • company_namestring

      Name der in der Sitzung erfassten Firma.

    • company_emailstring

      E-Mail-Adresse der Firma, die in der Sitzung eingegeben wurde.

    • company_phonestring

      In der Sitzung erfasste Telefonnummer des Unternehmens.

    • company_addressstring

      Adresse des Unternehmens als Text.

    • company_address_street_levelstring

      Straße und Hausnummer der Unternehmensadresse.

    • company_address_costring

      Care-of-Zeile der Unternehmensadresse.

    • company_address_citystring

      Ort der Unternehmensadresse.

    • company_address_zipstring

      Postleitzahl der Unternehmensadresse.

    • company_address_countrystring

      Land der Unternehmensadresse.

    • person_addressstring

      Adresse der Person als Text.

    • person_address_street_levelstring

      Straße und Hausnummer der Personenadresse.

    • person_address_costring

      Care-of-Zeile der Personenadresse.

    • person_address_citystring

      Ort der Personenadresse.

    • person_address_zipstring

      Postleitzahl der Personenadresse.

    • person_address_countrystring

      Land der Personenadresse.

    • person_birthdaystring (date-time)

      Geburtstag der in der Sitzung erfassten Person.

    • person_genderstring

      Geschlecht der Person, die in der Sitzung erfasst wurde.

Antworten

200Felder der öffentlichen Sitzung aktualisierenPublicSession3

Felder anzeigen (25)
  • idinteger

    Primärschlüssel der öffentlichen Sitzung. Interne ID.

  • tokenstring

    Token, das die öffentliche Sitzung identifiziert.

  • person_first_namestring

    Vorname der Person, die in der Sitzung erfasst wurde.

  • person_last_namestring

    Nachname der in der Sitzung eingegebenen Person.

  • person_emailstring

    E-Mail-Adresse der Person, die in der Sitzung eingegeben wurde.

  • person_phonestring

    In der Sitzung erfasste Telefonnummer der Person.

  • company_namestring

    Name der in der Sitzung erfassten Firma.

  • company_emailstring

    E-Mail-Adresse der Firma, die in der Sitzung eingegeben wurde.

  • company_phonestring

    In der Sitzung erfasste Telefonnummer des Unternehmens.

  • company_addressstring

    Adresse des Unternehmens als Text.

  • company_address_street_levelstring

    Straße und Hausnummer der Unternehmensadresse.

  • company_address_costring

    Care-of-Zeile der Unternehmensadresse.

  • company_address_citystring

    Ort der Unternehmensadresse.

  • company_address_zipstring

    Postleitzahl der Unternehmensadresse.

  • company_address_countrystring

    Land der Unternehmensadresse.

  • person_addressstring

    Adresse der Person als Text.

  • person_address_street_levelstring

    Straße und Hausnummer der Personenadresse.

  • person_address_costring

    Care-of-Zeile der Personenadresse.

  • person_address_citystring

    Ort der Personenadresse.

  • person_address_zipstring

    Postleitzahl der Personenadresse.

  • person_address_countrystring

    Land der Personenadresse.

  • person_birthdaystring (date-time)

    Geburtstag der in der Sitzung erfassten Person.

  • person_genderstring

    Geschlecht der Person, die in der Sitzung erfasst wurde.

  • createdstring (date-time)

    Zeitpunkt, zu dem der Datensatz angelegt wurde.

  • updatedstring (date-time)

    Zeitpunkt, zu dem der Datensatz zuletzt aktualisiert wurde.

Anfrage
curl --request PATCH \
  --url https://eure-instanz.iw-erp.de/api/cp/public_session \
  --header 'content-type: application/json' \
  --data '
{
  "data": {
    "person_first_name": "Beispiel",
    "person_last_name": "Beispiel",
    "person_email": "lena.hartmann@example.org",
    "person_phone": "+49 511 123456",
    "company_name": "Beispiel",
    "company_email": "lena.hartmann@example.org"
  }
}
'
Antwort 200 application/json
{
  "id": 42,
  "person_first_name": "Beispiel",
  "person_last_name": "Beispiel",
  "person_email": "lena.hartmann@example.org",
  "person_phone": "+49 511 123456",
  "company_name": "Beispiel",
  "company_email": "lena.hartmann@example.org",
  "company_phone": "+49 511 123456",
  "company_address_city": "Hannover",
  "company_address_zip": "30163"
}