Requests
Requests durchführen
Host
Der Host für Web-API-Anfragen ist https://pcp-api.semyouonline.com
HTTPS
Alle Anfragen müssen über HTTPS erfolgen. Die API unterstützt kein HTTP.
HTTP Verbs
| Verb | Beschreibung |
|---|---|
| GET | Rufen Sie eine Ressource oder eine Gruppe von Ressourcen ab. Erwartet URL-Parameter |
| POST | Erstellen Sie eine neue Ressource. |
| PUST | Aktualisieren Sie eine vorhandene Ressource |
| DELETE | Löschen Sie eine vorhandene Ressource. Erwartet URL-Parameter |
Accept Header
Die API stellt JSON-Antworten bereit. Die API verwendet Content-Type=application/json
Formatierung des Requests
Request Body
Wenn Sie Daten per POST oder PUT an eine Ressource übermitteln, müssen Sie Ihre Daten in JSON übermitteln.
{
"Name": "mein Name"
}
Pagination
Einige GET-Ressourcen ermöglichen das Abrufen von Informationen in Stapeln. Die Abfrageargumente stehen in der Ressourcendokumentation zur Verfügung, wenn diese Option verfügbar ist.
Wenn Sie mehrere Datensätze anfordern, wird das Anforderungslimit standardmäßig auf 100 Datensätze festgelegt. Sie können ein anderes Limit angeben, aber das Standardlimit nicht überschreiten.
Dokumentierte Ressourcen zeigen eine fettgedruckte Liste der verfügbaren paginierten Parameter an, falls verfügbar.
Einfaches Beispiel für Pagination einer Abfrage
https://pcp-api.semyouonline.com/v1/projects?BuGuid=1581230-5C00-662A-A608-16BF6D4AC34D&Start=1&Limit=10
| Parameter | Beschreibung |
|---|---|
| start | Die Anzahl von Datensätzen die übersprungen werden. Dieser Parameter gibt die Startposition an. |
| limit | Die Anzahl von Datensätzen, die zurückgegeben werden. Maximale Limit ist 100 |