Self Sign Up
Anmeldung / Selbstregistrierung
Startet einen neuen Selbstanmeldungsvorgang. Liefert ein Token und die Pflichtfelder.
GET/api/cp/signup/start
Antworten
200Startet einen neuen Selbstanmeldungsvorgang. Liefert ein Token und die Pflichtfelder.SelfSignUpLog
Felder anzeigen (53)
idintegerPrimärschlüssel des Anmelde-Protokolleintrags. Interne ID.
tokenstringToken, das die Anmeldung identifiziert.
public_session_tokenstringToken der öffentlichen Sitzung, in der die Anmeldung erfolgt ist.
invite_codeSelfSignUpLogInviteCode2Einladungscode, der für die Anmeldung verwendet wurde.
Felder anzeigen (8)
idintegerPrimärschlüssel des Einladungscodes. Interne ID.
tokenstringToken des Einladungscodes.
log_book_entry_content_typestringInhaltstyp des Logbuch-Eintrags, der durch den Einladungscode erstellt wird.
createdstring (date-time)Zeitpunkt, zu dem der Datensatz angelegt wurde.
updatedstring (date-time)Zeitpunkt, zu dem der Datensatz zuletzt aktualisiert wurde.
deletedbooleanDiese Eigenschaft markiert eine Entität als gelöscht / archiviert
namestringName der Einheit.
image_urlstringURL des Bildes des Datensatzes.
person_first_namestringVorname, der bei der Anmeldung eingetragen wurde.
person_last_namestringBei der Anmeldung eingegebener Nachname.
person_emailstringE-Mail-Adresse, die bei der Anmeldung angegeben wurde.
person_phonestringBei der Anmeldung erfasste Telefonnummer.
company_namestringBei der Anmeldung eingegebener Unternehmensname.
company_emailstringBei der Anmeldung eingegebene E-Mail-Adresse des Unternehmens.
company_phonestringBei der Anmeldung eingegebene Telefonnummer des Unternehmens.
company_addressstringAdresse des Unternehmens als Text.
company_address_street_levelstringStraße und Hausnummer der Unternehmensadresse.
company_address_costringCare-of-Zeile der Unternehmensadresse.
company_address_citystringOrt der Unternehmensadresse.
company_address_zipstringPostleitzahl der Unternehmensadresse.
company_address_countrystringLand der Unternehmensadresse.
person_addressstringAdresse der Person als Text.
person_address_street_levelstringStraße und Hausnummer der Personenadresse.
person_address_costringCare-of-Zeile der Personenadresse.
person_address_citystringOrt der Personenadresse.
person_address_zipstringPostleitzahl der Personenadresse.
person_address_countrystringLand der Personenadresse.
person_birthdaystring (date-time)Bei der Anmeldung erfasstes Geburtsdatum.
person_genderstringGeschlecht, das bei der Anmeldung eingetragen wurde.
person_grade_levelintegerKlassenstufe, die bei der Anmeldung eingetragen wurde.
person_school_classstringIm Anmeldeformular angegebene Schulklasse.
person_categorystringPersonenkategorie, die bei der Anmeldung angegeben wurde.
ticket_ticket_typestringDurch die Anmeldung angelegte Ticketart.
ticket_issuetypestringEin Typ wie Bug, Task, Story
ticket_issue_categorystringEine Kategorie wie Website, Hosting, Marketing
require_sepabooleanOb ein SEPA-Mandat erforderlich ist.
require_addressbooleanOb eine Adresse erforderlich ist.
require_company_namestringOb ein Firmenname erforderlich ist.
require_person_addressbooleanOb eine Personenadresse erforderlich ist.
require_person_birthdaybooleanOb ein Geburtstag erforderlich ist.
require_person_genderbooleanOb ein Geschlecht erforderlich ist.
require_person_phonestringOb eine Telefonnummer erforderlich ist.
require_ticketbooleanOb ein Ticket erforderlich ist.
additional_peoplearray<SelfSignUpLogAdditionalPerson>Weitere Personen, die in derselben Anmeldung erfasst sind.
Felder anzeigen (22)
idintegerPrimärschlüssel der weiteren Person. Interne ID.
person_first_namestringVorname der zusätzlichen Person.
person_last_namestringNachname der weiteren Person.
person_emailstringE-Mail-Adresse der zusätzlichen Person.
person_phonestringTelefonnummer der weiteren Person.
person_addressstringAdresse der weiteren Person als Text.
person_address_street_levelstringStraße und Hausnummer der Adresse der weiteren Person.
person_address_costringCare-of-Zeile der Adresse der weiteren Person.
person_address_citystringOrt der Adresse der weiteren Person.
person_address_zipstringPostleitzahl der Adresse der weiteren Person.
person_address_countrystringLand der Adresse der weiteren Person.
person_birthdaystring (date-time)Geburtstag der weiteren Person.
person_genderstringGeschlecht der zusätzlichen Person.
person_grade_levelintegerKlassenstufe der zusätzlichen Person.
person_school_classstringSchulklasse der weiteren Person.
person_categorystringKategorie der weiteren Person.
ticket_ticket_typestringTicketart für das Ticket der weiteren Person.
ticket_issuetypestringTicket-Typ für das Ticket der weiteren Person.
ticket_issue_categorystringTicket-Kategorie für das Ticket der weiteren Person.
ticket_headlinestringÜberschrift des Tickets der zusätzlichen Person.
ticket_descriptionstringBeschreibung des zusätzlichen Personentickets.
processed_person_idstringID der Person, die für die zusätzliche Person angelegt wurde.
processed_company_numberstringNummer der aus der Anmeldung erzeugten Firma.
processed_company_idstringID der Firma, die aus der Anmeldung erzeugt wurde.
processed_person_idstringID der Person, die aus der Anmeldung angelegt wurde.
processed_user_idstringID des Benutzers, der aus der Anmeldung angelegt wurde.
createdstring (date-time)Zeitpunkt, zu dem der Datensatz angelegt wurde.
updatedstring (date-time)Zeitpunkt, zu dem der Datensatz zuletzt aktualisiert wurde.
payment_ownerstringKontoinhaber der Lastschrift.
payment_institutionstringName der Bank des Lastschrifteinzugs.
payment_bicstringBIC des Bankkontos.
payment_ibanstringIBAN des Bankkontos.
payment_mandatestringReferenz des SEPA-Mandats.
payment_mandate_sign_datestring (date-time)Datum, an dem das SEPA-Mandat unterschrieben wurde.
payment_mandate_valid_until_datestring (date-time)Datum, bis zu dem das SEPA-Mandat gültig ist.
curl --request GET \
--url https://eure-instanz.iw-erp.de/api/cp/signup/startconst options = {method: 'GET'};
fetch('https://eure-instanz.iw-erp.de/api/cp/signup/start', 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/cp/signup/start"
response = requests.get(url)
print(response.text)<?php
require_once('vendor/autoload.php');
$client = new \GuzzleHttp\Client();
$response = $client->request('GET', 'https://eure-instanz.iw-erp.de/api/cp/signup/start');
echo $response->getBody();using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("https://eure-instanz.iw-erp.de/api/cp/signup/start"),
};
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/cp/signup/start")
.get()
.build();
Response response = client.newCall(request).execute();package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://eure-instanz.iw-erp.de/api/cp/signup/start"
req, _ := http.NewRequest("GET", url, nil)
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/self_sign_up_controller.dart';
import 'package:iw_erp_api/logic/iw_api_state.dart';
IwApiState().host = 'eure-instanz.iw-erp.de';
final result = await SelfSignUpController.start();
if (result.success) {
print(result.data);
}{
"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"
}Selbstregistrierung abschließen. Erfordert Token aus Selbstregistrierung - Start.
POST/api/cp/signup/finish/{token}
Pfad-Parameter
tokenPflichtstring |
Request-Body application/json
dataSelfSignUpLog2Felder anzeigen (35)
person_first_namestringVorname, der bei der Anmeldung eingetragen wurde.
person_last_namestringBei der Anmeldung eingegebener Nachname.
person_emailstringE-Mail-Adresse, die bei der Anmeldung angegeben wurde.
person_phonestringBei der Anmeldung erfasste Telefonnummer.
company_namestringBei der Anmeldung eingegebener Unternehmensname.
company_emailstringBei der Anmeldung eingegebene E-Mail-Adresse des Unternehmens.
company_phonestringBei der Anmeldung eingegebene Telefonnummer des Unternehmens.
company_addressstringAdresse des Unternehmens als Text.
company_address_street_levelstringStraße und Hausnummer der Unternehmensadresse.
company_address_costringCare-of-Zeile der Unternehmensadresse.
company_address_citystringOrt der Unternehmensadresse.
company_address_zipstringPostleitzahl der Unternehmensadresse.
company_address_countrystringLand der Unternehmensadresse.
person_addressstringAdresse der Person als Text.
person_address_street_levelstringStraße und Hausnummer der Personenadresse.
person_address_costringCare-of-Zeile der Personenadresse.
person_address_citystringOrt der Personenadresse.
person_address_zipstringPostleitzahl der Personenadresse.
person_address_countrystringLand der Personenadresse.
person_birthdaystring (date-time)Bei der Anmeldung erfasstes Geburtsdatum.
person_genderstringGeschlecht, das bei der Anmeldung eingetragen wurde.
person_grade_levelintegerKlassenstufe, die bei der Anmeldung eingetragen wurde.
person_school_classstringIm Anmeldeformular angegebene Schulklasse.
person_categorystringPersonenkategorie, die bei der Anmeldung angegeben wurde.
ticket_ticket_typestringDurch die Anmeldung angelegte Ticketart.
ticket_issuetypestringEin Typ wie Bug, Task, Story
ticket_issue_categorystringEine Kategorie wie Website, Hosting, Marketing
additional_peoplearray<SelfSignUpLogAdditionalPerson2>Weitere Personen, die in derselben Anmeldung erfasst sind.
payment_ownerstringKontoinhaber der Lastschrift.
payment_institutionstringName der Bank des Lastschrifteinzugs.
payment_bicstringBIC des Bankkontos.
payment_ibanstringIBAN des Bankkontos.
payment_mandatestringReferenz des SEPA-Mandats.
payment_mandate_sign_datestring (date-time)Datum, an dem das SEPA-Mandat unterschrieben wurde.
payment_mandate_valid_until_datestring (date-time)Datum, bis zu dem das SEPA-Mandat gültig ist.
Antworten
200Selbstregistrierung abschließen. Erfordert Token aus Selbstregistrierung - Start.SelfSignUpLog
Felder anzeigen (53)
idintegerPrimärschlüssel des Anmelde-Protokolleintrags. Interne ID.
tokenstringToken, das die Anmeldung identifiziert.
public_session_tokenstringToken der öffentlichen Sitzung, in der die Anmeldung erfolgt ist.
invite_codeSelfSignUpLogInviteCode2Einladungscode, der für die Anmeldung verwendet wurde.
Felder anzeigen (8)
idintegerPrimärschlüssel des Einladungscodes. Interne ID.
tokenstringToken des Einladungscodes.
log_book_entry_content_typestringInhaltstyp des Logbuch-Eintrags, der durch den Einladungscode erstellt wird.
createdstring (date-time)Zeitpunkt, zu dem der Datensatz angelegt wurde.
updatedstring (date-time)Zeitpunkt, zu dem der Datensatz zuletzt aktualisiert wurde.
deletedbooleanDiese Eigenschaft markiert eine Entität als gelöscht / archiviert
namestringName der Einheit.
image_urlstringURL des Bildes des Datensatzes.
person_first_namestringVorname, der bei der Anmeldung eingetragen wurde.
person_last_namestringBei der Anmeldung eingegebener Nachname.
person_emailstringE-Mail-Adresse, die bei der Anmeldung angegeben wurde.
person_phonestringBei der Anmeldung erfasste Telefonnummer.
company_namestringBei der Anmeldung eingegebener Unternehmensname.
company_emailstringBei der Anmeldung eingegebene E-Mail-Adresse des Unternehmens.
company_phonestringBei der Anmeldung eingegebene Telefonnummer des Unternehmens.
company_addressstringAdresse des Unternehmens als Text.
company_address_street_levelstringStraße und Hausnummer der Unternehmensadresse.
company_address_costringCare-of-Zeile der Unternehmensadresse.
company_address_citystringOrt der Unternehmensadresse.
company_address_zipstringPostleitzahl der Unternehmensadresse.
company_address_countrystringLand der Unternehmensadresse.
person_addressstringAdresse der Person als Text.
person_address_street_levelstringStraße und Hausnummer der Personenadresse.
person_address_costringCare-of-Zeile der Personenadresse.
person_address_citystringOrt der Personenadresse.
person_address_zipstringPostleitzahl der Personenadresse.
person_address_countrystringLand der Personenadresse.
person_birthdaystring (date-time)Bei der Anmeldung erfasstes Geburtsdatum.
person_genderstringGeschlecht, das bei der Anmeldung eingetragen wurde.
person_grade_levelintegerKlassenstufe, die bei der Anmeldung eingetragen wurde.
person_school_classstringIm Anmeldeformular angegebene Schulklasse.
person_categorystringPersonenkategorie, die bei der Anmeldung angegeben wurde.
ticket_ticket_typestringDurch die Anmeldung angelegte Ticketart.
ticket_issuetypestringEin Typ wie Bug, Task, Story
ticket_issue_categorystringEine Kategorie wie Website, Hosting, Marketing
require_sepabooleanOb ein SEPA-Mandat erforderlich ist.
require_addressbooleanOb eine Adresse erforderlich ist.
require_company_namestringOb ein Firmenname erforderlich ist.
require_person_addressbooleanOb eine Personenadresse erforderlich ist.
require_person_birthdaybooleanOb ein Geburtstag erforderlich ist.
require_person_genderbooleanOb ein Geschlecht erforderlich ist.
require_person_phonestringOb eine Telefonnummer erforderlich ist.
require_ticketbooleanOb ein Ticket erforderlich ist.
additional_peoplearray<SelfSignUpLogAdditionalPerson>Weitere Personen, die in derselben Anmeldung erfasst sind.
Felder anzeigen (22)
idintegerPrimärschlüssel der weiteren Person. Interne ID.
person_first_namestringVorname der zusätzlichen Person.
person_last_namestringNachname der weiteren Person.
person_emailstringE-Mail-Adresse der zusätzlichen Person.
person_phonestringTelefonnummer der weiteren Person.
person_addressstringAdresse der weiteren Person als Text.
person_address_street_levelstringStraße und Hausnummer der Adresse der weiteren Person.
person_address_costringCare-of-Zeile der Adresse der weiteren Person.
person_address_citystringOrt der Adresse der weiteren Person.
person_address_zipstringPostleitzahl der Adresse der weiteren Person.
person_address_countrystringLand der Adresse der weiteren Person.
person_birthdaystring (date-time)Geburtstag der weiteren Person.
person_genderstringGeschlecht der zusätzlichen Person.
person_grade_levelintegerKlassenstufe der zusätzlichen Person.
person_school_classstringSchulklasse der weiteren Person.
person_categorystringKategorie der weiteren Person.
ticket_ticket_typestringTicketart für das Ticket der weiteren Person.
ticket_issuetypestringTicket-Typ für das Ticket der weiteren Person.
ticket_issue_categorystringTicket-Kategorie für das Ticket der weiteren Person.
ticket_headlinestringÜberschrift des Tickets der zusätzlichen Person.
ticket_descriptionstringBeschreibung des zusätzlichen Personentickets.
processed_person_idstringID der Person, die für die zusätzliche Person angelegt wurde.
processed_company_numberstringNummer der aus der Anmeldung erzeugten Firma.
processed_company_idstringID der Firma, die aus der Anmeldung erzeugt wurde.
processed_person_idstringID der Person, die aus der Anmeldung angelegt wurde.
processed_user_idstringID des Benutzers, der aus der Anmeldung angelegt wurde.
createdstring (date-time)Zeitpunkt, zu dem der Datensatz angelegt wurde.
updatedstring (date-time)Zeitpunkt, zu dem der Datensatz zuletzt aktualisiert wurde.
payment_ownerstringKontoinhaber der Lastschrift.
payment_institutionstringName der Bank des Lastschrifteinzugs.
payment_bicstringBIC des Bankkontos.
payment_ibanstringIBAN des Bankkontos.
payment_mandatestringReferenz des SEPA-Mandats.
payment_mandate_sign_datestring (date-time)Datum, an dem das SEPA-Mandat unterschrieben wurde.
payment_mandate_valid_until_datestring (date-time)Datum, bis zu dem das SEPA-Mandat gültig ist.
curl --request POST \
--url https://eure-instanz.iw-erp.de/api/cp/signup/finish/42 \
--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"
}
}
'const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: JSON.stringify({
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'
}
})
};
fetch('https://eure-instanz.iw-erp.de/api/cp/signup/finish/42', 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/cp/signup/finish/42"
payload = { "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"
} }
headers = {"content-type": "application/json"}
response = requests.post(url, json=payload, 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/cp/signup/finish/42', [
'body' => '{"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"}}',
'headers' => [
'content-type' => 'application/json',
],
]);
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/cp/signup/finish/42"),
Content = new StringContent("{\"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\"}}")
{
Headers =
{
ContentType = new MediaTypeHeaderValue("application/json")
}
}
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}OkHttpClient client = new OkHttpClient();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\"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\"}}");
Request request = new Request.Builder()
.url("https://eure-instanz.iw-erp.de/api/cp/signup/finish/42")
.post(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://eure-instanz.iw-erp.de/api/cp/signup/finish/42"
payload := strings.NewReader("{\"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\"}}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("content-type", "application/json")
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/self_sign_up_controller.dart';
import 'package:iw_erp_api/logic/iw_api_state.dart';
import 'package:iw_erp_api/model/self_sign_up.dart';
IwApiState().host = 'eure-instanz.iw-erp.de';
final result = await SelfSignUpController.finish(SelfSignUp.fromJson({
"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"
}));
if (result.success) {
print(result.data);
}{
"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"
}