Attachment

Anhang / Attachment

System und Einstellungen1 EndpunkteAttachment / Attachment

Führt die OCR eines Anhangs erneut im Hintergrund aus, unabhängig von seinem aktuellen OCR-Status.

POST/api/attachments/{id}/ocr/retry

Nur für Super-Administratoren.

Pfad-Parameter

idPflichtstring

Antworten

200Liefert den Anhang, dessen OCR in der Warteschlange stehtAttachment

Felder anzeigen (11)

idinteger
Primärschlüssel des Anhangs. Interne ID.
filenamestring
Ursprünglicher Dateiname.
filesizestring
Größe der Datei in Bytes.
mimetypestring
MIME-Typ der Datei.
createdbyusernamestring
Name des Benutzers, der die Datei hochgeladen hat, als Text.
createdstring (date-time)
Zeitpunkt, zu dem der Anhang angelegt wurde.
googleidstring
ID der Datei in Google Drive.
companyCRMCompany
Unternehmen, zu dem der Anhang gehört.
Felder anzeigen (55)
- idinteger
  Primärschlüssel des Unternehmens. Interne ID.
- short_namestring
  Kurzname des Unternehmens.
- company_namestring
  Rechtlicher Name der Firma.
- secondary_namestring
  Zweite Namenszeile des Unternehmens.
- direct_dialstring
  Durchwahl der Firma.
- invoice_emailstring
  E-Mail-Adresse für Rechnungen.
- send_invoice_emailboolean
  Rechnungen per E-Mail versenden.
- send_invoice_letterboolean
  Rechnungen per Brief versenden.
- time_report_emailstring
  E-Mail-Adresse für Zeitberichte.
- payment_goalPaymentGoal
  Zahlungsbedingung der Firma.
- payment_intervalstring
  Intervall der Zahlungen.
- vatidstring
  Umsatzsteuer-Identifikationsnummer.
- taxnumberstring
  Steuernummer des Unternehmens.
- buyer_reference_idstring
  Leitweg-ID oder vom Kunden definierte individuelle Referenz-ID
- taxTax
  Für das Unternehmen verwendeter Steuersatz.
- infostring
  Informationen zur Firma.
- numberstring
  Kunden- oder Lieferantennummer des Unternehmens.
- manual_numberinteger
  Manuell gesetzte Nummer statt der automatischen Nummer.
- number_stringstring
  Unternehmensnummer als Text, einschließlich Präfix.
- is_customerboolean
  Das Unternehmen ist ein Kunde.
- is_supplierboolean
  Das Unternehmen ist ein Lieferant.
- is_otherboolean
  Das Unternehmen ist weder Kunde noch Lieferant.
- is_memberboolean
  Das Unternehmen ist ein Mitglied.
- archivedboolean
  Das Unternehmen ist archiviert.
- categoryCRMCompanyCategory
  Kategorie des Unternehmens.
- visible_for_customerboolean
  Ob das Unternehmen für den Kunden sichtbar ist.
- founding_datestring (date-time)
  Gründungsdatum des Unternehmens.
- nace_sectionstring
  NACE-Abschnittscode (Buchstabe A-U)
- nace_codestring
  NACE-Code (numerisch, z. B. 01.11, 62.01)
- search_stringstring
  Text, unter dem die Entität gesucht werden kann.
- addressstring
  Adresse als Text.
- address_streetstring
  Straße der Adresse.
- address_house_numberstring
  Hausnummer der Adresse.
- address_street_levelstring
  Straße und Hausnummer der Adresse.
- address_costring
  Care-of-Zeile der Adresse.
- address_citystring
  Ort der Adresse.
- address_zipstring
  Postleitzahl der Adresse.
- address_admin_level1string
  Erste Verwaltungsebene der Adresse, z. B. das Bundesland.
- address_countrystring
  Ländercode der Adresse.
- address_full_countrystring
  Vollständiger Name des Landes der Adresse.
- address_geo_latstring
  Breitengrad der Adresse.
- address_geo_lngstring
  Längengrad der Adresse.
- address_external_provider_idstring
  Feld zur Speicherung der externen Anbieter-ID der Adresse, z. B. Google-Maps-PlaceID wie google:ChIJVcKw5r90sEcRhdjNq6NItqE
- main_phonestring
  Haupttelefonnummer.
- main_faxstring
  Haupt-Faxnummer.
- main_emailstring
  Haupt-E-Mail-Adresse.
- websitestring
  Website-Adresse.
- createdstring (date-time)
  Zeitpunkt, zu dem der Datensatz angelegt wurde.
- updatedstring (date-time)
  Zeitpunkt, zu dem der Datensatz zuletzt aktualisiert wurde.
- payment_typePaymentType
- company_employee_countinteger
  Anzahl der Mitarbeitenden der Firma.
- company_founding_yearinteger
  Gründungsjahr des Unternehmens.
- company_family_ownedboolean
  Ob das Unternehmen familiengeführt ist.
- company_sales_volumestring
  Umsatzvolumen des Unternehmens.
- company_segmentstring
  Marktsegment der Firma.
personCRMPerson10
Person, zu der der Anhang gehört.
Felder anzeigen (81)
- idinteger
  Primärschlüssel der Person. Interne ID.
- first_namestring
  Vorname der Person.
- last_namestring
  Nachname der Person.
- numberinteger
  Mitglieds- oder Kundennummer der Person.
- manual_numberinteger
  Manuell gesetzte Nummer statt der automatischen Nummer.
- number_stringstring
  Mitglieds- oder Kundennummer als Text, einschließlich Präfix.
- genderstring
  Geschlecht der Person.
- titlestring
  Akademischer oder sonstiger Titel der Person.
- positionstring
  Position oder Rolle der Person.
- languagestring
  Bevorzugte Sprache der Person.
- special_salutationstring
  Besonderer Anredetext für Briefe.
- form_of_salutationstring
  Form der Anrede, zum Beispiel förmlich oder informell.
- birthdaystring (date-time)
  Geburtstag der Person.
- known_allergiesstring
  Bekannte Allergien der Person.
- confirmed_no_allergiesboolean
  Erziehungsberechtigte(r) bestätigt, dass keine bekannten Allergien vorliegen.
- allow_photosboolean
  Fotos der Person dürfen aufgenommen und veröffentlicht werden.
- allow_leaving_aloneboolean
  Die Person darf die Veranstaltung allein verlassen.
- authorized_pickupstring
  Personen, die die Person abholen dürfen.
- needs_supportboolean
  Die Person benötigt Unterstützung, zum Beispiel zur Inklusion.
- support_descriptionstring
  Beschreibung der Unterstützung, die die Person benötigt.
- financial_supportboolean
  Die Person erhält finanzielle Unterstützung.
- financial_support_numberstring
  Nummer der finanziellen Förderung.
- municipal_supportboolean
  Die Person erhält kommunale Unterstützung.
- municipal_support_numberstring
  Nummer der kommunalen Förderung.
- grade_levelinteger
  Schuljahrgang der Person.
- school_classstring
  Schulklasse der Person.
- start_timestring (date-time)
  Beginn der Mitgliedschaft oder Aktivität.
- start_time_reasonstring
  Grund für den Beginn.
- end_timestring (date-time)
  Ende der Mitgliedschaft oder Aktivität.
- end_time_reasonstring
  Grund für das Ende.
- confirmed_gtc_timestring (date-time)
  Zeitpunkt, zu dem die AGB bestätigt wurden.
- chatbot_opt_inboolean
  Einwilligung in die Nutzung des KI-Assistenten. Denormalisierter aktueller Stand - das prüfbare Protokoll steht in ChatbotConsent.
- chatbot_opt_in_atstring (date-time)
  Zeitpunkt, zu dem die Person dem Chatbot zugestimmt hat.
- chatbot_opt_in_text_versionstring
  Version des Einwilligungstextes, dem zugestimmt wurde. Weicht sie von der aktuellen Version ab, ist das Opt-in abgelaufen.
- app_usage_statistics_opt_outboolean
  Widerspruch gegen die anonyme Nutzungsstatistik der Mitglieder-App. Die App liest ihn aus den StaticData und schickt dann nichts mehr; die gezählten Aufrufe selbst haben keinen Bezug zur Person.
- crm_person_contact_dataarray<CRMPersonContactData>
  Kontaktdaten der Person, zum Beispiel Telefon und E-Mail.
- archivedboolean
  Ob die Person archiviert ist.
- subscribed_newsletterboolean
  Ob die Person den Newsletter abonniert hat.
- subscribed_magazineboolean
  Ob die Person das Magazin abonniert hat.
- printed_member_cardboolean
  Ob für die Person ein Mitgliedsausweis gedruckt wurde.
- has_login_userboolean
  Ob die Person einen Anmelde-Benutzer hat.
- profile_picture_urlstring
  URL des Profilbilds der Person.
- log_book_staffboolean
  Logbuch-Kennzeichen: Personal.
- log_book_staff1boolean
  Logbuch-Kennzeichen: Personal, Stufe 1.
- log_book_staff2boolean
  Logbuch-Kennzeichen: Personal, Stufe 2.
- log_book_memberboolean
  Logbuch-Kennzeichen: Mitglied.
- log_book_trainerboolean
  Logbuch-Kennzeichen: Trainer.
- log_book_trainer1boolean
  Logbuch-Kennzeichen: Trainer, Stufe 1.
- log_book_trainer2boolean
  Logbuch-Kennzeichen: Trainer, Stufe 2.
- log_book_head_of_departmentboolean
  Logbuch-Kennzeichen: Abteilungsleitung.
- log_book_supervisory_boardboolean
  Logbuch-Kennzeichen: Aufsichtsrat.
- log_book_board_of_directorsboolean
  Logbuch-Kennzeichen: Vorstand.
- log_book_honorary_memberboolean
  Logbuch-Kennzeichen: Ehrenmitglied.
- log_book_club_card_oneboolean
  Logbuch-Kennzeichen: Vereinskarte.
- log_book_health_recoveredboolean
  Logbuch-Kennzeichen: von Krankheit genesen.
- log_book_health_vaccinatedboolean
  Logbuch-Kennzeichen: geimpft.
- log_book_health_vaccinated_additionstring
  Details der Impfung.
- log_book_good_conductboolean
  Logbuch-Kennzeichen: Führungszeugnis.
- log_book_first_aidboolean
  Logbuch-Kennzeichen: Erste-Hilfe-Schulung.
- log_book_measles_vaccinationboolean
  Logbuch-Kennzeichen: Masernimpfung.
- sync_lanistaboolean
  Ob die Person mit Lanista synchronisiert ist.
- categoryCRMPersonCategory
  Personenkategorie.
- nicknamestring
  Spitzname der Person.
- preferred_color_hexstring
  Bevorzugte Farbe der Person als Hexwert.
- avatar_tokenstring
  Token des Avatarbildes.
- search_stringstring
  Text, unter dem die Entität gesucht werden kann.
- addressstring
  Adresse als Text.
- address_streetstring
  Straße der Adresse.
- address_house_numberstring
  Hausnummer der Adresse.
- address_street_levelstring
  Straße und Hausnummer der Adresse.
- address_costring
  Care-of-Zeile der Adresse.
- address_citystring
  Ort der Adresse.
- address_zipstring
  Postleitzahl der Adresse.
- address_admin_level1string
  Erste Verwaltungsebene der Adresse, z. B. das Bundesland.
- address_countrystring
  Ländercode der Adresse.
- address_full_countrystring
  Vollständiger Name des Landes der Adresse.
- address_geo_latstring
  Breitengrad der Adresse.
- address_geo_lngstring
  Längengrad der Adresse.
- address_external_provider_idstring
  Feld zur Speicherung der externen Anbieter-ID der Adresse, z. B. Google-Maps-PlaceID wie google:ChIJVcKw5r90sEcRhdjNq6NItqE
- createdstring (date-time)
  Zeitpunkt, zu dem der Datensatz angelegt wurde.
- … 2 weitere Felder
attached_personCRMPerson10
Person, an die der Anhang angehängt ist.
Felder anzeigen (56)
- idinteger
  Primärschlüssel der Person. Interne ID.
- first_namestring
  Vorname der Person.
- last_namestring
  Nachname der Person.
- numberinteger
  Mitglieds- oder Kundennummer der Person.
- manual_numberinteger
  Manuell gesetzte Nummer statt der automatischen Nummer.
- number_stringstring
  Mitglieds- oder Kundennummer als Text, einschließlich Präfix.
- genderstring
  Geschlecht der Person.
- titlestring
  Akademischer oder sonstiger Titel der Person.
- positionstring
  Position oder Rolle der Person.
- languagestring
  Bevorzugte Sprache der Person.
- special_salutationstring
  Besonderer Anredetext für Briefe.
- form_of_salutationstring
  Form der Anrede, zum Beispiel förmlich oder informell.
- birthdaystring (date-time)
  Geburtstag der Person.
- known_allergiesstring
  Bekannte Allergien der Person.
- confirmed_no_allergiesboolean
  Erziehungsberechtigte(r) bestätigt, dass keine bekannten Allergien vorliegen.
- allow_photosboolean
  Fotos der Person dürfen aufgenommen und veröffentlicht werden.
- allow_leaving_aloneboolean
  Die Person darf die Veranstaltung allein verlassen.
- authorized_pickupstring
  Personen, die die Person abholen dürfen.
- needs_supportboolean
  Die Person benötigt Unterstützung, zum Beispiel zur Inklusion.
- support_descriptionstring
  Beschreibung der Unterstützung, die die Person benötigt.
- financial_supportboolean
  Die Person erhält finanzielle Unterstützung.
- financial_support_numberstring
  Nummer der finanziellen Förderung.
- municipal_supportboolean
  Die Person erhält kommunale Unterstützung.
- municipal_support_numberstring
  Nummer der kommunalen Förderung.
- grade_levelinteger
  Schuljahrgang der Person.
- school_classstring
  Schulklasse der Person.
- start_timestring (date-time)
  Beginn der Mitgliedschaft oder Aktivität.
- start_time_reasonstring
  Grund für den Beginn.
- end_timestring (date-time)
  Ende der Mitgliedschaft oder Aktivität.
- end_time_reasonstring
  Grund für das Ende.
- confirmed_gtc_timestring (date-time)
  Zeitpunkt, zu dem die AGB bestätigt wurden.
- chatbot_opt_inboolean
  Einwilligung in die Nutzung des KI-Assistenten. Denormalisierter aktueller Stand - das prüfbare Protokoll steht in ChatbotConsent.
- chatbot_opt_in_atstring (date-time)
  Zeitpunkt, zu dem die Person dem Chatbot zugestimmt hat.
- chatbot_opt_in_text_versionstring
  Version des Einwilligungstextes, dem zugestimmt wurde. Weicht sie von der aktuellen Version ab, ist das Opt-in abgelaufen.
- app_usage_statistics_opt_outboolean
  Widerspruch gegen die anonyme Nutzungsstatistik der Mitglieder-App. Die App liest ihn aus den StaticData und schickt dann nichts mehr; die gezählten Aufrufe selbst haben keinen Bezug zur Person.
- crm_person_contact_dataarray<CRMPersonContactData>
  Kontaktdaten der Person, zum Beispiel Telefon und E-Mail.
- archivedboolean
  Ob die Person archiviert ist.
- subscribed_newsletterboolean
  Ob die Person den Newsletter abonniert hat.
- subscribed_magazineboolean
  Ob die Person das Magazin abonniert hat.
- printed_member_cardboolean
  Ob für die Person ein Mitgliedsausweis gedruckt wurde.
- has_login_userboolean
  Ob die Person einen Anmelde-Benutzer hat.
- profile_picture_urlstring
  URL des Profilbilds der Person.
- log_book_staffboolean
  Logbuch-Kennzeichen: Personal.
- log_book_staff1boolean
  Logbuch-Kennzeichen: Personal, Stufe 1.
- log_book_staff2boolean
  Logbuch-Kennzeichen: Personal, Stufe 2.
- log_book_memberboolean
  Logbuch-Kennzeichen: Mitglied.
- log_book_trainerboolean
  Logbuch-Kennzeichen: Trainer.
- log_book_trainer1boolean
  Logbuch-Kennzeichen: Trainer, Stufe 1.
- log_book_trainer2boolean
  Logbuch-Kennzeichen: Trainer, Stufe 2.
- log_book_head_of_departmentboolean
  Logbuch-Kennzeichen: Abteilungsleitung.
- log_book_supervisory_boardboolean
  Logbuch-Kennzeichen: Aufsichtsrat.
- log_book_board_of_directorsboolean
  Logbuch-Kennzeichen: Vorstand.
- log_book_honorary_memberboolean
  Logbuch-Kennzeichen: Ehrenmitglied.
- log_book_club_card_oneboolean
  Logbuch-Kennzeichen: Vereinskarte.
- log_book_health_recoveredboolean
  Logbuch-Kennzeichen: von Krankheit genesen.
- … 27 weitere Felder
… 22 weitere Felder

Anfrage

curl --request POST \
  --url https://eure-instanz.iw-erp.de/api/attachments/42/ocr/retry \
  --header 'x-iw-jwt-token: <TOKEN>'

const options = {method: 'POST', headers: {'x-iw-jwt-token': '<TOKEN>'}};

fetch('https://eure-instanz.iw-erp.de/api/attachments/42/ocr/retry', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://eure-instanz.iw-erp.de/api/attachments/42/ocr/retry"

headers = {"x-iw-jwt-token": "<TOKEN>"}

response = requests.post(url, headers=headers)

print(response.text)

<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://eure-instanz.iw-erp.de/api/attachments/42/ocr/retry', [
  'headers' => [
    'x-iw-jwt-token' => '<TOKEN>',
  ],
]);

echo $response->getBody();

using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
  Method = HttpMethod.Post,
  RequestUri = new Uri("https://eure-instanz.iw-erp.de/api/attachments/42/ocr/retry"),
  Headers =
  {
    { "x-iw-jwt-token", "<TOKEN>" },
  },
};
using (var response = await client.SendAsync(request))
{
  response.EnsureSuccessStatusCode();
  var body = await response.Content.ReadAsStringAsync();
  Console.WriteLine(body);
}

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://eure-instanz.iw-erp.de/api/attachments/42/ocr/retry")
  .post(null)
  .addHeader("x-iw-jwt-token", "<TOKEN>")
  .build();

Response response = client.newCall(request).execute();

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://eure-instanz.iw-erp.de/api/attachments/42/ocr/retry"

	req, _ := http.NewRequest("POST", url, nil)

	req.Header.Add("x-iw-jwt-token", "<TOKEN>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

Dart mit dem Package iw_erp_api

import 'package:iw_erp_api/clients/attachment_controller.dart';
import 'package:iw_erp_api/logic/iw_api_state.dart';

IwApiState().host = 'eure-instanz.iw-erp.de';
IwApiState().currentJwtApiToken = '<TOKEN>';

final result = await AttachmentController.retryOcr('42');
if (result.success) {
  print(result.data);
}

Antwort 200 application/json

{
  "id": 42,
  "description": "Text",
  "ocr_from_name": "Beispiel",
  "ocr_from_email": "lena.hartmann@example.org",
  "ocr_from_phone": "+49 511 123456",
  "ocr_to_name": "Beispiel",
  "ocr_to_email": "lena.hartmann@example.org",
  "ocr_to_phone": "+49 511 123456",
  "filename": "string",
  "filesize": "string"
}