API: Generierung von PDF oder Bild für eine Perzentilenkurve
Erlaubt die Generierung einer Perzentilenkurve des gewünschten Typs und Formats anhand der übergebenen Messdaten. Dabei werden keinerlei Messdaten oder Parameter gespeichert, die übergebenen Messdaten werden unmittelbar wieder verworfen.
curl -X PUT -H "API-Key: {API_KEY}" https://api.wachstum.at/api/xml/chart/{TYP}/{FORMAT} --data "@@patient.xml"
Der Parameter TYP steuert den Typ der Perzentilenkurve muss einen der folgenden Werte umfassen:
HeightHeightWithTurnerSyndromeHeightWithNoonanSyndromeHeightWithAchondroplasiaBmiWithAchondroplasiaHeadWithAchondroplasiaBmiWeightWeightLengthHeadLegSitSitLegRatioHeightPrematureHeightPrematureCombinedWeightPrematureWeightPrematureCombinedHeadPrematureHeadPrematureCombined
Der Parameter FORMAT steuert den das Dateiformat (Bildformat) des Ergebnisses und muss einen der folgenden Werte umfassen:
PdfJpgPngSvgHtmlPdfAndDataXmlCsvJson
Zur Übergabe der Messdaten des Patienten wird die selbe Datenstruktur erwartet wie auch bei der Berechnung der Parameter.
Größe einer Perzentilenkurve steuern
Es ist außerdem möglich, die Größe des generierten Bildes zu steuern (trifft nur bei Perzentilenkurven im Bild-Format wie PNG oder JPG zu). Hier sind zwei Varianten möglich: Die Skalierung der Perzentilenkurve anhand eines Faktors ("Zoom"), oder die Angabe von Breite und Höhe in Pixeln.
Um die Skalierung einer Perzentilenkurve zu steuern, muss ein Query-Parameter scale übergeben werden. Wird dieser Parameter nicht übergeben, wird der Default-Wert 1 verwendet.
curl -X PUT -H "API-Key: {API_KEY}" https://api.wachstum.at/api/xml/chart/{TYP}/{FORMAT}?scale=2.5 --data "@@patient.xml"
Die Skalierung steuert den "Zoom" der Perzentilenkurve und dient dazu, die Perzentilenkurve als Ganzes zu vergrößern oder zu verkleinern. Üblicherweise ist die Skalierung der ideale Weg, um eine Perzentilenkurve in der gewünschten Größe zu generieren.
Anstelle der Skalierung kann die Größe der Perzentilenkurve auch explizit über Angabe von Breite und Höhe (in Pixeln) gesteuert werden. Hierfür müssen die Query-Parameter width und height angegeben werden. Werden diese Parameter nicht übergeben, wird der Default-Wert von 1000 Pixeln sowohl in der Höhe als auch der Breite angenommen.
curl -X PUT -H "API-Key: {API_KEY}" https://api.wachstum.at/api/xml/chart/{TYP}/{FORMAT}?width=500&height=750 --data "@@patient.xml"
Im Unterschied zur Skalierung wird in dieser Variante nicht die die Perzentilenkurve als Ganzes vergrößert oder verkleinert, sondern der zur Verfügung stehende Platz für die Perzentilenkurve konfiguriert. Das heißt, dass die Beschriftung der Perzentilenkurve (zB Titel) in der Größe nicht verändert wird, also beispielsweise bei sehr hoher Breite und Höhe relativ gesehen zur gesamten Perzentilenkurve sehr klein ist. Für die meisten Anwendungsfälle ist daher die Variante über die Skalierung zu bevorzugen, eine Konfiguration von Breite und Höhe macht aber beispielsweise dann Sinn, wenn das Seitenverhältnis der Perzentilenkurve angepasst werden soll.
Ausschnitt einer Perzentilenkurve steuern
Standardmäßig wird der sichtbare Bildauschnitt einer Perzentilenkurve automatisch so gewählt, dass einerseits alle Parameter des Patienten vollständig angezeigt werden können, und andererseits die Referenzwerte (Perzentilen) vollständig bis deren Ende (bei den meisten Perzentilenkurve sind Referenzdaten bis zum 19. Lebensjahr des Patienten verfügbar) angezeigt werden können. Bei Patienten, die jünger als 4 Jahre sind, werden manche Perzentilenkurven (zB Körperlänge/-größe) auf eine Anzeige bis zum 4. Lebensjahr optimiert.
In manchen Fällen kann es aber wünschenswert sein, dieses automatische Verhalten manuell zu steuern. Dafür stehen die Parameter crop_x und crop_x_at, sowie crop_y und crop_y_at zur Verfügung. Beispielsweise lässt der folgende Aufruf die Perzentilenkurve bei 15 Jahren enden, egal ob noch Parameter nach dem 15. Lebensjahr vorhanden sind:
curl -X PUT -H "API-Key: {API_KEY}" https://api.wachstum.at/api/xml/chart/{TYP}/{FORMAT}?crop_x=true&crop_x_at=15 --data "@@patient.xml"
Je nach Kombination dieser Parameter kann der Bildausschnitt der generierten Perzentilenkurve frei konfiguriert werden:
- Ist
crop_xmittrueangegeben, undcrop_x_atein gültiger Zahlenwert, dann endet die X-Achse der Perzentilenkurve an diesem Zahlenwert. Dabei können allerdings die Parameter des Patienten abgeschnitten werden. - Ist nur
crop_xmittrueangegeben, dann endet die X-Achse mit dem letzten Parameter des Patienten. - Ist
crop_ymittrueangegeben, undcrop_y_atein gültiger Zahlenwert, dann endet die Y-Achse der Perzentilenkurve an diesem Zahlenwert. Dabei können allerdings die Referenzwerte (Perzentilen) abgeschnitten werden. - Ist nur
crop_ymittrueangegeben, dann endet die Y-Achse mit dem letzten Parameter des Patienten.