POST 17.0/database/users/list

Description

Retrieve a list of Users

URI Parameters

None.

ListOptions
Name Description Type Additional information
Fields

Collection of string

None.
Filters

Collection of DatabaseFilter

None.
Order

string

None.

application/json, text/json
Sample: 
{
  "fields": [
    "sample string 1",
    "sample string 2"
  ],
  "filters": [
    {
      "fieldName": "sample string 1",
      "value": "sample string 2",
      "operator": "sample string 3",
      "valueType": "sample string 4"
    },
    {
      "fieldName": "sample string 1",
      "value": "sample string 2",
      "operator": "sample string 3",
      "valueType": "sample string 4"
    }
  ],
  "order": "sample string 1"
}

application/xml, text/xml
Sample: 
<ListOptions xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Fields>
    <string>sample string 1</string>
    <string>sample string 2</string>
  </Fields>
  <Filters>
    <DatabaseFilter>
      <FieldName>sample string 1</FieldName>
      <Value>sample string 2</Value>
      <Operator>sample string 3</Operator>
      <ValueType>sample string 4</ValueType>
    </DatabaseFilter>
    <DatabaseFilter>
      <FieldName>sample string 1</FieldName>
      <Value>sample string 2</Value>
      <Operator>sample string 3</Operator>
      <ValueType>sample string 4</ValueType>
    </DatabaseFilter>
  </Filters>
  <Order>sample string 1</Order>
</ListOptions>

application/x-www-form-urlencoded
Sample:

Sample not available.

Collection of UsersUpdate
Name Description Type Additional information
ID

integer

None.
UserTypeID

integer

None.
UserDepartmentID

integer

None.
UserName

string

String length: inclusive between 0 and 30
Password

string

String length: inclusive between 0 and 30
PasswordChangePeriod

integer

None.
PasswordChangedDate

date

None.
LanguageID

byte

None.
StartupForm

byte

None.
NegotiatorType

byte

None.
AllowSignatoryChange

byte

None.
DiaryView

byte

None.
SyncOutlook

byte

None.
DiarySyncLevel

byte

None.
ReminderSystem

byte

None.
ReminderContacts

byte

None.
ReminderFinancial

byte

None.
ReminderPropertyManagement

byte

None.
ReminderSales

byte

None.
ReminderLettings

byte

None.
ReminderAppointments

byte

None.
ReminderCertificates

byte

None.
EmailTasks

byte

None.
ForeColor

integer

None.
BackColor

integer

None.
DisplayMessages

byte

None.
SuppressProcessOutlookEmails

byte

None.
Photo

string

String length: inclusive between 0 and 255
Signature

string

String length: inclusive between 0 and 255
BranchManager

byte

None.
PasswordResetToken

string

String length: inclusive between 0 and 50
LicenceNumber

string

String length: inclusive between 0 and 30

application/json, text/json
Sample: 
[
  {
    "id": 1,
    "userTypeID": 1,
    "userDepartmentID": 1,
    "userName": "sample string 1",
    "password": "sample string 2",
    "passwordChangePeriod": 1,
    "passwordChangedDate": "2025-01-09T20:15",
    "languageID": 64,
    "startupForm": 64,
    "negotiatorType": 64,
    "allowSignatoryChange": 64,
    "diaryView": 64,
    "syncOutlook": 64,
    "diarySyncLevel": 64,
    "reminderSystem": 64,
    "reminderContacts": 64,
    "reminderFinancial": 64,
    "reminderPropertyManagement": 64,
    "reminderSales": 64,
    "reminderLettings": 64,
    "reminderAppointments": 64,
    "reminderCertificates": 64,
    "emailTasks": 64,
    "foreColor": 1,
    "backColor": 1,
    "displayMessages": 64,
    "suppressProcessOutlookEmails": 64,
    "photo": "sample string 3",
    "signature": "sample string 4",
    "branchManager": 64,
    "passwordResetToken": "sample string 5",
    "licenceNumber": "sample string 6"
  },
  {
    "id": 1,
    "userTypeID": 1,
    "userDepartmentID": 1,
    "userName": "sample string 1",
    "password": "sample string 2",
    "passwordChangePeriod": 1,
    "passwordChangedDate": "2025-01-09T20:15",
    "languageID": 64,
    "startupForm": 64,
    "negotiatorType": 64,
    "allowSignatoryChange": 64,
    "diaryView": 64,
    "syncOutlook": 64,
    "diarySyncLevel": 64,
    "reminderSystem": 64,
    "reminderContacts": 64,
    "reminderFinancial": 64,
    "reminderPropertyManagement": 64,
    "reminderSales": 64,
    "reminderLettings": 64,
    "reminderAppointments": 64,
    "reminderCertificates": 64,
    "emailTasks": 64,
    "foreColor": 1,
    "backColor": 1,
    "displayMessages": 64,
    "suppressProcessOutlookEmails": 64,
    "photo": "sample string 3",
    "signature": "sample string 4",
    "branchManager": 64,
    "passwordResetToken": "sample string 5",
    "licenceNumber": "sample string 6"
  }
]

application/xml, text/xml
Sample: 
<ArrayOfUsersUpdate xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <UsersUpdate>
    <ID>1</ID>
    <UserTypeID>1</UserTypeID>
    <UserDepartmentID>1</UserDepartmentID>
    <UserName>sample string 1</UserName>
    <Password>sample string 2</Password>
    <PasswordChangePeriod>1</PasswordChangePeriod>
    <PasswordChangedDate>2025-01-09T20:15:57.7971893+00:00</PasswordChangedDate>
    <LanguageID>64</LanguageID>
    <StartupForm>64</StartupForm>
    <NegotiatorType>64</NegotiatorType>
    <AllowSignatoryChange>64</AllowSignatoryChange>
    <DiaryView>64</DiaryView>
    <SyncOutlook>64</SyncOutlook>
    <DiarySyncLevel>64</DiarySyncLevel>
    <ReminderSystem>64</ReminderSystem>
    <ReminderContacts>64</ReminderContacts>
    <ReminderFinancial>64</ReminderFinancial>
    <ReminderPropertyManagement>64</ReminderPropertyManagement>
    <ReminderSales>64</ReminderSales>
    <ReminderLettings>64</ReminderLettings>
    <ReminderAppointments>64</ReminderAppointments>
    <ReminderCertificates>64</ReminderCertificates>
    <EmailTasks>64</EmailTasks>
    <ForeColor>1</ForeColor>
    <BackColor>1</BackColor>
    <DisplayMessages>64</DisplayMessages>
    <SuppressProcessOutlookEmails>64</SuppressProcessOutlookEmails>
    <Photo>sample string 3</Photo>
    <Signature>sample string 4</Signature>
    <BranchManager>64</BranchManager>
    <PasswordResetToken>sample string 5</PasswordResetToken>
    <LicenceNumber>sample string 6</LicenceNumber>
  </UsersUpdate>
  <UsersUpdate>
    <ID>1</ID>
    <UserTypeID>1</UserTypeID>
    <UserDepartmentID>1</UserDepartmentID>
    <UserName>sample string 1</UserName>
    <Password>sample string 2</Password>
    <PasswordChangePeriod>1</PasswordChangePeriod>
    <PasswordChangedDate>2025-01-09T20:15:57.7971893+00:00</PasswordChangedDate>
    <LanguageID>64</LanguageID>
    <StartupForm>64</StartupForm>
    <NegotiatorType>64</NegotiatorType>
    <AllowSignatoryChange>64</AllowSignatoryChange>
    <DiaryView>64</DiaryView>
    <SyncOutlook>64</SyncOutlook>
    <DiarySyncLevel>64</DiarySyncLevel>
    <ReminderSystem>64</ReminderSystem>
    <ReminderContacts>64</ReminderContacts>
    <ReminderFinancial>64</ReminderFinancial>
    <ReminderPropertyManagement>64</ReminderPropertyManagement>
    <ReminderSales>64</ReminderSales>
    <ReminderLettings>64</ReminderLettings>
    <ReminderAppointments>64</ReminderAppointments>
    <ReminderCertificates>64</ReminderCertificates>
    <EmailTasks>64</EmailTasks>
    <ForeColor>1</ForeColor>
    <BackColor>1</BackColor>
    <DisplayMessages>64</DisplayMessages>
    <SuppressProcessOutlookEmails>64</SuppressProcessOutlookEmails>
    <Photo>sample string 3</Photo>
    <Signature>sample string 4</Signature>
    <BranchManager>64</BranchManager>
    <PasswordResetToken>sample string 5</PasswordResetToken>
    <LicenceNumber>sample string 6</LicenceNumber>
  </UsersUpdate>
</ArrayOfUsersUpdate>