pressmind® PIB API - Datensatzbeschreibung

Das Konzept des Produktinformationsblattes sieht vor, dass Produktblätter in unterschiedlichen Detailstufen produziert werden können. Somit sind fast alle Feldwerte optional, bzw. nur im Umfang der Detailstufe mit Daten zu beliefern.

Verknüpfung mit Pressmind
Grundsätzlich muss jedes produzierte Produktblatt mit einem PIM-Datensatz verknüpft sein. Das Objekt Produkt definiert die Verknüpfungsoptionen. Es stehen verschiedene Optionen zur Verknüpfung mit dem PIM-Datensatz bereit: die Verknüpfung via Code, Id oder IdPressmind.

Siehe auch: Objektaufbau / Beispiel JSON

Datensatzbeschreibung

Eigenschaft	Typ	Beschreibung
Vorgang	Objekt	siehe Tabelle "Vorgang"
Produkt	Objekt	Pflicht, Details siehe Tabelle "Produkt"
Anmelder	Objekt	siehe Tabelle "Anmelder"
Merkmale	Objekt-Liste (Array)	siehe Tabelle "Merkmale"
Zielgebiete	Objekt-Liste (Array)	siehe Tabelle "Zielgebiete"
Beschreibungen	Objekt-Liste (Array)	siehe Tabelle "Beschreibungen"
Leistungen	Objekt-Liste (Array)	siehe Tabelle "Leistungen"
Teilnehmer	Objekt-Liste (Array)	siehe Tabelle "Teilnehmer"

Objekt: Vorgang

Eigenschaft	Beispielwert	Typ	Beschreibung
Id	4711	int
Vorgangsnummer	877654321	string
Datum	2018-07-01	string	YYYY-MM-DD

Objekt: Produkt

Eigenschaft	Beispielwert	Typ	Beschreibung
JoinBy	(IdProdukt, CodeProdukt, IdPressmind, IdTermin, CodeTermin)	enum	Definiert die Verknüpfung zum pressmind® PIM-Datensatz.
IdProdukt	12	int	Pflicht wenn PIM Verknüpfung, siehe Feld "JoinBy"
CodeProdukt	IROM18	string	Pflicht wenn PIM Verknüpfung, siehe Feld "JoinBy"
IdPressmind	123456	int	Pflicht wenn PIM Verknüpfung, siehe Feld "JoinBy"
IdTermin	1200	int	Pflicht wenn PIM Verknüpfung, siehe Feld "JoinBy"
CodeTermin	IROM18	string	Pflicht wenn PIM Verknüpfung, siehe Feld "JoinBy"
TerminVon	2019-01-01	string	YYYY-MM-DD
TerminBis	2019-01-06	string	YYYY-MM-DD
Dauer	7	int	Dauer in Tagen
Anreiseart	Bus	string
Bezeichnung	Italien Rom - faszinierende Stadt	string
Gesamtpreis	1234.5	float
Anzahlungsbetrag	246.9	float
AnzahlungFaellig	2018-07-15	int
RestzahlungFaellig	2018-12-12	YYYY-MM-DD
Mindestteilnehmerzahl	21	int

Objekt: Anmelder

Eigenschaft	Beispielwert	Typ
Kundennummer	987654	string
Name	Mustermann	string
Vorname	Max	string
Strasse	Musterstr.	string
Hausnummer	12	string
Ort	Musterstadt	string
Land	DE	string

Objekt: Merkmale

Eigenschaft	Beispielwert	Typ
Code	RR	string
Name	Rundreise	string
Typ	Reiseart	string

Objekt: Zielgebiete

Eigenschaft	Beispielwert	Typ	Beschreibung
Code	IT	string
Name	Italien	string

Objekt: Beschreibungen

Eigenschaft	Typ	Beschreibung
Name	string
Text	string
Typ	string	z.B. Flugzeiten, Reiseinformationen, etc.

Objekt: Leistungen

Eigenschaft	Typ	Beschreibung
Id	int
Code	string
Typ	string	z.B. Zusatzleistung, Unterkunftsleistung, Anforderungscode
Code	string
Typ	string
Name	string
Beschreibung	string
Preis	float	Preis pro Teilnehmer
Teilnehmer	string	1,2

Objekt: Teilnehmer

Eigenschaft	Typ	Beschreibung
Lfd	int	Laufende Nummer des Teilnehmers
Name	string
Vorname	string
Geburtstag	string	YYYY-MM-DD
Nationalität	string

Objektaufbau / JSON Beispiel

{
    "Vorgangsnummer": "String",
    "Produkt": {
        "Id": "String",
        "Code": "String",
        "TerminVon": "String",
        "TerminBis": "String",
        "Dauer": "String",
        "Anreiseart": "String",
        "Bezeichnung": "String",
        "Gesamtpreis": 0,
        "Anzahlungsbetrag": 0,
        "AnzahlungFaellig": "String",
        "RestzahlungFaellig": "String",
        "Mindestteilnehmerzahl": 0
    },
    "Anmelder": {
        "Kundennummer": "String",
        "Name": "String",
        "Vorname": "String",
        "Strasse": "String",
        "Hausnummer": "String",
        "Ort": "String",
        "Land": "String"
    },
    "Merkmale": [
        {
            "Code": "String",
            "Name": "String",
            "Typ": "String"
        }
    ],
    "Zielgebiete": [
        {
            "Code": "String",
            "Beschreibung": "String"
        }
    ],
    "Beschreibungen": [
        {
            "Id": "String",
            "Name": "String",
            "Text": "String"
        }
    ],
    "Leistungen": [
        {
            "Id": 0,
            "Code": "String",
            "Typ": "String",
            "Name": "String",
            "Beschreibung": "String",
            "Preis": 120.5,
            "Teilnehmer": "String"
        }
    ],
    "Teilnehmer": [
        {
            "Lfd": 2012,
            "Name": "String",
            "Vorname": "String",
            "Geburtstag": "String",
            "Nationalitaet": "String"
        }
    ]
}

Datensatzbeschreibung pressmind® PIB API

Datensatzbeschreibung

Objektaufbau / JSON Beispiel

Details