GET Users/List
Returns a secure list based on the logged in User permissions of Users that can be filtered using OData.
Request Information
URI Parameters
None.
Body Parameters
None.
Response Information
Resource Description
Collection of UserDTOName | Description | Type | Additional information |
---|---|---|---|
UserName |
Gets or sets the UserName of the User. |
string |
None. |
Title |
Gets or sets the Title of the User. |
string |
None. |
FirstName |
Gets or sets the First Name of the User. |
string |
None. |
LastName |
Gets or sets the Last Name of the User. |
string |
None. |
MiddleName |
Gets or sets the Middle Name of the User. |
string |
None. |
Phone |
Gets or sets the Phone Number of the User. |
string |
None. |
Fax |
Gets or sets the Fax Number of the User. |
string |
None. |
Gets or sets the Email of the User. |
string |
None. |
|
Active |
Gets or sets if the User is Active. |
boolean |
None. |
Deleted |
Gets or sets if the User is Deleted. |
boolean |
None. |
OrganizationID |
Gets or sets the Identifier of the Organization the User belongs to. |
globally unique identifier |
None. |
Organization |
Gets or sets the Name of the Organization the User belongs to. |
string |
None. |
OrganizationRequested |
Gets or sets the Organization the User requested during Registration. |
string |
None. |
RoleID |
Gets or sets the Identifier of the Role of the User. |
globally unique identifier |
None. |
RoleRequested |
Gets or sets the Role the User requested during Registration. |
string |
None. |
SignedUpOn |
Gets or sets the Date the user registered on. |
date |
None. |
ActivatedOn |
Gets or sets the date the user was Activated on. |
date |
None. |
DeactivatedOn |
Gets or sets the date the user was Deactivated on. |
date |
None. |
DeactivatedByID |
Gets or sets the Identifier of the User who deactivated this User. |
globally unique identifier |
None. |
DeactivatedBy |
Gets or sets the name of the user who deactivated this User. |
string |
None. |
DeactivationReason |
Gets or sets the reason why the User was deactivated. |
string |
None. |
RejectReason |
Gets or sets the reason given that this user was rejected during registration. |
string |
None. |
RejectedOn |
Gets or sets the date when this user was rejected. |
date |
None. |
RejectedByID |
Gets or sets the Identifier of the User who rejected this User. |
globally unique identifier |
None. |
RejectedBy |
Gets or sets the name of the user who rejected this User. |
string |
None. |
ID | globally unique identifier |
None. |
|
Timestamp | Collection of byte |
None. |
Response Formats
application/json, text/json
{ "results": [ { "UserName": "sample string 1", "Title": "sample string 2", "FirstName": "sample string 3", "LastName": "sample string 4", "MiddleName": "sample string 5", "Phone": "sample string 6", "Fax": "sample string 7", "Email": "sample string 8", "Active": true, "Deleted": true, "OrganizationID": "adcd5088-74e6-4d53-babe-80fc4ac91940", "Organization": "sample string 11", "OrganizationRequested": "sample string 12", "RoleID": "a2efc7b1-d934-4322-9bb7-63dca47bd11a", "RoleRequested": "sample string 13", "SignedUpOn": "2024-05-14T08:26:41Z", "ActivatedOn": "2024-05-14T08:26:41Z", "DeactivatedOn": "2024-05-14T08:26:41Z", "DeactivatedByID": "7d51febf-4e40-48d7-b3d8-00caa4c29d9e", "DeactivatedBy": "sample string 14", "DeactivationReason": "sample string 15", "RejectReason": "sample string 16", "RejectedOn": "2024-05-14T08:26:41Z", "RejectedByID": "2dd8a4f8-331e-45a5-b79e-2d0379a4125c", "RejectedBy": "sample string 17", "ID": "e6af632f-8de0-4fa4-afde-04b8f6bb518b", "Timestamp": "QEA=" }, { "UserName": "sample string 1", "Title": "sample string 2", "FirstName": "sample string 3", "LastName": "sample string 4", "MiddleName": "sample string 5", "Phone": "sample string 6", "Fax": "sample string 7", "Email": "sample string 8", "Active": true, "Deleted": true, "OrganizationID": "adcd5088-74e6-4d53-babe-80fc4ac91940", "Organization": "sample string 11", "OrganizationRequested": "sample string 12", "RoleID": "a2efc7b1-d934-4322-9bb7-63dca47bd11a", "RoleRequested": "sample string 13", "SignedUpOn": "2024-05-14T08:26:41Z", "ActivatedOn": "2024-05-14T08:26:41Z", "DeactivatedOn": "2024-05-14T08:26:41Z", "DeactivatedByID": "7d51febf-4e40-48d7-b3d8-00caa4c29d9e", "DeactivatedBy": "sample string 14", "DeactivationReason": "sample string 15", "RejectReason": "sample string 16", "RejectedOn": "2024-05-14T08:26:41Z", "RejectedByID": "2dd8a4f8-331e-45a5-b79e-2d0379a4125c", "RejectedBy": "sample string 17", "ID": "e6af632f-8de0-4fa4-afde-04b8f6bb518b", "Timestamp": "QEA=" } ] }
text/javascript
{"results":[{"UserName":"sample string 1","Title":"sample string 2","FirstName":"sample string 3","LastName":"sample string 4","MiddleName":"sample string 5","Phone":"sample string 6","Fax":"sample string 7","Email":"sample string 8","Active":true,"Deleted":true,"OrganizationID":"adcd5088-74e6-4d53-babe-80fc4ac91940","Organization":"sample string 11","OrganizationRequested":"sample string 12","RoleID":"a2efc7b1-d934-4322-9bb7-63dca47bd11a","RoleRequested":"sample string 13","SignedUpOn":"2024-05-14T08:26:41Z","ActivatedOn":"2024-05-14T08:26:41Z","DeactivatedOn":"2024-05-14T08:26:41Z","DeactivatedByID":"7d51febf-4e40-48d7-b3d8-00caa4c29d9e","DeactivatedBy":"sample string 14","DeactivationReason":"sample string 15","RejectReason":"sample string 16","RejectedOn":"2024-05-14T08:26:41Z","RejectedByID":"2dd8a4f8-331e-45a5-b79e-2d0379a4125c","RejectedBy":"sample string 17","ID":"e6af632f-8de0-4fa4-afde-04b8f6bb518b","Timestamp":"QEA="},{"UserName":"sample string 1","Title":"sample string 2","FirstName":"sample string 3","LastName":"sample string 4","MiddleName":"sample string 5","Phone":"sample string 6","Fax":"sample string 7","Email":"sample string 8","Active":true,"Deleted":true,"OrganizationID":"adcd5088-74e6-4d53-babe-80fc4ac91940","Organization":"sample string 11","OrganizationRequested":"sample string 12","RoleID":"a2efc7b1-d934-4322-9bb7-63dca47bd11a","RoleRequested":"sample string 13","SignedUpOn":"2024-05-14T08:26:41Z","ActivatedOn":"2024-05-14T08:26:41Z","DeactivatedOn":"2024-05-14T08:26:41Z","DeactivatedByID":"7d51febf-4e40-48d7-b3d8-00caa4c29d9e","DeactivatedBy":"sample string 14","DeactivationReason":"sample string 15","RejectReason":"sample string 16","RejectedOn":"2024-05-14T08:26:41Z","RejectedByID":"2dd8a4f8-331e-45a5-b79e-2d0379a4125c","RejectedBy":"sample string 17","ID":"e6af632f-8de0-4fa4-afde-04b8f6bb518b","Timestamp":"QEA="}]}
application/bson
Binary JSON content. See http://bsonspec.org for details.
application/xml, text/xml
<ArrayOfUserDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Lpp.Dns.DTO"> <UserDTO> <ID xmlns="http://schemas.datacontract.org/2004/07/Lpp.Objects">e6af632f-8de0-4fa4-afde-04b8f6bb518b</ID> <Timestamp xmlns="http://schemas.datacontract.org/2004/07/Lpp.Objects">QEA=</Timestamp> <ActivatedOn xmlns:d3p1="http://schemas.datacontract.org/2004/07/System"> <d3p1:DateTime>2024-05-14T12:26:41.8877657Z</d3p1:DateTime> <d3p1:OffsetMinutes>-240</d3p1:OffsetMinutes> </ActivatedOn> <Active>true</Active> <DeactivatedBy>sample string 14</DeactivatedBy> <DeactivatedByID>7d51febf-4e40-48d7-b3d8-00caa4c29d9e</DeactivatedByID> <DeactivatedOn xmlns:d3p1="http://schemas.datacontract.org/2004/07/System"> <d3p1:DateTime>2024-05-14T12:26:41.8877657Z</d3p1:DateTime> <d3p1:OffsetMinutes>-240</d3p1:OffsetMinutes> </DeactivatedOn> <DeactivationReason>sample string 15</DeactivationReason> <Deleted>true</Deleted> <Email>sample string 8</Email> <Fax>sample string 7</Fax> <FirstName>sample string 3</FirstName> <LastName>sample string 4</LastName> <MiddleName>sample string 5</MiddleName> <Organization>sample string 11</Organization> <OrganizationID>adcd5088-74e6-4d53-babe-80fc4ac91940</OrganizationID> <OrganizationRequested>sample string 12</OrganizationRequested> <Phone>sample string 6</Phone> <RejectReason>sample string 16</RejectReason> <RejectedBy>sample string 17</RejectedBy> <RejectedByID>2dd8a4f8-331e-45a5-b79e-2d0379a4125c</RejectedByID> <RejectedOn xmlns:d3p1="http://schemas.datacontract.org/2004/07/System"> <d3p1:DateTime>2024-05-14T12:26:41.8877657Z</d3p1:DateTime> <d3p1:OffsetMinutes>-240</d3p1:OffsetMinutes> </RejectedOn> <RoleID>a2efc7b1-d934-4322-9bb7-63dca47bd11a</RoleID> <RoleRequested>sample string 13</RoleRequested> <SignedUpOn xmlns:d3p1="http://schemas.datacontract.org/2004/07/System"> <d3p1:DateTime>2024-05-14T12:26:41.8877657Z</d3p1:DateTime> <d3p1:OffsetMinutes>-240</d3p1:OffsetMinutes> </SignedUpOn> <Title>sample string 2</Title> <UserName>sample string 1</UserName> </UserDTO> <UserDTO> <ID xmlns="http://schemas.datacontract.org/2004/07/Lpp.Objects">e6af632f-8de0-4fa4-afde-04b8f6bb518b</ID> <Timestamp xmlns="http://schemas.datacontract.org/2004/07/Lpp.Objects">QEA=</Timestamp> <ActivatedOn xmlns:d3p1="http://schemas.datacontract.org/2004/07/System"> <d3p1:DateTime>2024-05-14T12:26:41.8877657Z</d3p1:DateTime> <d3p1:OffsetMinutes>-240</d3p1:OffsetMinutes> </ActivatedOn> <Active>true</Active> <DeactivatedBy>sample string 14</DeactivatedBy> <DeactivatedByID>7d51febf-4e40-48d7-b3d8-00caa4c29d9e</DeactivatedByID> <DeactivatedOn xmlns:d3p1="http://schemas.datacontract.org/2004/07/System"> <d3p1:DateTime>2024-05-14T12:26:41.8877657Z</d3p1:DateTime> <d3p1:OffsetMinutes>-240</d3p1:OffsetMinutes> </DeactivatedOn> <DeactivationReason>sample string 15</DeactivationReason> <Deleted>true</Deleted> <Email>sample string 8</Email> <Fax>sample string 7</Fax> <FirstName>sample string 3</FirstName> <LastName>sample string 4</LastName> <MiddleName>sample string 5</MiddleName> <Organization>sample string 11</Organization> <OrganizationID>adcd5088-74e6-4d53-babe-80fc4ac91940</OrganizationID> <OrganizationRequested>sample string 12</OrganizationRequested> <Phone>sample string 6</Phone> <RejectReason>sample string 16</RejectReason> <RejectedBy>sample string 17</RejectedBy> <RejectedByID>2dd8a4f8-331e-45a5-b79e-2d0379a4125c</RejectedByID> <RejectedOn xmlns:d3p1="http://schemas.datacontract.org/2004/07/System"> <d3p1:DateTime>2024-05-14T12:26:41.8877657Z</d3p1:DateTime> <d3p1:OffsetMinutes>-240</d3p1:OffsetMinutes> </RejectedOn> <RoleID>a2efc7b1-d934-4322-9bb7-63dca47bd11a</RoleID> <RoleRequested>sample string 13</RoleRequested> <SignedUpOn xmlns:d3p1="http://schemas.datacontract.org/2004/07/System"> <d3p1:DateTime>2024-05-14T12:26:41.8877657Z</d3p1:DateTime> <d3p1:OffsetMinutes>-240</d3p1:OffsetMinutes> </SignedUpOn> <Title>sample string 2</Title> <UserName>sample string 1</UserName> </UserDTO> </ArrayOfUserDTO>