POST user/logout

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional information
username		string	Required
deviceID		string	None.

Request Formats

application/json, text/json

Sample:

{
  "username": "sample string 1",
  "deviceID": "sample string 2"
}

text/html

Sample:

{"username":"sample string 1","deviceID":"sample string 2"}

application/xml, text/xml

Sample:

<LogoutCredentials xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ListenerOnline.BusinessEntities">
  <deviceID>sample string 2</deviceID>
  <username>sample string 1</username>
</LogoutCredentials>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'LogoutCredentials'.

Response Information

Resource Description

LoginResult

Name	Type	Additional information
LoginSuccessful	boolean	None.
LoginMessage	string	None.
Username	string	None.
Password	string	None.
Token	string	None.
FullName	string	None.
Modules	string	None.
Rights	string	None.
ContextMenuActions	string	None.
Tenant	integer	None.
Roles	string	None.
UserImage	string	None.
UserThumbnail	string	None.
UserThumbnailUrl	string	None.
CompanyName	string	None.
CompanyLogo	string	None.
CompanyBackgroundId	integer	None.
UserType	string	None.
AuthenticationMethod	integer	None.
UserId	integer	None.
NewPasswordRequired	boolean	None.
PabxEnabled	boolean	None.
VoipExtension	string	None.
RequiresPhoneExtension	boolean	None.
HasFixedPhoneExtension	boolean	None.
MultiplePabx	boolean	None.
ActiveSession	boolean	None.
Pabxes	Collection of Pabx	None.
UserPreferences	Collection of UserPreferenceEntity	None.
HideDashboard	boolean	None.
TCLink	string	None.
SubAccounts	Collection of ChildLoginAccount	None.
DueTasks	integer	None.
Jwt	string	None.
AppVersion	AppVersionInfo	None.
VoipEnabled	boolean	None.
TimeoutLimit	integer	None.
XyroUrl	string	None.
EnforceDvs	boolean	None.
DvsUrl	string	None.
TrustedUser	boolean	None.
CompanyBackgroundUrl	string	None.
UseOldTickets	boolean	None.

Response Formats

application/json, text/json

Sample:

{
  "LoginSuccessful": true,
  "LoginMessage": "sample string 2",
  "Username": "sample string 3",
  "Password": "sample string 4",
  "Token": "sample string 5",
  "FullName": "sample string 6",
  "Modules": "sample string 7",
  "Rights": "sample string 8",
  "ContextMenuActions": "sample string 9",
  "Tenant": 10,
  "Roles": "sample string 11",
  "UserImage": "sample string 12",
  "UserThumbnail": "sample string 13",
  "UserThumbnailUrl": "sample string 14",
  "CompanyName": "sample string 15",
  "CompanyLogo": "sample string 16",
  "CompanyBackgroundId": 1,
  "UserType": "sample string 17",
  "AuthenticationMethod": 18,
  "UserId": 19,
  "NewPasswordRequired": true,
  "PabxEnabled": true,
  "VoipExtension": "sample string 22",
  "RequiresPhoneExtension": true,
  "HasFixedPhoneExtension": true,
  "MultiplePabx": true,
  "ActiveSession": true,
  "Pabxes": [
    {
      "PABX": 1,
      "TenantId": 2,
      "PABXSystem": "sample string 3",
      "IsActive": true,
      "Version": "sample string 5",
      "PabxUrl": "sample string 6",
      "DisableUserOnCallDecline": true
    },
    {
      "PABX": 1,
      "TenantId": 2,
      "PABXSystem": "sample string 3",
      "IsActive": true,
      "Version": "sample string 5",
      "PabxUrl": "sample string 6",
      "DisableUserOnCallDecline": true
    }
  ],
  "UserPreferences": [
    {
      "KeyId": 1,
      "TenantId": 2,
      "UserId": 3,
      "PrefKey": "sample string 4",
      "PrefValue": "sample string 5"
    },
    {
      "KeyId": 1,
      "TenantId": 2,
      "UserId": 3,
      "PrefKey": "sample string 4",
      "PrefValue": "sample string 5"
    }
  ],
  "HideDashboard": true,
  "TCLink": "sample string 28",
  "SubAccounts": [
    {
      "Username": "sample string 1",
      "Password": "sample string 2",
      "Icon": "sample string 3",
      "TenantName": "sample string 4",
      "TenantId": 5,
      "UrlIdentifier": "sample string 6"
    },
    {
      "Username": "sample string 1",
      "Password": "sample string 2",
      "Icon": "sample string 3",
      "TenantName": "sample string 4",
      "TenantId": 5,
      "UrlIdentifier": "sample string 6"
    }
  ],
  "DueTasks": 29,
  "Jwt": "sample string 30",
  "AppVersion": {
    "ProductVersion": "sample string 1",
    "BuildVersion": "sample string 2",
    "BuildDate": "2026-04-17T11:35:05.5426587+00:00",
    "WebApi": "sample string 4",
    "Xyro": "sample string 5",
    "BusinessServices": "sample string 6",
    "SharedLibraries": "sample string 7",
    "DataModel": "sample string 8",
    "BusinessEntities": "sample string 9"
  },
  "VoipEnabled": true,
  "TimeoutLimit": 31,
  "XyroUrl": "sample string 32",
  "EnforceDvs": true,
  "DvsUrl": "sample string 34",
  "TrustedUser": true,
  "CompanyBackgroundUrl": "sample string 36",
  "UseOldTickets": true
}

text/html

Sample:

{"LoginSuccessful":true,"LoginMessage":"sample string 2","Username":"sample string 3","Password":"sample string 4","Token":"sample string 5","FullName":"sample string 6","Modules":"sample string 7","Rights":"sample string 8","ContextMenuActions":"sample string 9","Tenant":10,"Roles":"sample string 11","UserImage":"sample string 12","UserThumbnail":"sample string 13","UserThumbnailUrl":"sample string 14","CompanyName":"sample string 15","CompanyLogo":"sample string 16","CompanyBackgroundId":1,"UserType":"sample string 17","AuthenticationMethod":18,"UserId":19,"NewPasswordRequired":true,"PabxEnabled":true,"VoipExtension":"sample string 22","RequiresPhoneExtension":true,"HasFixedPhoneExtension":true,"MultiplePabx":true,"ActiveSession":true,"Pabxes":[{"PABX":1,"TenantId":2,"PABXSystem":"sample string 3","IsActive":true,"Version":"sample string 5","PabxUrl":"sample string 6","DisableUserOnCallDecline":true},{"PABX":1,"TenantId":2,"PABXSystem":"sample string 3","IsActive":true,"Version":"sample string 5","PabxUrl":"sample string 6","DisableUserOnCallDecline":true}],"UserPreferences":[{"KeyId":1,"TenantId":2,"UserId":3,"PrefKey":"sample string 4","PrefValue":"sample string 5"},{"KeyId":1,"TenantId":2,"UserId":3,"PrefKey":"sample string 4","PrefValue":"sample string 5"}],"HideDashboard":true,"TCLink":"sample string 28","SubAccounts":[{"Username":"sample string 1","Password":"sample string 2","Icon":"sample string 3","TenantName":"sample string 4","TenantId":5,"UrlIdentifier":"sample string 6"},{"Username":"sample string 1","Password":"sample string 2","Icon":"sample string 3","TenantName":"sample string 4","TenantId":5,"UrlIdentifier":"sample string 6"}],"DueTasks":29,"Jwt":"sample string 30","AppVersion":{"ProductVersion":"sample string 1","BuildVersion":"sample string 2","BuildDate":"2026-04-17T11:35:05.5426587+00:00","WebApi":"sample string 4","Xyro":"sample string 5","BusinessServices":"sample string 6","SharedLibraries":"sample string 7","DataModel":"sample string 8","BusinessEntities":"sample string 9"},"VoipEnabled":true,"TimeoutLimit":31,"XyroUrl":"sample string 32","EnforceDvs":true,"DvsUrl":"sample string 34","TrustedUser":true,"CompanyBackgroundUrl":"sample string 36","UseOldTickets":true}

application/xml, text/xml

Sample:

<LoginResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ListenerOnline.BusinessEntities">
  <ActiveSession>true</ActiveSession>
  <AppVersion xmlns:d2p1="http://schemas.datacontract.org/2004/07/ListenerOnline.BusinessEntities.Users">
    <d2p1:BuildDate>2026-04-17T11:35:05.5426587+00:00</d2p1:BuildDate>
    <d2p1:BuildVersion>sample string 2</d2p1:BuildVersion>
    <d2p1:BusinessEntities>sample string 9</d2p1:BusinessEntities>
    <d2p1:BusinessServices>sample string 6</d2p1:BusinessServices>
    <d2p1:DataModel>sample string 8</d2p1:DataModel>
    <d2p1:ProductVersion>sample string 1</d2p1:ProductVersion>
    <d2p1:SharedLibraries>sample string 7</d2p1:SharedLibraries>
    <d2p1:WebApi>sample string 4</d2p1:WebApi>
    <d2p1:Xyro>sample string 5</d2p1:Xyro>
  </AppVersion>
  <AuthenticationMethod>18</AuthenticationMethod>
  <CompanyBackgroundId>1</CompanyBackgroundId>
  <CompanyBackgroundUrl>sample string 36</CompanyBackgroundUrl>
  <CompanyLogo>sample string 16</CompanyLogo>
  <CompanyName>sample string 15</CompanyName>
  <ContextMenuActions>sample string 9</ContextMenuActions>
  <DueTasks>29</DueTasks>
  <DvsUrl>sample string 34</DvsUrl>
  <EnforceDvs>true</EnforceDvs>
  <FullName>sample string 6</FullName>
  <HasFixedPhoneExtension>true</HasFixedPhoneExtension>
  <HideDashboard>true</HideDashboard>
  <Jwt>sample string 30</Jwt>
  <LoginMessage>sample string 2</LoginMessage>
  <LoginSuccessful>true</LoginSuccessful>
  <Modules>sample string 7</Modules>
  <MultiplePabx>true</MultiplePabx>
  <NewPasswordRequired>true</NewPasswordRequired>
  <PabxEnabled>true</PabxEnabled>
  <Pabxes xmlns:d2p1="http://schemas.datacontract.org/2004/07/ListenerOnline.BusinessEntities.Phone">
    <d2p1:Pabx>
      <d2p1:DisableUserOnCallDecline>true</d2p1:DisableUserOnCallDecline>
      <d2p1:IsActive>true</d2p1:IsActive>
      <d2p1:PABX>1</d2p1:PABX>
      <d2p1:PABXSystem>sample string 3</d2p1:PABXSystem>
      <d2p1:PabxUrl>sample string 6</d2p1:PabxUrl>
      <d2p1:TenantId>2</d2p1:TenantId>
      <d2p1:Version>sample string 5</d2p1:Version>
    </d2p1:Pabx>
    <d2p1:Pabx>
      <d2p1:DisableUserOnCallDecline>true</d2p1:DisableUserOnCallDecline>
      <d2p1:IsActive>true</d2p1:IsActive>
      <d2p1:PABX>1</d2p1:PABX>
      <d2p1:PABXSystem>sample string 3</d2p1:PABXSystem>
      <d2p1:PabxUrl>sample string 6</d2p1:PabxUrl>
      <d2p1:TenantId>2</d2p1:TenantId>
      <d2p1:Version>sample string 5</d2p1:Version>
    </d2p1:Pabx>
  </Pabxes>
  <Password>sample string 4</Password>
  <RequiresPhoneExtension>true</RequiresPhoneExtension>
  <Rights>sample string 8</Rights>
  <Roles>sample string 11</Roles>
  <SubAccounts xmlns:d2p1="http://schemas.datacontract.org/2004/07/ListenerOnline.BusinessEntities.Users">
    <d2p1:ChildLoginAccount>
      <d2p1:Icon>sample string 3</d2p1:Icon>
      <d2p1:Password>sample string 2</d2p1:Password>
      <d2p1:TenantId>5</d2p1:TenantId>
      <d2p1:TenantName>sample string 4</d2p1:TenantName>
      <d2p1:UrlIdentifier>sample string 6</d2p1:UrlIdentifier>
      <d2p1:Username>sample string 1</d2p1:Username>
    </d2p1:ChildLoginAccount>
    <d2p1:ChildLoginAccount>
      <d2p1:Icon>sample string 3</d2p1:Icon>
      <d2p1:Password>sample string 2</d2p1:Password>
      <d2p1:TenantId>5</d2p1:TenantId>
      <d2p1:TenantName>sample string 4</d2p1:TenantName>
      <d2p1:UrlIdentifier>sample string 6</d2p1:UrlIdentifier>
      <d2p1:Username>sample string 1</d2p1:Username>
    </d2p1:ChildLoginAccount>
  </SubAccounts>
  <TCLink>sample string 28</TCLink>
  <Tenant>10</Tenant>
  <TimeoutLimit>31</TimeoutLimit>
  <Token>sample string 5</Token>
  <TrustedUser>true</TrustedUser>
  <UseOldTickets>true</UseOldTickets>
  <UserId>19</UserId>
  <UserImage>sample string 12</UserImage>
  <UserPreferences xmlns:d2p1="http://schemas.datacontract.org/2004/07/ListenerOnline.BusinessEntities.Users">
    <d2p1:UserPreferenceEntity>
      <d2p1:KeyId>1</d2p1:KeyId>
      <d2p1:PrefKey>sample string 4</d2p1:PrefKey>
      <d2p1:PrefValue>sample string 5</d2p1:PrefValue>
      <d2p1:TenantId>2</d2p1:TenantId>
      <d2p1:UserId>3</d2p1:UserId>
    </d2p1:UserPreferenceEntity>
    <d2p1:UserPreferenceEntity>
      <d2p1:KeyId>1</d2p1:KeyId>
      <d2p1:PrefKey>sample string 4</d2p1:PrefKey>
      <d2p1:PrefValue>sample string 5</d2p1:PrefValue>
      <d2p1:TenantId>2</d2p1:TenantId>
      <d2p1:UserId>3</d2p1:UserId>
    </d2p1:UserPreferenceEntity>
  </UserPreferences>
  <UserThumbnail>sample string 13</UserThumbnail>
  <UserThumbnailUrl>sample string 14</UserThumbnailUrl>
  <UserType>sample string 17</UserType>
  <Username>sample string 3</Username>
  <VoipEnabled>true</VoipEnabled>
  <VoipExtension>sample string 22</VoipExtension>
  <XyroUrl>sample string 32</XyroUrl>
</LoginResult>