POST rest/Users
Request Information
URI Parameters
None.
Body Parameters
UserModel| Name | Description | Type | Additional information |
|---|---|---|---|
| ID | integer |
None. |
|
| CompanyID | integer |
None. |
|
| FirstName | string |
None. |
|
| LastName | string |
None. |
|
| Title | string |
None. |
|
| string |
None. |
||
| Options | string |
None. |
|
| Role | string |
None. |
|
| RoleDisplay | string |
None. |
|
| RoleID | integer |
None. |
|
| Offices | Collection of OfficeSmallModel |
None. |
|
| Company | string |
None. |
|
| CreateDate | date |
None. |
|
| ModifiedDate | date |
None. |
|
| isTempPass | boolean |
None. |
|
| IsActive | boolean |
None. |
|
| IsDeleted | boolean |
None. |
|
| LoggedInCompanyID | integer |
None. |
|
| ProfilePicture | Collection of byte |
None. |
|
| UserRoleCompanies | Collection of UserRoleCompanyModel |
None. |
|
| UniqueID | string |
None. |
|
| IsSSOUser | boolean |
None. |
|
| IgnoreSidebarRecolor | boolean |
None. |
|
| Market | string |
None. |
|
| Department | string |
None. |
|
| EmployeeID | string |
None. |
|
| WorkGroup | string |
None. |
|
| FilterSets | Collection of FilterSetModel |
None. |
|
| FilterSetIDs | Collection of integer |
None. |
Request Formats
application/json, text/json
Sample:
{
"ID": 1,
"CompanyID": 2,
"FirstName": "sample string 3",
"LastName": "sample string 4",
"Title": "sample string 5",
"Email": "sample string 6",
"Options": "sample string 7",
"Role": "sample string 8",
"RoleDisplay": "sample string 9",
"RoleID": 10,
"Offices": [
{
"ID": 1,
"CompanyID": 2,
"Name": "sample string 3",
"Region": "sample string 4",
"Latitude": 5.1,
"Longitude": 6.1,
"IsActive": true
},
{
"ID": 1,
"CompanyID": 2,
"Name": "sample string 3",
"Region": "sample string 4",
"Latitude": 5.1,
"Longitude": 6.1,
"IsActive": true
}
],
"Company": "sample string 11",
"CreateDate": "2026-03-31T14:32:24.8163076+00:00",
"ModifiedDate": "2026-03-31T14:32:24.8163076+00:00",
"isTempPass": true,
"IsActive": true,
"IsDeleted": true,
"LoggedInCompanyID": 16,
"ProfilePicture": "QEA=",
"UserRoleCompanies": [
{
"ID": 1,
"UserID": 2,
"RoleID": 3,
"CompID": 4,
"RoleName": "sample string 5",
"RoleDisplayName": "sample string 6",
"CompanyName": "sample string 7",
"ExpirationDate": "2026-03-31T14:32:24.8163076+00:00",
"AllowSuperAdmin": true,
"IsConfirmed": true
},
{
"ID": 1,
"UserID": 2,
"RoleID": 3,
"CompID": 4,
"RoleName": "sample string 5",
"RoleDisplayName": "sample string 6",
"CompanyName": "sample string 7",
"ExpirationDate": "2026-03-31T14:32:24.8163076+00:00",
"AllowSuperAdmin": true,
"IsConfirmed": true
}
],
"UniqueID": "sample string 17",
"IsSSOUser": true,
"IgnoreSidebarRecolor": true,
"Market": "sample string 20",
"Department": "sample string 21",
"EmployeeID": "sample string 22",
"WorkGroup": "sample string 23",
"FilterSets": [
{
"ID": 1,
"TableID": 2,
"Name": "sample string 3",
"JSON": "sample string 4",
"IsShared": true,
"CreateDate": "2026-03-31T14:32:24.8163076+00:00",
"ModifiedDate": "2026-03-31T14:32:24.8163076+00:00",
"CreatedUserID": 1,
"CreatedUser": "sample string 7",
"ModifiedUser": "sample string 8"
},
{
"ID": 1,
"TableID": 2,
"Name": "sample string 3",
"JSON": "sample string 4",
"IsShared": true,
"CreateDate": "2026-03-31T14:32:24.8163076+00:00",
"ModifiedDate": "2026-03-31T14:32:24.8163076+00:00",
"CreatedUserID": 1,
"CreatedUser": "sample string 7",
"ModifiedUser": "sample string 8"
}
],
"FilterSetIDs": [
1,
2
]
}
text/xml
Sample:
<UserModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Navigator.Models">
<Company>sample string 11</Company>
<CompanyID>2</CompanyID>
<CreateDate>2026-03-31T14:32:24.8163076+00:00</CreateDate>
<Department>sample string 21</Department>
<Email>sample string 6</Email>
<EmployeeID>sample string 22</EmployeeID>
<FilterSetIDs xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:int>1</d2p1:int>
<d2p1:int>2</d2p1:int>
</FilterSetIDs>
<FilterSets>
<FilterSetModel>
<CreateDate>2026-03-31T14:32:24.8163076+00:00</CreateDate>
<CreatedUser>sample string 7</CreatedUser>
<CreatedUserID>1</CreatedUserID>
<ID>1</ID>
<IsShared>true</IsShared>
<JSON>sample string 4</JSON>
<ModifiedDate>2026-03-31T14:32:24.8163076+00:00</ModifiedDate>
<ModifiedUser>sample string 8</ModifiedUser>
<Name>sample string 3</Name>
<TableID>2</TableID>
</FilterSetModel>
<FilterSetModel>
<CreateDate>2026-03-31T14:32:24.8163076+00:00</CreateDate>
<CreatedUser>sample string 7</CreatedUser>
<CreatedUserID>1</CreatedUserID>
<ID>1</ID>
<IsShared>true</IsShared>
<JSON>sample string 4</JSON>
<ModifiedDate>2026-03-31T14:32:24.8163076+00:00</ModifiedDate>
<ModifiedUser>sample string 8</ModifiedUser>
<Name>sample string 3</Name>
<TableID>2</TableID>
</FilterSetModel>
</FilterSets>
<FirstName>sample string 3</FirstName>
<ID>1</ID>
<IgnoreSidebarRecolor>true</IgnoreSidebarRecolor>
<IsActive>true</IsActive>
<IsDeleted>true</IsDeleted>
<IsSSOUser>true</IsSSOUser>
<LastName>sample string 4</LastName>
<LoggedInCompanyID>16</LoggedInCompanyID>
<Market>sample string 20</Market>
<ModifiedDate>2026-03-31T14:32:24.8163076+00:00</ModifiedDate>
<Offices>
<OfficeSmallModel>
<CompanyID>2</CompanyID>
<ID>1</ID>
<IsActive>true</IsActive>
<Latitude>5.1</Latitude>
<Longitude>6.1</Longitude>
<Name>sample string 3</Name>
<Region>sample string 4</Region>
</OfficeSmallModel>
<OfficeSmallModel>
<CompanyID>2</CompanyID>
<ID>1</ID>
<IsActive>true</IsActive>
<Latitude>5.1</Latitude>
<Longitude>6.1</Longitude>
<Name>sample string 3</Name>
<Region>sample string 4</Region>
</OfficeSmallModel>
</Offices>
<Options>sample string 7</Options>
<ProfilePicture>QEA=</ProfilePicture>
<Role>sample string 8</Role>
<RoleDisplay>sample string 9</RoleDisplay>
<RoleID>10</RoleID>
<Title>sample string 5</Title>
<UniqueID>sample string 17</UniqueID>
<UserRoleCompanies>
<UserRoleCompanyModel>
<AllowSuperAdmin>true</AllowSuperAdmin>
<CompID>4</CompID>
<CompanyName>sample string 7</CompanyName>
<ExpirationDate>2026-03-31T14:32:24.8163076+00:00</ExpirationDate>
<ID>1</ID>
<IsConfirmed>true</IsConfirmed>
<RoleDisplayName>sample string 6</RoleDisplayName>
<RoleID>3</RoleID>
<RoleName>sample string 5</RoleName>
<UserID>2</UserID>
</UserRoleCompanyModel>
<UserRoleCompanyModel>
<AllowSuperAdmin>true</AllowSuperAdmin>
<CompID>4</CompID>
<CompanyName>sample string 7</CompanyName>
<ExpirationDate>2026-03-31T14:32:24.8163076+00:00</ExpirationDate>
<ID>1</ID>
<IsConfirmed>true</IsConfirmed>
<RoleDisplayName>sample string 6</RoleDisplayName>
<RoleID>3</RoleID>
<RoleName>sample string 5</RoleName>
<UserID>2</UserID>
</UserRoleCompanyModel>
</UserRoleCompanies>
<WorkGroup>sample string 23</WorkGroup>
<isTempPass>true</isTempPass>
</UserModel>
application/x-www-form-urlencoded
Sample:
Response Information
Resource Description
UserModel| Name | Description | Type | Additional information |
|---|---|---|---|
| ID | integer |
None. |
|
| CompanyID | integer |
None. |
|
| FirstName | string |
None. |
|
| LastName | string |
None. |
|
| Title | string |
None. |
|
| string |
None. |
||
| Options | string |
None. |
|
| Role | string |
None. |
|
| RoleDisplay | string |
None. |
|
| RoleID | integer |
None. |
|
| Offices | Collection of OfficeSmallModel |
None. |
|
| Company | string |
None. |
|
| CreateDate | date |
None. |
|
| ModifiedDate | date |
None. |
|
| isTempPass | boolean |
None. |
|
| IsActive | boolean |
None. |
|
| IsDeleted | boolean |
None. |
|
| LoggedInCompanyID | integer |
None. |
|
| ProfilePicture | Collection of byte |
None. |
|
| UserRoleCompanies | Collection of UserRoleCompanyModel |
None. |
|
| UniqueID | string |
None. |
|
| IsSSOUser | boolean |
None. |
|
| IgnoreSidebarRecolor | boolean |
None. |
|
| Market | string |
None. |
|
| Department | string |
None. |
|
| EmployeeID | string |
None. |
|
| WorkGroup | string |
None. |
|
| FilterSets | Collection of FilterSetModel |
None. |
|
| FilterSetIDs | Collection of integer |
None. |
Response Formats
application/json, text/json
Sample:
{
"ID": 1,
"CompanyID": 2,
"FirstName": "sample string 3",
"LastName": "sample string 4",
"Title": "sample string 5",
"Email": "sample string 6",
"Options": "sample string 7",
"Role": "sample string 8",
"RoleDisplay": "sample string 9",
"RoleID": 10,
"Offices": [
{
"ID": 1,
"CompanyID": 2,
"Name": "sample string 3",
"Region": "sample string 4",
"Latitude": 5.1,
"Longitude": 6.1,
"IsActive": true
},
{
"ID": 1,
"CompanyID": 2,
"Name": "sample string 3",
"Region": "sample string 4",
"Latitude": 5.1,
"Longitude": 6.1,
"IsActive": true
}
],
"Company": "sample string 11",
"CreateDate": "2026-03-31T14:32:24.9717009+00:00",
"ModifiedDate": "2026-03-31T14:32:24.9717009+00:00",
"isTempPass": true,
"IsActive": true,
"IsDeleted": true,
"LoggedInCompanyID": 16,
"ProfilePicture": "QEA=",
"UserRoleCompanies": [
{
"ID": 1,
"UserID": 2,
"RoleID": 3,
"CompID": 4,
"RoleName": "sample string 5",
"RoleDisplayName": "sample string 6",
"CompanyName": "sample string 7",
"ExpirationDate": "2026-03-31T14:32:24.9717009+00:00",
"AllowSuperAdmin": true,
"IsConfirmed": true
},
{
"ID": 1,
"UserID": 2,
"RoleID": 3,
"CompID": 4,
"RoleName": "sample string 5",
"RoleDisplayName": "sample string 6",
"CompanyName": "sample string 7",
"ExpirationDate": "2026-03-31T14:32:24.9717009+00:00",
"AllowSuperAdmin": true,
"IsConfirmed": true
}
],
"UniqueID": "sample string 17",
"IsSSOUser": true,
"IgnoreSidebarRecolor": true,
"Market": "sample string 20",
"Department": "sample string 21",
"EmployeeID": "sample string 22",
"WorkGroup": "sample string 23",
"FilterSets": [
{
"ID": 1,
"TableID": 2,
"Name": "sample string 3",
"JSON": "sample string 4",
"IsShared": true,
"CreateDate": "2026-03-31T14:32:24.9717009+00:00",
"ModifiedDate": "2026-03-31T14:32:24.9717009+00:00",
"CreatedUserID": 1,
"CreatedUser": "sample string 7",
"ModifiedUser": "sample string 8"
},
{
"ID": 1,
"TableID": 2,
"Name": "sample string 3",
"JSON": "sample string 4",
"IsShared": true,
"CreateDate": "2026-03-31T14:32:24.9717009+00:00",
"ModifiedDate": "2026-03-31T14:32:24.9717009+00:00",
"CreatedUserID": 1,
"CreatedUser": "sample string 7",
"ModifiedUser": "sample string 8"
}
],
"FilterSetIDs": [
1,
2
]
}
text/xml
Sample:
<UserModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Navigator.Models">
<Company>sample string 11</Company>
<CompanyID>2</CompanyID>
<CreateDate>2026-03-31T14:32:24.9717009+00:00</CreateDate>
<Department>sample string 21</Department>
<Email>sample string 6</Email>
<EmployeeID>sample string 22</EmployeeID>
<FilterSetIDs xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:int>1</d2p1:int>
<d2p1:int>2</d2p1:int>
</FilterSetIDs>
<FilterSets>
<FilterSetModel>
<CreateDate>2026-03-31T14:32:24.9717009+00:00</CreateDate>
<CreatedUser>sample string 7</CreatedUser>
<CreatedUserID>1</CreatedUserID>
<ID>1</ID>
<IsShared>true</IsShared>
<JSON>sample string 4</JSON>
<ModifiedDate>2026-03-31T14:32:24.9717009+00:00</ModifiedDate>
<ModifiedUser>sample string 8</ModifiedUser>
<Name>sample string 3</Name>
<TableID>2</TableID>
</FilterSetModel>
<FilterSetModel>
<CreateDate>2026-03-31T14:32:24.9717009+00:00</CreateDate>
<CreatedUser>sample string 7</CreatedUser>
<CreatedUserID>1</CreatedUserID>
<ID>1</ID>
<IsShared>true</IsShared>
<JSON>sample string 4</JSON>
<ModifiedDate>2026-03-31T14:32:24.9717009+00:00</ModifiedDate>
<ModifiedUser>sample string 8</ModifiedUser>
<Name>sample string 3</Name>
<TableID>2</TableID>
</FilterSetModel>
</FilterSets>
<FirstName>sample string 3</FirstName>
<ID>1</ID>
<IgnoreSidebarRecolor>true</IgnoreSidebarRecolor>
<IsActive>true</IsActive>
<IsDeleted>true</IsDeleted>
<IsSSOUser>true</IsSSOUser>
<LastName>sample string 4</LastName>
<LoggedInCompanyID>16</LoggedInCompanyID>
<Market>sample string 20</Market>
<ModifiedDate>2026-03-31T14:32:24.9717009+00:00</ModifiedDate>
<Offices>
<OfficeSmallModel>
<CompanyID>2</CompanyID>
<ID>1</ID>
<IsActive>true</IsActive>
<Latitude>5.1</Latitude>
<Longitude>6.1</Longitude>
<Name>sample string 3</Name>
<Region>sample string 4</Region>
</OfficeSmallModel>
<OfficeSmallModel>
<CompanyID>2</CompanyID>
<ID>1</ID>
<IsActive>true</IsActive>
<Latitude>5.1</Latitude>
<Longitude>6.1</Longitude>
<Name>sample string 3</Name>
<Region>sample string 4</Region>
</OfficeSmallModel>
</Offices>
<Options>sample string 7</Options>
<ProfilePicture>QEA=</ProfilePicture>
<Role>sample string 8</Role>
<RoleDisplay>sample string 9</RoleDisplay>
<RoleID>10</RoleID>
<Title>sample string 5</Title>
<UniqueID>sample string 17</UniqueID>
<UserRoleCompanies>
<UserRoleCompanyModel>
<AllowSuperAdmin>true</AllowSuperAdmin>
<CompID>4</CompID>
<CompanyName>sample string 7</CompanyName>
<ExpirationDate>2026-03-31T14:32:24.9717009+00:00</ExpirationDate>
<ID>1</ID>
<IsConfirmed>true</IsConfirmed>
<RoleDisplayName>sample string 6</RoleDisplayName>
<RoleID>3</RoleID>
<RoleName>sample string 5</RoleName>
<UserID>2</UserID>
</UserRoleCompanyModel>
<UserRoleCompanyModel>
<AllowSuperAdmin>true</AllowSuperAdmin>
<CompID>4</CompID>
<CompanyName>sample string 7</CompanyName>
<ExpirationDate>2026-03-31T14:32:24.9717009+00:00</ExpirationDate>
<ID>1</ID>
<IsConfirmed>true</IsConfirmed>
<RoleDisplayName>sample string 6</RoleDisplayName>
<RoleID>3</RoleID>
<RoleName>sample string 5</RoleName>
<UserID>2</UserID>
</UserRoleCompanyModel>
</UserRoleCompanies>
<WorkGroup>sample string 23</WorkGroup>
<isTempPass>true</isTempPass>
</UserModel>