ThirdPartyWebService (1.0)

Download OpenAPI specification:Download

ThirdParty

Meldet einen Drittanbieter an und liefert ein Zugriffstoken zurück.

Request Body schema:

Zugangsdaten des Drittanbieters

Password
required
string [ 8 .. 50 ] characters

Pflichtfeld.

EMail
required
string [ 8 .. 250 ] characters

Pflichtfeld.

AccessToken
required
string <uuid>

Pflichtfeld.

Responses

Request samples

Content type
{
  • "Password": "stringst",
  • "EMail": "stringst",
  • "AccessToken": "47ae41d8-6526-4dec-b4d3-0af9813e2b4b"
}

Response samples

Content type
No sample

Sucht einen Fall anhand der übergebenen Suchkriterien.

Request Body schema:

Suchkriterien für de Fall

SessionToken
required
string non-empty

Pflichtfeld.

Password
string
SearchPattern
string
CRMID
string
VEMAId
string

Responses

Request samples

Content type
{
  • "SessionToken": "string",
  • "Password": "string",
  • "SearchPattern": "string",
  • "CRMID": "string",
  • "VEMAId": "string"
}

Response samples

Content type
No sample

Lädt eine fallzugehörige Datei herunter.

Request Body schema:

Anfrage für den Datei-Download

SessionToken
required
string non-empty

Pflichtfeld.

Password
string
CRMID
string
FileId
required
integer <int32>

Pflichtfeld.

Responses

Request samples

Content type
{
  • "SessionToken": "string",
  • "Password": "string",
  • "CRMID": "string",
  • "FileId": 0
}

Response samples

Content type
No sample

Fügt einen Vermittler hinzu oder aktualisiert ihn.

Request Body schema:

Anfrage für den AddUpdateVermittler

SessionToken
required
string non-empty

Pflichtfeld.

GroupId
required
integer <int32>

Pflichtfeld. Kundennummer FP24 ("GruppenId").

CRMID
string

Nur bei JDC-Kunden Pflicht. Externe ID Drittsystem, einmalig pro Anwender.

Licenses
Array of strings (eLicenses)
Items Enum: "StarterBiomRisiken" "StarterFinanzanalyse" "BusinessBRFA" "StarterFoerderrechner" "StarterRuhestandsplanung" "BusinessFAFR" "BusinessBRFR" "Dummy" "DemoAll_20191001" "DemoAll_20200201" "ProfessionalFABRFR" "ProfessionalFABRRS" "ProfessionalFAFRRS" "ProfessionalBRFRRS" "PremiumFABRFRRS" "AddOnImmobilienFinanzierung" "AddOnGenerationenberatung" "BusinessBRRS" "BusinessFARS" "BusinessFRRS" "AddOnAnlagestrategie" "AddOnFA" "AddOnBR" "AddOnRS" "AddOnFR" "DemoAll_20200801" "AddOnControlling" "DemoAll_20201101" "DemoPro_20201201" "Datenerfassung_20210601" "Erfassungsstrecke_20210601" "Statistik_20210901" "AddOn_ELearning_Handling_And_Doing_20211101" "AddOn_ELearning_Finanzanalyse_DIN_77230_20211101" "AddOn_ELearning_Biometrische_Risiken_20211101" "AddOn_ELearning_Foerderrechner_20211101" "AddOn_ELearning_Ruhestandsplanung_20211101" "AddOn_ELearning_Pruefungsfragen_zur_DIN_20211101" "AddOn_ELearning_Premium_20211101" "Ultimate_20211101" "AddOn_Expertcourse_Biometrische_Risiken_20240801" "Erfassungsstrecke_Starter_20240501" "Erfassungsstrecke_Business_20240501" "Erfassungsstrecke_Professional_20240501" "AddOn_PSD2_20240501" "AddOn_Expertcourse_Ruhestandsplanung_20240801" "AddOn_Expertcourse_Foerderrechner_20240801" "AddOn_Masterclass_Ruhestandsplanung_20241001" "Datenrettung_20241101" "AddOn_Masterclass_Nachbetreuung_20241201"
required
object

Pflichtfeld.

Responses

Request samples

Content type
{
  • "SessionToken": "string",
  • "GroupId": 0,
  • "CRMID": "string",
  • "Licenses": [
    ],
  • "Vermittlerdaten": {
    }
}

Response samples

Content type
No sample

Erstellt aus einem XML Fall ein binary FPPX-Dokument.

Request Body schema:

Fall vom Typ Fall3P_V4

SessionToken
required
string non-empty

Pflichtfeld.

required
object

Pflichtfeld.

Responses

Request samples

Content type
{
  • "SessionToken": "string",
  • "Fall3P": {
    }
}

Response samples

Content type
No sample

Erstellt ein neues AccessToken.

Request Body schema:

Alter und neuer AccessToken

SessionToken
required
string non-empty

Pflichtfeld.

OldAccessToken
required
string <uuid>

Pflichtfeld.

NewAccessToken
required
string <uuid>

Responses

Request samples

Content type
{
  • "SessionToken": "string",
  • "OldAccessToken": "7640e32d-5902-42cd-ace9-31424920c539",
  • "NewAccessToken": "09206fbb-de27-4fc6-be2c-32e29ae21c63"
}

Response samples

Content type
No sample

Setzt das ValidUntil Datum ür dieses Token.

Request Body schema:

Bis wann der AccessToken gültig ist

SessionToken
required
string non-empty

Pflichtfeld.

AccessToken
required
string <uuid>

Pflichtfeld.

ValidUntil
required
string <date-time>

Responses

Request samples

Content type
{
  • "SessionToken": "string",
  • "AccessToken": "47ae41d8-6526-4dec-b4d3-0af9813e2b4b",
  • "ValidUntil": "2019-08-24T14:15:22Z"
}

Response samples

Content type
No sample