HvmaApi Resource

POST /api/v1/hvma/logon

Request Body
media type data type
application/json HvmaLogonEntry (JSON)
application/xml hvmaLogonEntry (XML)
Response Body
media type data type description
application/json LoggedOnHvmaEntry (JSON)
application/xml;charset=UTF-8 object

Example

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

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

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

GET /api/v1/hvma/param

Request Parameters
name type description
hvtoken header
userid query
Response Body
media type data type description
application/json HvmaParamEntryList (JSON)
application/xml;charset=UTF-8 object

Example

Request
GET /api/v1/hvma/param
Content-Type: */*
Accept: application/json
hvtoken: ...

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "entries" : [ {
    "category" : "...",
    "value" : "...",
    "cnr" : "..."
  }, {
    "category" : "...",
    "value" : "...",
    "cnr" : "..."
  } ],
  "rowCount" : 12345
}

GET /api/v1/hvma/privilege

Die Liste der verfügbaren HVMARechte ausgeben

Request Parameters
name type description
hvtoken header
licenceCnr query ist optional. Ist der Parameter angegeben, werden die im System verfügbaren HVMA-Rechte für die angegebene Lizenz ermittelt. Ist der Parameter nicht angegeben, werden die HVMA-Rechte des angemeldeten HVMA-Benutzers ausgegeben.
userid query ist der angemeldete Benutzer
Response Body
media type data type description
application/json HvmarechtEnumEntryList (JSON) eine (leere) Liste der verfügbaren HVMA-Rechte
application/xml;charset=UTF-8 object

Example

Request
GET /api/v1/hvma/privilege
Content-Type: */*
Accept: application/json
hvtoken: ...

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "entries" : [ "DarfAuftragsKopfZeitBuchen", "Packliste" ],
  "rowCount" : 12345
}