Endpoint
https://workinfo.xor.ch/api.svc
Visual Studio 2015
- Rechtsklick auf das Projekt, Hinzufügen --> Dienstverweis
- Folgende URL muss im Feld "Adresse" eingegeben werden: https://workinfo.xor.ch/api.svc
- Mittels einem Klick auf "Gehe zu" wird die Referenz ermittelt
- Abschliessend muss noch das Feld "Namespace" mit einem geeigneten Namen wie z.B. "XORWorkinfo" befüllt werden
CheckToken()
Prüft, ob das Authentifizierungstoken gültig ist.
CheckToken(UserToken As String) As Boolean
Parameter |
UserToken |
Authentifizierungs-Token, siehe Login() |
closeProject()
Schliesst ein Projekt ab.
closeProject(UserToken As String, projectGUID As String) As Integer
Parameter |
UserToken |
Authentifizierungs-Token, siehe Login() |
projectGUID |
Projekt Globally Unique Identifier |
Rückgabewert |
1 |
Projekt auf Status "Abgeschlossen" geändert. |
Ausnahmen |
FaultException(Of XORWorkinfo.UnauthorizedAccessFault) |
Ungültiges UserToken oder Benutzer mit diesem UserToken ist nicht berechtigt, das Projekt abzuschliessen. |
deleteProject()
Löscht ein Projekt.
deleteProject(UserToken As String, projectGUID As String) As Integer
Parameter |
UserToken |
Authentifizierungs-Token, siehe Login() |
projectGUID |
Projekt Globally Unique Identifier |
Rückgabewert |
1 |
Projekt wurde permanent gelöscht. |
Ausnahmen |
FaultException(Of XORWorkinfo.UnauthorizedAccessFault) |
Ungültiges UserToken oder Benutzer mit diesem UserToken ist nicht berechtigt, das Projekt zu löschen. |
GetEmployerProjectId()
Gibt die Auftragskennung des Arbeitgebers zurück.
GetEmployerProjectId(AuthToken As String, ProjectGuid As String) AS String
Parameter |
UserToken |
Authentifizierungs-Token, siehe Login() |
projectGUID |
Projekt Globally Unique Identifier |
Rückgabewert |
1 |
Projekt auf Status "Abgeschlossen" geändert. |
Ausnahmen |
FaultException(Of XORWorkinfo.UnauthorizedAccessFault) |
Ungültiges UserToken oder Benutzer mit diesem UserToken ist nicht berechtigt, das Projekt abzuschliessen. |
FaultException(Of XORWorkinfo.InvalidProjectFault) |
Benutzer wurde beim erstellen des Projekts nicht als Arbeitgeber angegeben. |
getProjectData()
Gibt die Detailinformationen eines Projektes zurück.
getProjectData(UserToken As String, projectGuid As String) AS CprojectData
Parameter |
UserToken |
Authentifizierungs-Token, siehe Login() |
projectGUID |
Projekt Globally Unique Identifier |
Rückgabewert |
CprojectData |
Klasse, welche Informationen über ein Projekt enthält. |
Ausnahmen |
FaultException(Of XORWorkinfo.UnauthorizedAccessFault) |
Ungültiges UserToken oder Benutzer mit diesem UserToken ist nicht berechtigt, das Projekt zu löschen. |
CprojectData
Properties |
ProjectAddress |
Projektadresse (Strasse Nr, PLZ Ort) |
ProjectDescription |
Kurze Projektbeschreibung |
ProjectGuid |
Projekt-bezogene Kennung |
ProjectName |
Projektbezeichnung |
TS |
Array der Klasse TS |
Login()
Generiert ein Authentifizierungs-Token für einen registrierten Benutzer.
Login(Email As String, pwd As String) As String
Parameter |
Email |
E-Mail Adresse des Benutzerkontos. |
pwd |
Passwort des Benutzerkontos. |
Rückgabewert |
userGUID |
Authentifizierungs-Token |
Ausnahmen |
FaultException(Of XORWorkinfo.InvalidCredentialFault) |
Benutzername und/oder Passwort falsch. |
Logout()
Authentifizierungstoken auf ungültig setzen.
Logout(userGUID As String)
Parameter |
userGUID |
Authentifizierungs-Token, siehe Login() |
Rückgabewert |
1 |
Das Authentifizierungs-Token wurde erfolgreich gelöscht. |
Ausnahmen |
FaultException(Of XORWorkinfo.UnauthorizedAccessFault) |
Ungültiges UserToken. |
modifyProject()
Ein bestehendes Projekt ändern.
modifyProject(UserToken As String, projectGUID As String, title As String, description As String, address As String)
Parameter |
userGUID |
Authentifizierungs-Token, siehe Login() |
projectGUID |
Projekt Globally Unique Identifier |
title |
Projektbezeichnung |
description |
Projektbeschreibung |
address |
Einsatz-Adresse (Strasse, Nr., PLZ Ort) |
Rückgabewert |
1 |
Das Projekt wurde gemäss den angegebenen Parametern geändert. |
Ausnahmen |
FaultException(Of XORWorkinfo.UnauthorizedAccessFault) |
Ungültiges UserToken. |
FaultException(Of XORWorkinfo.InvalidProjectFault) |
Benutzer wurde beim erstellen des Projekts weder als Arbeitgeber noch als Arbeitnehmer eingetragen. |
openProject()
Erstellt für einen Benutzer und dessen Geschäftspartner ein neues Projekt.
openProject(UserToken As String, typenr As Integer, title As String, description As String, address As String, eMail As String, intReadOnly As Integer)
Parameter |
UserToken |
Authentifizierungs-Token, siehe Login() |
projectGUID |
Projekt Globally Unique Identifier |
typenr |
1 = Benutzer wird als Arbeitgeber eingetragen, 2 = Benutzer wird als Arbeitnehmer eingetragen. |
title |
Projektbezeichnung |
description |
Projektbeschreibung |
address |
Einsatz-Adresse (Strasse, Nr., PLZ Ort) |
eMail |
E-Mail Geschäftspartner |
Rückgabewert |
ProjectGuid |
Projekt-bezogene Kennung |
Ausnahmen |
FaultException |
Parameter "typenr" darf nur den Wert "1" oder "2" enthalten. |
setStamp()
Fügt einem Projekt einen Zeitstempel hinzu.
setStamp(UserToken As String, projectGUID As String, typenr As Short, timestamp As Date, timestampText As String, gpsX As Double, gpsY As Double, gpstime As Date, gpsaddress As String, Optional gpsAccuracy As Double = 0)
Parameter |
UserToken |
Authentifizierungs-Token, siehe Login() |
ProjectGuid |
Projekt-bezogene Kennung |
typenr |
0: Projekt wird in die Rubrik "Projekte in Bearbeitung" gelegt, 1: Projekt wird in die Rubrik "Pausierte Projekte" gelegt. |
timestampText |
Bemerkung |
gpsX |
Latitude |
gpsY |
Longitude |
gpstime |
Zeitpunkt der Geolokalisierung |
gpsaddress |
GPS-Adresse (Strasse Nr, PLZ Ort) |
gpsAccuracy |
GPS-Genauigkeit |
Rückgabewert |
1 |
Zeitstempel erfolgreich gesetzt. |
2 |
Parameter "timestamp" ist älter als der letzte Eintrag. |
3 |
Parameter "typenr" muss den Wert "0" enthalten. |
4 |
Parameter "typenr" muss den Wert "1" enthalten. |
Ausnahmen |
FaultException(Of XORWorkinfo.UnauthorizedAccessFault) |
Ungültiges UserToken. |
FaultException |
Parameter "typenr" darf nur den Wert "0" oder "1" enthalten. |
TS
Klasse, die Informationen über einen Gps-Zeitstempel enthält
Parameter |
TsCreateDate |
Erstellungsdatum des Zeitstempels |
TsGpsAddress |
GPS-Adresse des Zeitstempels |
TsStatusDescription |
Beschreibung des Zeitstempels |
TsType |
0 -> Neu erstellte Projekte
3 -> Abgeschlossene Projekte
4 -> Abgeschlossene Projekte
10 -> Start
11 -> Stop
12 -> Projekt erstellt
|
TsGuid |
Globally Unique Identifier des Zeitstempels |