GET api/Person

Returns the list of person's with filter applied. Returns including orgboard divisions.

Request Information

URI Parameters

Name	Description	Type	Additional information
id_id	Get by id	integer	None.
ids	Get by ids	Collection of integer	None.
outer_id		string	None.
search	search first_name, last_name, middle_name	string	None.
is_disabled	Checks archive people. If NULL returns all (including archive). e.g. /api/person?is_disabled (without any value)	boolean	None.
sort	Possible sorting - "id", "id_desc", "name". Default is "name".	string	None.
skip	Sets the SKIP number of records returned	integer	None.
take	Sets the TAKE number records returned	integer	None.

Body Parameters

None.

Response Information

Resource Description

Collection of ApiPerson

Name	Type	Additional information
id	integer	None.
first_name	string	None.
middle_name	string	None.
last_name	string	None.
email	string	None.
gender	integer	None.
last_activity	date	None.
last_login	date	None.
phone	string	None.
outer_id	string	None.
is_disabled	boolean	None.
pwd	string	None.
permission	ApiPersonPermission	None.
orgboardPositions	Object	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "id": 1,
    "first_name": "sample string 2",
    "middle_name": "sample string 3",
    "last_name": "sample string 4",
    "email": "sample string 5",
    "gender": 1,
    "last_activity": "2024-11-16T05:01:05.9632309+00:00",
    "last_login": "2024-11-16T05:01:05.9632309+00:00",
    "phone": "sample string 6",
    "outer_id": "sample string 7",
    "is_disabled": true,
    "pwd": "sample string 9",
    "permission": {
      "owner": true
    },
    "orgboardPositions": {}
  },
  {
    "id": 1,
    "first_name": "sample string 2",
    "middle_name": "sample string 3",
    "last_name": "sample string 4",
    "email": "sample string 5",
    "gender": 1,
    "last_activity": "2024-11-16T05:01:05.9632309+00:00",
    "last_login": "2024-11-16T05:01:05.9632309+00:00",
    "phone": "sample string 6",
    "outer_id": "sample string 7",
    "is_disabled": true,
    "pwd": "sample string 9",
    "permission": {
      "owner": true
    },
    "orgboardPositions": {}
  }
]

application/xml, text/xml

Sample:

<ArrayOfApiPerson xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <ApiPerson>
    <id>1</id>
    <first_name>sample string 2</first_name>
    <middle_name>sample string 3</middle_name>
    <last_name>sample string 4</last_name>
    <email>sample string 5</email>
    <gender>1</gender>
    <last_activity>2024-11-16T05:01:05.9632309+00:00</last_activity>
    <last_login>2024-11-16T05:01:05.9632309+00:00</last_login>
    <phone>sample string 6</phone>
    <outer_id>sample string 7</outer_id>
    <is_disabled>true</is_disabled>
    <pwd>sample string 9</pwd>
    <permission>
      <owner>true</owner>
    </permission>
    <orgboardPositions />
  </ApiPerson>
  <ApiPerson>
    <id>1</id>
    <first_name>sample string 2</first_name>
    <middle_name>sample string 3</middle_name>
    <last_name>sample string 4</last_name>
    <email>sample string 5</email>
    <gender>1</gender>
    <last_activity>2024-11-16T05:01:05.9632309+00:00</last_activity>
    <last_login>2024-11-16T05:01:05.9632309+00:00</last_login>
    <phone>sample string 6</phone>
    <outer_id>sample string 7</outer_id>
    <is_disabled>true</is_disabled>
    <pwd>sample string 9</pwd>
    <permission>
      <owner>true</owner>
    </permission>
    <orgboardPositions />
  </ApiPerson>
</ArrayOfApiPerson>