api/admin/v1/users/organizationUnit/{organizationUnitId}

GET api/admin/v1/users/organizationUnit/{organizationUnitId}?page={page}&pageSize={pageSize}

Get all users of an organizational unit

Request Information

URI Parameters

Name	Description	Type	Additional information
organizationUnitId	ID of the organizational unit	integer	Required
page	Current page	integer	Default value is 1
pageSize	Page size	integer	Default value is 50

Body Parameters

None

Response Information

Resource Description

List of users

Collection of UserDto

Name	Description	Type	Additional information
OrganizationalUnit	User organizational unit	OrganizationalUnitMinDto	None
Role	User role	RoleMinDto	None
Supervisor	Supervisor of the user	UserMinDto	None
Code	Code for internal use, usefully for a synchronization with an external environment	string	None
Login	Login of the user, must be unique	string	None
Email	Email of the user	string	None
FirstName	Firstname	string	None
LastName	LastName	string	None
FiscalCode	FiscalCode	string	None
Vat	Vat	string	None
Culture	Culture (EN-en, IT-It)	string	None
FinalStatementEntryType	D = daily, P = period	string	None
HomePage	Home page	string	None
IsActive	True if the user is active, false otherwise	boolean	None
ReceiveEmailNotification	True if the user want receive the emails	boolean	None
ReceiveWebNotification	True if the user want receive the web alerts	boolean	None
Avatar	Avatar Path	string	None
CreationDate	Creation	date	None
CreatedBy	The user who has made the insert	UserMinDto	None
LastUpdateDate	Date of the last update	date	None
LastUpdatedBy	The user who has made the last update	UserMinDto	None
Id	Unique ID	integer	None

Response Formats

application/json, text/json

Sample:

[
  {
    "OrganizationalUnit": {
      "Code": "sample string 1",
      "Description": "sample string 2",
      "Id": 3
    },
    "Role": {
      "Code": "sample string 1",
      "Description": "sample string 2",
      "Id": 3
    },
    "Supervisor": {
      "Login": "sample string 1",
      "FullName": "sample string 2",
      "Avatar": "sample string 3",
      "Id": 4
    },
    "Code": "sample string 1",
    "Login": "sample string 2",
    "Email": "sample string 3",
    "FirstName": "sample string 4",
    "LastName": "sample string 5",
    "FiscalCode": "sample string 6",
    "Vat": "sample string 7",
    "Culture": "sample string 8",
    "FinalStatementEntryType": "sample string 9",
    "HomePage": "sample string 10",
    "IsActive": true,
    "ReceiveEmailNotification": true,
    "ReceiveWebNotification": true,
    "Avatar": "sample string 14",
    "CreationDate": "2024-11-01T19:31:07.1762361+01:00",
    "CreatedBy": {
      "Login": "sample string 1",
      "FullName": "sample string 2",
      "Avatar": "sample string 3",
      "Id": 4
    },
    "LastUpdateDate": "2024-11-01T19:31:07.1762361+01:00",
    "LastUpdatedBy": {
      "Login": "sample string 1",
      "FullName": "sample string 2",
      "Avatar": "sample string 3",
      "Id": 4
    },
    "Id": 15
  },
  {
    "OrganizationalUnit": {
      "Code": "sample string 1",
      "Description": "sample string 2",
      "Id": 3
    },
    "Role": {
      "Code": "sample string 1",
      "Description": "sample string 2",
      "Id": 3
    },
    "Supervisor": {
      "Login": "sample string 1",
      "FullName": "sample string 2",
      "Avatar": "sample string 3",
      "Id": 4
    },
    "Code": "sample string 1",
    "Login": "sample string 2",
    "Email": "sample string 3",
    "FirstName": "sample string 4",
    "LastName": "sample string 5",
    "FiscalCode": "sample string 6",
    "Vat": "sample string 7",
    "Culture": "sample string 8",
    "FinalStatementEntryType": "sample string 9",
    "HomePage": "sample string 10",
    "IsActive": true,
    "ReceiveEmailNotification": true,
    "ReceiveWebNotification": true,
    "Avatar": "sample string 14",
    "CreationDate": "2024-11-01T19:31:07.1762361+01:00",
    "CreatedBy": {
      "Login": "sample string 1",
      "FullName": "sample string 2",
      "Avatar": "sample string 3",
      "Id": 4
    },
    "LastUpdateDate": "2024-11-01T19:31:07.1762361+01:00",
    "LastUpdatedBy": {
      "Login": "sample string 1",
      "FullName": "sample string 2",
      "Avatar": "sample string 3",
      "Id": 4
    },
    "Id": 15
  }
]

application/xml, text/xml

Sample:

<ArrayOfUserDto xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Oryx.Web.Api.Models">
  <UserDto>
    <Id>15</Id>
    <CreatedBy>
      <Id>4</Id>
      <Avatar>sample string 3</Avatar>
      <FullName>sample string 2</FullName>
      <Login>sample string 1</Login>
    </CreatedBy>
    <CreationDate>2024-11-01T19:31:07.1762361+01:00</CreationDate>
    <LastUpdateDate>2024-11-01T19:31:07.1762361+01:00</LastUpdateDate>
    <LastUpdatedBy>
      <Id>4</Id>
      <Avatar>sample string 3</Avatar>
      <FullName>sample string 2</FullName>
      <Login>sample string 1</Login>
    </LastUpdatedBy>
    <Avatar>sample string 14</Avatar>
    <Code>sample string 1</Code>
    <Culture>sample string 8</Culture>
    <Email>sample string 3</Email>
    <FinalStatementEntryType>sample string 9</FinalStatementEntryType>
    <FirstName>sample string 4</FirstName>
    <FiscalCode>sample string 6</FiscalCode>
    <HomePage>sample string 10</HomePage>
    <IsActive>true</IsActive>
    <LastName>sample string 5</LastName>
    <Login>sample string 2</Login>
    <OrganizationalUnit>
      <Id>3</Id>
      <Code>sample string 1</Code>
      <Description>sample string 2</Description>
    </OrganizationalUnit>
    <ReceiveEmailNotification>true</ReceiveEmailNotification>
    <ReceiveWebNotification>true</ReceiveWebNotification>
    <Role>
      <Id>3</Id>
      <Code>sample string 1</Code>
      <Description>sample string 2</Description>
    </Role>
    <Supervisor>
      <Id>4</Id>
      <Avatar>sample string 3</Avatar>
      <FullName>sample string 2</FullName>
      <Login>sample string 1</Login>
    </Supervisor>
    <Vat>sample string 7</Vat>
  </UserDto>
  <UserDto>
    <Id>15</Id>
    <CreatedBy>
      <Id>4</Id>
      <Avatar>sample string 3</Avatar>
      <FullName>sample string 2</FullName>
      <Login>sample string 1</Login>
    </CreatedBy>
    <CreationDate>2024-11-01T19:31:07.1762361+01:00</CreationDate>
    <LastUpdateDate>2024-11-01T19:31:07.1762361+01:00</LastUpdateDate>
    <LastUpdatedBy>
      <Id>4</Id>
      <Avatar>sample string 3</Avatar>
      <FullName>sample string 2</FullName>
      <Login>sample string 1</Login>
    </LastUpdatedBy>
    <Avatar>sample string 14</Avatar>
    <Code>sample string 1</Code>
    <Culture>sample string 8</Culture>
    <Email>sample string 3</Email>
    <FinalStatementEntryType>sample string 9</FinalStatementEntryType>
    <FirstName>sample string 4</FirstName>
    <FiscalCode>sample string 6</FiscalCode>
    <HomePage>sample string 10</HomePage>
    <IsActive>true</IsActive>
    <LastName>sample string 5</LastName>
    <Login>sample string 2</Login>
    <OrganizationalUnit>
      <Id>3</Id>
      <Code>sample string 1</Code>
      <Description>sample string 2</Description>
    </OrganizationalUnit>
    <ReceiveEmailNotification>true</ReceiveEmailNotification>
    <ReceiveWebNotification>true</ReceiveWebNotification>
    <Role>
      <Id>3</Id>
      <Code>sample string 1</Code>
      <Description>sample string 2</Description>
    </Role>
    <Supervisor>
      <Id>4</Id>
      <Avatar>sample string 3</Avatar>
      <FullName>sample string 2</FullName>
      <Login>sample string 1</Login>
    </Supervisor>
    <Vat>sample string 7</Vat>
  </UserDto>
</ArrayOfUserDto>

api/admin/v1/users/organizationUnit/{organizationUnitId}

GET api/admin/v1/users/organizationUnit/{organizationUnitId}?page={page}&pageSize={pageSize}

Request Information

URI Parameters

Body Parameters

Response Information

Resource Description

Response Formats

application/json, text/json

application/xml, text/xml

URI parameters

Headers | Add header

Body

Status

Headers

Body