Path Params

plantId
UUID
required

Global eindeutige ID (UUID) des abgefragten Mischwerks

Query Params

region
string
conditionally required

Der Regionen-Identifier zur Eingrenzung der Suche auf eine Region. Mindestens einer der beiden Parameter ‘region’ oder ‘geoPosition’ ist Pflicht.

geoPosition
geoPoint
conditionally required

Die Geoposition zur Eingrenzung der Suche auf einen bestimmten Radius um diese Position. Mindestens einer der beiden Parameter ‘region’ oder ‘geoPosition’ ist Pflicht.

range
integer
default: 100

Der Suchradius in km um die gegebene Geoposition. Wird nur in Kombination mit dem Parameter ‘geoPosition’ verwendet.

type
string

Verfahrenstyp der Mischanlage ‚asphalt‘‚ ‘concrete‘, 'gravel’.

includingDemo
bool
default: false

Die Abfrage liefert neben den realen zusätzlich auch die Demo-Mischwerke. Dies sind mit dem Flag ‘isDemo’ gekennzeichnet.

Response Body (plants)

id
UUID
required

Systemübergreifend eindeutige ID (UUID) des Mischwerks. Diese wird vom System festgelegt, welches die Entität anlegt. Die ID ist für den Anwender nicht sichtbar.

identifier
string(100)
required

Bezeichnung des Mischwerks.

type
string(100)
required

Verfahrenstyp der Mischanlage ‚asphalt‘‚ ‘concrete‘, 'gravel’.

geoPosition
geoPoint
required

Geo-Position des Mischwerks.

country
string(20)
required

Landeskennung gemäss ISO 3166-1

region
string(100)

Bundesland oder Region

postalAddress
string(100)
required

Strasse

city
string(100)
required

Ortschaft

postalCode
string(100)
required

Postleitzahl

isDemo
bool

Das Mischwerk ist nicht real, sondern existiert lediglich für Demonstrationszwecke. Dieses Feld wird ausschliesslich dann zurückgelieferte, wenn der Query-Parameter ‘includingDemo’ gesetzt wurde.

properties
string(500)
required

Semikolon getrennte Aufzählung der Eigenschaften des Mischwerks:
'digitalReady': Dieses Mischwerk besitzt die Voraussetzung für einen vollständig digitalen Bestell- & Lieferprozess. Damit existiert in den Detailinformationen auch eine ‘baseUrlApi’ für den Zugriff auf das API des Mischwerks.

Path Params

plantId
UUID
required

Global eindeutige ID (UUID) des abgefragten Mischwerks

Response Body (plants)

id
UUID
required

Systemübergreifend eindeutige ID (UUID) des Mischwerks. Diese wird vom System festgelegt, welches die Entität anlegt. Die ID ist für den Anwender nicht sichtbar.

identifier
string(100)
required

Bezeichnung des Mischwerks.

alias
string(1000)

Semikolon getrennte Aufzählung von Alias d.h. alternative Mischwerksbezeichnungen (“also known as”). Die Bezeichnungen können mehrdeutig sein!

type
string(100)
required

Verfahrenstyp der Mischanlage ‚asphalt‘‚ ‘concrete‘, 'gravel’.

geoPosition
geoPoint
required

Geo-Position des Mischwerks.

country
string(20)
required

Landeskennung gemäss ISO 3166-1

region
string(100)

Bundesland oder Region

postalAddress
string(100)
required

Strasse

city
string(100)
required

Ortschaft

postalCode
string(100)
required

Postleitzahl

emailAddressOffice
string(100)

Allgemeine E-Mail-Adresse der Verwaltung

phoneOffice
string(100)

Telefonnummer Zentrale

fax
string(100)

Fax-Nummer

homepageUrl
string(1000)

URL der Homepage.

logoUrl
string(1000)

URL zum Unternehmens-Logo im PNG-Format. Hierbei handelt es sich um eine sogenannte “Shared Access Signature (SAS)”.

plantImageUrl
string(1000)

URL zum Anlagen-Bild im PNG-Format. Hierbei handelt es sich um eine sogenannte “Shared Access Signature (SAS)”.

phoneOfficeOders
string(100)

Telefonnummer für Mischgutbestellungen

emailAddressOrders
string(100

E-Mail-Adresse für Mischgutbestellungen

contactName
string(100)

Vollständiger Name des Kontaktes auf der Mischanlage

baseUrlApi
string(1000)

Base-URL des PlantX API’s zur digitalen Anbindung des Mischwerks. Damit besitzt das Mischwerk die Voraussetzung für einen vollständig digitalen Bestell- & Lieferprozess.

operatingIdentifier
string(100)

Betriebskennung oder -Nummer der Anlage.

loadingDuration
integer

Mittlere Beladedauer [s] (Mischgut)

unloadingDuration
integer

Mittlere Entladedauer [s] (Fräsgut)

productionPerformance
integer

Maximale Produktionsleistung (Nennleistung) der Mischanlage [t/h]

storageCapacity
integer

Gesamte Lagerkapazität an Heissmischgut [t]

plantArea
geofence

Geofence um das Werksgelände rund um die Mischwerksposition 'geoPosition'. Wird verwendet, um zu erkennen, ob sich Objekte wie LKW auf dem Areal befinden. Das Geofence wird in Form eines Polygons im Geo-JSON-Format geliefert. Es handelt sich um einen linearen Ring d.h. eine Aufzählung der Polygon-Eckpunkte (longitude, latitude WGS 84 ) im Gegenuhrzeigersinn. Der letzte Punkt ist mit dem Ersten deckungsgleich, womit das Polygon vollständig geschlossen ist.
Beispiel: {"type": "Polygon","coordinates":[[ [9.5606433, 49.1774781],[9.5606482, 49.1774756],[9.5606496, 49.1774767],[9.5606447, 49.1774792],[9.5606433, 49.1774781] ]]}

Sieh hierzu auch: https://q-point.atlassian.net/wiki/spaces/PUB/pages/1781202973/REST+Grundlagen+von+Q+Exchange#GEO-Fences

isDemo
bool

Das Mischwerk ist nicht real, sondern existiert lediglich für Demonstrationszwecke.

Query Params

skip
integer
0 <= Wert

Index im Result-Set. Anzahl Datensätze, welche zu überspringen sind. Wird verwendet, um nacheinander mehrere Data-Pages abzurufen.

take
integer
0 < Wert <= default
default:  200

Maximale Anzahl der als Response Body zurück gelieferten Datensätze. Falls das Feld fehlt oder der angegebene Wert über dem Default-Wert liegt, liefert die Anfragen maximal die als "default" festgelegte Anzahl Datensätze!

Path Params

articleId
UUID
required

Global eindeutige ID (UUID) des abgefragten Mischgutartikels

Response Body (articlesasphalt)

id
UUID
required

Systemübergreifend eindeutige ID (UUID) des Artikels. Diese wird vom System festgelegt, welches die Entität anlegt. Die ID ist für den Anwender nicht sichtbar.

identifier
string(100)
required

Kennung des Artikels. In der Regel die Artikel-Nummer aus dem ERP.

name
string(100)
required

Bezeichnung des Artikels.

group
string(100)

Artikelgruppe, zu welcher der Artikel gehört.

unit
string(40)
required

Masseinheit, in welcher der Artikel verkauft wird.

price
decimal(10,3)

Listenpreis / Masseinheit ‘unit’

currency
string(20)
conditionally required

Währungs-Kurzzeichen. Pflicht, sobald ein Preis vorliegt.

minPavingTemp
decimal(10,3)

Minimale Einbautemperatur des Mischguts

pavingTempUnit
string(40)
conditionally required

Masseinheit der Einbautemperatur. Pflicht, sobald ein Temperaturwert vorliegt.

minLoadingTemp
decimal(10,3)

Minimale Verladetemperatur des Mischguts auf dem Mischwerk.

maxLoadingTemp
decimal(10,3)

Maximale Verladetemperatur des Mischguts auf dem Mischwerk.

loadingTempUnit
string(40)
conditionally required

Masseinheit der Verladetemperatur. Pflicht, sobald ein Temperaturwert vorliegt.

compactedDensity
decimal(10,3)

Raumdichte des Mischguts

compactedDensityUnit
string(40)
conditionally required

Masseinheit der Raumdichte (in der Regel g/cm3 ). Pflicht, sobald ein Dichtewert vorliegt.

appraisalIdentifier
string(100)

Bezeichnung bzw. Nummer der Eignungsprüfung

appraisalValidityDate
date

Ablaufdatum der Eignungsprüfung.

appraisalDocUrl
string(1000)

URL zum Dokument der Eignungsprüfung. Hierbei handelt es sich um eine sogenannte “Shared Access Signature (SAS)”.

• Die URL besitzt eine beschränkte Gültigkeitsdauer von wenigen Tagen und darf deshalb clientseitig nicht gespeichert werden.

• Die Existenz der URL ist der Indikator, ob ein Dokument vorliegt oder nicht.

• Das Dokument ist per Definition vom MIME-Type "application/pdf”.

appraisalDocFilename
string(300)
conditionally required

Dateiname inklusive Extension der Eignungsprüfung (Beispielsweise: “EP 01-02354-14 Landeck.pdf“). Pflicht, sobald auch eine entsprechende URL 'appraisalDocUrl' vorhanden.

documents
list[document]

Liste von weiteren Dokumenten zum Artikel. In der Regel PDF-Dokumente.