POST 17.0/database/users

Description
Create Users

URI Parameters
None.

UsersUpdate

Name	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:14",
  "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:

<UsersUpdate xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <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:14:00.0979739+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>

application/x-www-form-urlencoded
Sample: Sample not available.

Users

Name	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": 2,
  "userDepartmentID": 3,
  "userName": "sample string 4",
  "password": "sample string 5",
  "passwordChangePeriod": 6,
  "passwordChangedDate": "2025-01-09T20:14",
  "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": 24,
  "backColor": 25,
  "displayMessages": 64,
  "suppressProcessOutlookEmails": 64,
  "photo": "sample string 28",
  "signature": "sample string 29",
  "branchManager": 64,
  "passwordResetToken": "sample string 31",
  "licenceNumber": "sample string 32"
}

application/xml, text/xml

Sample:

<Users xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <ID>1</ID>
  <UserTypeID>2</UserTypeID>
  <UserDepartmentID>3</UserDepartmentID>
  <UserName>sample string 4</UserName>
  <Password>sample string 5</Password>
  <PasswordChangePeriod>6</PasswordChangePeriod>
  <PasswordChangedDate>2025-01-09T20:14:00.113596+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>24</ForeColor>
  <BackColor>25</BackColor>
  <DisplayMessages>64</DisplayMessages>
  <SuppressProcessOutlookEmails>64</SuppressProcessOutlookEmails>
  <Photo>sample string 28</Photo>
  <Signature>sample string 29</Signature>
  <BranchManager>64</BranchManager>
  <PasswordResetToken>sample string 31</PasswordResetToken>
  <LicenceNumber>sample string 32</LicenceNumber>
</Users>

POST 17.0/database/users

Description

Request Information

URI Parameters

Body Parameters

Request Formats

application/json, text/json

application/xml, text/xml

application/x-www-form-urlencoded

Response Information

Resource Description

Response Formats

application/json, text/json

application/xml, text/xml