PUT api/Login

This method facilitates the login.

Request Information

URI Parameters

None.

Body Parameters

The user object.

User

Name	Description	Type	Additional information
Id		integer	None.
UserName		string	None.
Anrede		string	None.
Name		string	None.
Vorname		string	None.
Passwort		string	None.
PasswortLetzteAenderung		date	None.
Tel		string	None.
Mobil		string	None.
Email		string	None.
Sprache		string	None.
Begruendung		string	None.
Firma		string	None.
Adresse1		string	None.
Adresse2		string	None.
Land		string	None.
Plz		string	None.
Ort		string	None.
Uid		string	None.
Rolle		integer	None.
LoeschKz		boolean	None.
InternetKz		boolean	None.
Aktiv		boolean	None.
CustomerId		integer	None.
Company	Company prefix at the table level as an integer. Use ITCHelper.GetCorporateTablePrefix for conversion into XXA.	integer	None.
GroupId		integer	None.
ErstellDat		date	None.
ErstellUs		string	None.
AendDat		date	None.
AendUs		string	None.

Request Formats

application/json, text/json

Sample:

{
  "Id": 1,
  "UserName": "sample string 1",
  "Anrede": "sample string 2",
  "Name": "sample string 3",
  "Vorname": "sample string 4",
  "Passwort": "sample string 5",
  "PasswortLetzteAenderung": "2026-04-07T13:24:21.1300516+02:00",
  "Tel": "sample string 6",
  "Mobil": "sample string 7",
  "Email": "sample string 8",
  "Sprache": "sample string 9",
  "Begruendung": "sample string 10",
  "Firma": "sample string 11",
  "Adresse1": "sample string 12",
  "Adresse2": "sample string 13",
  "Land": "sample string 14",
  "Plz": "sample string 15",
  "Ort": "sample string 16",
  "Uid": "sample string 17",
  "Rolle": 1,
  "LoeschKz": true,
  "InternetKz": true,
  "Aktiv": true,
  "CustomerId": 1,
  "Company": 1,
  "GroupId": 1,
  "ErstellDat": "2026-04-07T13:24:21.1300516+02:00",
  "ErstellUs": "sample string 21",
  "AendDat": "2026-04-07T13:24:21.1300516+02:00",
  "AendUs": "sample string 22"
}

application/xml, text/xml

Sample:

<User xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BestaendeWeb.Models">
  <Adresse1>sample string 12</Adresse1>
  <Adresse2>sample string 13</Adresse2>
  <AendDat>2026-04-07T13:24:21.1300516+02:00</AendDat>
  <AendUs>sample string 22</AendUs>
  <Aktiv>true</Aktiv>
  <Anrede>sample string 2</Anrede>
  <Begruendung>sample string 10</Begruendung>
  <Company>1</Company>
  <CustomerId>1</CustomerId>
  <Email>sample string 8</Email>
  <ErstellDat>2026-04-07T13:24:21.1300516+02:00</ErstellDat>
  <ErstellUs>sample string 21</ErstellUs>
  <Firma>sample string 11</Firma>
  <GroupId>1</GroupId>
  <Id>1</Id>
  <InternetKz>true</InternetKz>
  <Land>sample string 14</Land>
  <LoeschKz>true</LoeschKz>
  <Mobil>sample string 7</Mobil>
  <Name>sample string 3</Name>
  <Ort>sample string 16</Ort>
  <Passwort>sample string 5</Passwort>
  <PasswortLetzteAenderung>2026-04-07T13:24:21.1300516+02:00</PasswortLetzteAenderung>
  <Plz>sample string 15</Plz>
  <Rolle>1</Rolle>
  <Sprache>sample string 9</Sprache>
  <Tel>sample string 6</Tel>
  <Uid>sample string 17</Uid>
  <UserName>sample string 1</UserName>
  <Vorname>sample string 4</Vorname>
</User>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

An authorization object for the use with the http-interceptor.

Authorization

Name	Type	Additional information
UserId	integer	None.
GroupId	integer	None.
UserName	string	None.
GroupName	string	None.
UserEmail	string	None.
Uid	string	None.
Company	integer	None.
CustomerId	integer	None.
UserRole	integer	None.
UserLanguage	string	None.
MustChangePassword	boolean	None.

Response Formats

application/json, text/json

Sample:

{
  "UserId": 1,
  "GroupId": 1,
  "UserName": "sample string 1",
  "GroupName": "sample string 2",
  "UserEmail": "sample string 3",
  "Uid": "sample string 4",
  "Company": 1,
  "CustomerId": 1,
  "UserRole": 1,
  "UserLanguage": "sample string 5",
  "MustChangePassword": true
}

application/xml, text/xml

Sample:

<Authorization xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BestaendeWeb.Models">
  <Company>1</Company>
  <CustomerId>1</CustomerId>
  <GroupId>1</GroupId>
  <GroupName>sample string 2</GroupName>
  <MustChangePassword>true</MustChangePassword>
  <Uid>sample string 4</Uid>
  <UserEmail>sample string 3</UserEmail>
  <UserId>1</UserId>
  <UserLanguage>sample string 5</UserLanguage>
  <UserName>sample string 1</UserName>
  <UserRole>1</UserRole>
</Authorization>