Verwenden Sie unsere REST API, um auf Daten in SEAMLESS zuzugreifen und sie zu aktualisieren.
SEAMLESS REST API unterstützt am Endpoint eine Token-basierte Authentifizierung, die mittels der SEAMLESS Applikation ausgestellt werden.
#### 1. Index **Über die Methode GET an der URL /api/services können Benutzer eine Liste aller Services abrufen, die nach dem Erstellungsdatum in absteigender Reihenfolge sortiert ist. Bei Erfolg liefert die API einen 200 OK Status mit einer entsprechenden Erfolgsmeldung und der Liste der Services. Bei einem Serverfehler gibt die API einen 500 Internal Server Error aus.** - **Methode**: GET - **URL**: /api/services - **Beschreibung**: Ruft eine Liste aller Services ab, sortiert nach Erstellungsdatum in absteigender Reihenfolge. - **Erfolgsantwort**: - Status: 200 OK - Beispiel: ```json { "status": "success", "message": "fetched", "services": [...] } ``` - **Fehlerantwort**: - Status: 500 Internal Server Error - Beispiel: ```json { "status": "error", "message": "Failed to fetch services" } ```
#### 2. Show ** Ebenfalls über GET, aber an der URL /api/services/{id}, können Details eines spezifischen Services abgerufen werden. Bei Erfolg liefert dies ebenfalls einen 200 OK Status. Bei einem nicht auffindbaren Service wird ein 404 Not Found Status zurückgegeben, und bei Serverfehlern ein 500 Internal Server Error.** - **Methode**: GET - **URL**: /api/services/{id} - **Beschreibung**: Ruft die Details eines spezifischen Services ab. - **Erfolgsantwort**: - Status: 200 OK - Beispiel: ```json { "status": "success", "message": "fetched", "service": {...} } ``` - **Fehlerantwort**: - Status: 404 Not Found - Beispiel: ```json { "status": "error", "message": "Service not found" } ``` - Status: 500 Internal Server Error - Beispiel: ```json { "status": "error", "message": "Failed to fetch service" } ```
#### 3. Update **Dieser Vorgang erlaubt die Aktualisierung eines Services mittels PUT oder PATCH an der URL /api/services/{id}. Erfolg resultiert in einem 200 OK Status mit der Bestätigung der Aktualisierung. Fehlschläge aufgrund nicht auffindbarer Services führen zu einem 404 Not Found, Validierungsfehler zu einem 422 Unprocessable Entity und Serverfehler zu einem 500 Internal Server Error.** - **Methode**: PUT/PATCH - **URL**: /api/services/{id} - **Beschreibung**: Aktualisiert die Details eines spezifischen Services. - **Erfolgsantwort**: - Status: 200 OK - Beispiel: ```json { "status": "success", "message": "updated", "service": {...} } ``` - **Fehlerantwort**: - Status: 404 Not Found - Beispiel: ```json { "status": "error", "message": "Service not found" } ``` - Status: 422 Unprocessable Entity - Beispiel: ```json { "status": "error", "message": "Validation failed" } ``` - Status: 500 Internal Server Error - Beispiel: ```json { "status": "error", "message": "Failed to update service" } ```
#### 4. Destroy **Über die Methode DELETE an der URL /api/services/{id} kann ein Service gelöscht werden. Bei Erfolg wird der Status 200 OK zurückgegeben. Wenn der Service nicht gefunden wird, gibt es einen 404 Not Found Status und bei Serverfehlern einen 500 Internal Server Error.** - **Methode**: DELETE - **URL**: /api/services/{id} - **Beschreibung**: Löscht einen spezifischen Service. - **Erfolgsantwort**: - Status: 200 OK - Beispiel: ```json { "status": "success", "message": "deleted" } ``` - **Fehlerantwort**: - Status: 404 Not Found - Beispiel: ```json { "status": "error", "message": "Service not found" } ``` - Status: 500 Internal Server Error - Beispiel: ```json { "status": "error", "message": "Failed to delete service" } ```
## Validierung für Update (Service) **Für die Aktualisierung von Services existiert eine Validierungslogik, die diverse optionale Felder wie Name, Kategorie, Beschreibung und viele andere überprüft, um sicherzustellen, dass die eingereichten Daten innerhalb definierter Grenzen liegen (z. B. maximale Zeichenlänge, Wertebereich bei numerischen Daten).** Die folgenden Felder können im Update-Endpunkt validiert werden: - `name`: optional, string, max. 255 Zeichen - `category_id`: optional, - `short_description`: optional, string, max. 255 Zeichen - `status`: optional, string, max. 255 Zeichen - `statuspercent`: optional, integer, min. 0, max. 100 - `servicetype`: optional, string, max. 255 Zeichen - `content`: optional, string - `description`: optional, string - `advantages`: optional, string - `art_nr`: optional, string, max. 255 Zeichen - `user`: optional, string, max. 255 Zeichen - `booking`: optional, string - `restriction`: optional, string - `cancelling`: optional, string - `delivery_time`: optional, string, max. 255 Zeichen - `delivery_point`: optional, string, max. 255 Zeichen - `reporting`: optional, string - `servicelevel`: optional, string - `servicelevelvalues`: optional, string - `serviceprovidercontract`: optional, string - `customerspecific`: optional, string - `serviceart`: optional, string - `plannedchanges`: optional, string - `processingpersonaldata`: optional, string - `personaldata`: optional, string - `processingsensitivpersonaldata`: optional, string - `processingpersonaldatalaw`: optional, string - `personaldatastorageduration`: optional, string - `personaldatatransfer`: optional, string - `costs`: optional, integer, min. 0
#### 1. Index **Diese Funktion wird über die Methode GET und die URL /api/serviceLevels aufgerufen und holt eine Liste aller Service Levels, die nach ihrem Erstellungsdatum in aufsteigender Reihenfolge sortiert sind. Bei Erfolg gibt der Server den Status 200 OK mit einer Erfolgsmeldung und den Service Level-Daten zurück. Bei einem Serverfehler wird der Status 500 Internal Server Error ausgegeben.** - **Methode**: GET - **URL**: /api/serviceLevels - **Beschreibung**: Ruft eine Liste aller Service Levels ab, sortiert nach Erstellungsdatum in aufsteigender Reihenfolge. - **Erfolgsantwort**: - Status: 200 OK - Beispiel: ```json { "status": "success", "message": "fetched", "serviceLevels": [...] } ``` - **Fehlerantwort**: - Status: 500 Internal Server Error - Beispiel: ```json { "status": "error", "message": "Failed to fetch service levels" } ```
#### 2. Show **Über die Methode GET und die URL /api/serviceLevels/{id} können Details zu einem spezifischen Service Level abgerufen werden. Die erfolgreiche Abfrage resultiert in einem 200 OK Status mit den Details des Service Levels. Fehlt der Service Level, gibt es einen 404 Not Found Status, und bei Serverproblemen einen 500 Internal Server Error.** - **Methode**: GET - **URL**: /api/serviceLevels/{id} - **Beschreibung**: Ruft die Details eines spezifischen Service Levels ab. - **Erfolgsantwort**: - Status: 200 OK - Beispiel: ```json { "status": "success", "message": "fetched", "serviceLevel": {...} } ``` - **Fehlerantwort**: - Status: 404 Not Found - Beispiel: ```json { "status": "error", "message": "Service level not found" } ``` - Status: 500 Internal Server Error - Beispiel: ```json { "status": "error", "message": "Failed to fetch service level" } ```
#### 3. Update **Durch die Methoden PUT oder PATCH an der URL /api/serviceLevels/{id} können Details eines bestimmten Service Levels aktualisiert werden. Bei Erfolg wird der Status 200 OK mit einer Bestätigungsmeldung zurückgegeben. Wenn der Service Level nicht gefunden wird, resultiert dies in einem 404 Not Found Status, bei Validierungsfehlern in einem 422 Unprocessable Entity und bei Serverproblemen in einem 500 Internal Server Error.** - **Methode**: PUT/PATCH - **URL**: /api/serviceLevels/{id} - **Beschreibung**: Aktualisiert die Details eines spezifischen Service Levels. - **Erfolgsantwort**: - Status: 200 OK - Beispiel: ```json { "status": "success", "message": "updated", "serviceLevel": {...} } ``` - **Fehlerantwort**: - Status: 404 Not Found - Beispiel: ```json { "status": "error", "message": "Service level not found" } ``` - Status: 422 Unprocessable Entity - Beispiel: ```json { "status": "error", "message": "Validation failed" } ``` - Status: 500 Internal Server Error - Beispiel: ```json { "status": "error", "message": "Failed to update service level" } ```
#### 4. Destroy **Mit der Methode DELETE und der URL /api/serviceLevels/{id} kann ein spezifischer Service Level gelöscht werden. Bei Erfolg meldet der Server einen 200 OK Status. Fehlt der Service Level, wird ein 404 Not Found Status ausgegeben, und bei Serverfehlern ein 500 Internal Server Error.** - **Methode**: DELETE - **URL**: /api/serviceLevels/{id} - **Beschreibung**: Löscht einen spezifischen Service Level. - **Erfolgsantwort**: - Status: 200 OK - Beispiel: ```json { "status": "success", "message": "deleted" } ``` - **Fehlerantwort**: - Status: 404 Not Found - Beispiel: ```json { "status": "error", "message": "Service level not found" } ``` - Status: 500 Internal Server Error - Beispiel: ```json { "status": "error", "message": "Failed to delete service level" } ```
## Validierung für Update (ServiceLevel) **Für den Update-Vorgang gibt es eine Validierungslogik, die sicherstellt, dass die Daten wie Name und Definition die vorgegebenen Beschränkungen (z.B. maximale Zeichenanzahl) erfüllen. Diese Funktionen ermöglichen eine effiziente Verwaltung und Aktualisierung von Service Level-Daten innerhalb der Anwendung.** Die folgenden Felder können im Update-Endpunkt validiert werden: - `name`: optional, string, max. 255 Zeichen - `definition`: optional, string, max. 40000 Zeichen - `calculation`: optional, string, max. 40000 Zeichen - `measuring_points`: optional, string, max. 40000 Zeichen
#### 1. Index **Über die Methode GET an der URL /api/serviceOwners können Benutzer eine Liste aller Service Owners abrufen. Die erfolgreiche Abfrage liefert einen 200 OK Status, eine Erfolgsmeldung und die Daten der Service Owners. Bei einem Serverfehler wird ein 500 Internal Server Error Status zurückgegeben.** - **Methode**: GET - **URL**: /api/serviceOwners - **Beschreibung**: Ruft eine Liste aller Service Owners ab. - **Erfolgsantwort**: - Status: 200 OK - Beispiel: ```json { "status": "success", "message": "fetched", "owners": [...] } ``` - **Fehlerantwort**: - Status: 500 Internal Server Error - Beispiel: ```json { "status": "error", "message": "Failed to fetch service owners" } ```
#### 2. Show **Durch den GET-Aufruf an der URL /api/serviceOwners/{id} können Details eines spezifischen Service Owners abgerufen werden. Bei Erfolg wird der Status 200 OK mit einer entsprechenden Erfolgsmeldung und den Details des Service Owners zurückgegeben. Fehlt der Service Owner, wird ein 404 Not Found Status ausgegeben, und bei Serverproblemen ein 500 Internal Server Error.** - **Methode**: GET - **URL**: /api/serviceOwners/{id} - **Beschreibung**: Ruft die Details eines spezifischen Service Owners ab. - **Erfolgsantwort**: - Status: 200 OK - Beispiel: ```json { "status": "success", "message": "fetched", "owner": {...} } ``` - **Fehlerantwort**: - Status: 404 Not Found - Beispiel: ```json { "status": "error", "message": "Service owner not found" } ``` - Status: 500 Internal Server Error - Beispiel: ```json { "status": "error", "message": "Failed to fetch service owner" } ```
#### 3. Update **Die Methoden PUT oder PATCH an der URL /api/serviceOwners/{id} erlauben das Aktualisieren der Details eines spezifischen Service Owners. Ein erfolgreicher Aufruf liefert den Status 200 OK mit einer Erfolgsmeldung und den aktualisierten Daten des Owners. Bei einem nicht gefundenen Service Owner wird ein 404 Not Found Status ausgegeben, bei Validierungsfehlern ein 422 Unprocessable Entity, und bei Serverproblemen ein 500 Internal Server Error.** - **Methode**: PUT/PATCH - **URL**: /api/serviceOwners/{id} - **Beschreibung**: Aktualisiert die Details eines spezifischen Service Owners. - **Erfolgsantwort**: - Status: 200 OK - Beispiel: ```json { "status": "success", "message": "updated", "owner": {...} } ``` - **Fehlerantwort**: - Status: 404 Not Found - Beispiel: ```json { "status": "error", "message": "Service owner not found" } ``` - Status: 422 Unprocessable Entity - Beispiel: ```json { "status": "error", "message": "Validation failed" } ``` - Status: 500 Internal Server Error - Beispiel: ```json { "status": "error", "message": "Failed to update service owner" } ```
#### 4. Destroy **Mit der Methode DELETE an der URL /api/serviceOwners/{id} kann ein spezifischer Service Owner gelöscht werden. Bei Erfolg meldet der Server einen 200 OK Status mit einer entsprechenden Erfolgsmeldung. Fehlt der Service Owner, wird ein 404 Not Found Status ausgegeben, und bei Serverfehlern ein 500 Internal Server Error.** - **Methode**: DELETE - **URL**: /api/serviceOwners/{id} - **Beschreibung**: Löscht einen spezifischen Service Owner. - **Erfolgsantwort**: - Status: 200 OK - Beispiel: ```json { "status": "success", "message": "deleted" } ``` - **Fehlerantwort**: - Status: 404 Not Found - Beispiel: ```json { "status": "error", "message": "Service owner not found" } ``` - Status: 500 Internal Server Error - Beispiel: ```json { "status": "error", "message": "Failed to delete service owner" } ```
## Validierung für Update (ServiceOwner) **Für die Aktualisierung von Service Owner-Daten besteht eine Validierungslogik, die sicherstellt, dass optionale Felder wie Name, E-Mail und Kontakt die festgelegten Datenbeschränkungen erfüllen. Diese Funktionalitäten ermöglichen eine effektive Verwaltung und Pflege von Service Owner-Daten innerhalb der API.** Die folgenden Felder können im Update-Endpunkt validiert werden: - `name`: optional, string, max. 255 Zeichen - `email`: optional, string, max. 255 Zeichen - `contact`: optional, string, max. 255 Zeichen
Sie haben Fragen zu SEAMLESS, für die Ihnen unsere FAQ keine Antworten liefern?
Wir freuen uns über Ihre Anfrage und stehen Ihnen gerne zur Beantwortung Ihrer Anliegen zur Verfügung.
Sprechen Sie uns einfach an!
07251 – 302 22 51
[javascript protected email address]