UserApi Resource

POST /api/v1/logon

Ermöglicht das Anmelden.

Request Body
media type data type description
application/json LogonEntry (JSON) Pflichtfelder sind username und password. Fehlt logonEntry.client wird der Hauptmandant verwendet Fehlt logonEntry.localeString wird die Sprache des Hauptmandanten verwendet
application/xml logonEntry (XML)
Response Body
media type data type description
application/json LoggedOnEntry (JSON) null wenn die Anmeldung nicht erfolgreich war, ansonsten die Anmeldung
application/xml;charset=UTF-8 object

Example

Request
POST /api/v1/logon
Content-Type: application/json
Accept: application/json

                
{
  "password" : "...",
  "client" : "...",
  "localeString" : "...",
  "username" : "..."
}
Response
HTTP/1.1 201 Created
Content-Type: application/json

                
{
  "token" : "...",
  "client" : "...",
  "localeString" : "..."
}

POST /api/v1/logonapp

Request Body
media type data type
application/json LogonTenantEntry (JSON)
application/xml logonTenantEntry (XML)
Response Body
media type data type description
application/json LoggedOnTenantEntry (JSON)
application/xml;charset=UTF-8 object

Example

Request
POST /api/v1/logonapp
Content-Type: application/json
Accept: application/json

                
{
  "tenantCnr" : "...",
  "password" : "...",
  "client" : "...",
  "localeString" : "...",
  "username" : "..."
}
Response
HTTP/1.1 201 Created
Content-Type: application/json

                
{
  "valid" : true,
  "possibleTenants" : {
    "entries" : [ {
      "description" : "...",
      "cnr" : "..."
    }, {
      "description" : "...",
      "cnr" : "..."
    } ]
  },
  "token" : "...",
  "client" : "...",
  "localeString" : "..."
}

GET /api/v1/logout

Ermöglicht das Abmelden.

Request Parameters
name type description
userid query wurde zuvor von einem "logon" ermittelt.

Example

Request
GET /api/v1/logout
Content-Type: */*

                
...
Response
HTTP/1.1 200 OK

POST /api/v1/password

Request Parameters
name type description
userid query
Request Body
media type data type
application/json ChangePasswordEntry (JSON)
application/xml changePasswordEntry (XML)

Example

Request
POST /api/v1/password
Content-Type: application/json

                
{
  "password" : "..."
}
Response
HTTP/1.1 201 Created

POST /api/v1/logonidcard/{idcard}

Ermöglicht das Abmelden über die Ausweisnummer eines Personals.

Request Parameters
name type description
idcard path Ausweisnummer des anzumeldenden Personals
Request Body
media type data type description
application/json LogonIdCardEntry (JSON) Fehlt logonEntry.client wird der Hauptmandant verwendet Fehlt logonEntry.localeString wird die Sprache des Hauptmandanten verwendet
application/xml logonIdCardEntry (XML)
Response Body
media type data type description
application/json LoggedOnEntry (JSON) null wenn die Anmeldung nicht erfolgreich war, ansonsten die Anmeldung
application/xml;charset=UTF-8 object

Example

Request
POST /api/v1/logonidcard/{idcard}
Content-Type: application/json
Accept: application/json

                
{
  "client" : "...",
  "localeString" : "..."
}
Response
HTTP/1.1 201 Created
Content-Type: application/json

                
{
  "token" : "...",
  "client" : "...",
  "localeString" : "..."
}

GET /api/v1/logout/{token}

Ermöglicht das Abmelden.

Request Parameters
name type description
token path wurde zuvor von einem "logon" ermittelt.

Example

Request
GET /api/v1/logout/{token}
Content-Type: */*

                
...
Response
HTTP/1.1 200 OK