GET api/Test

Test connection

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

MsgControl
NameDescriptionTypeAdditional information
result

Response flag: 1 = success else something went wrong: see Message

integer

Required

Message

Corresponding success and error message

string

Required

MethodName

The name of the API

string

None.

AppName

The name of the current API method

string

None.

EsoftUser

The username of the logged in Esoft user. Can be empty

string

None.

User

Username

string

None.

Password

Password

string

None.

SystemDate

Current date

date

None.

GenList

List of additional message for calls with multiple object

Collection of Collection of string

None.

GenMsg1

Additional message

string

None.

GenMsg2

Additional message

string

None.

GenMsg3

Additional message

string

None.

Response Formats

application/json, text/json

Sample:
{
  "result": 0,
  "Message": "Corresponding success and error message",
  "MethodName": "api/<Method>",
  "AppName": "EsoftWebApi",
  "EsoftUser": "ESOFT",
  "User": "Username",
  "Password": "Password",
  "SystemDate": "2025-01-06T22:32:15.1720865+02:00",
  "GenList": [],
  "GenMsg1": "",
  "GenMsg2": "",
  "GenMsg3": ""
}