GET person/getAll?PageNumber={PageNumber}&PageSize={PageSize}&Token={Token}

Retrieve personal data for each person in the system. Application privilege "View" for licensed agenda "Persons" required. Data may also be restricted by record permission "View" of agenda "Persons".

Request Information

Authorization

  • Authorization by token required

Availability

  • Method can be used

URI Parameters

NameDescriptionTypeAdditional information
PageNumber

Optional parameter may be omitted. All records are displayed when is omitted otherwise specific page is displayed

integer

Matching regular expression pattern: ([0-9]+)

PageSize

Optional parameter may be omitted. Define number of records in the page.

integer

Matching regular expression pattern: ([0-9]+)

Token

The action is authorized by this token. Token should generated by calling action "POST login". Expiration time of each token is 20 seconds

globally unique identifier

Required

Body Parameters

None.

Response Information

Response Codes

Http CodeError NumberDescription
200 request succesfully done 0 Successfully done
400 bad request 1002 Entry parameter missing or parameter bindigs failed
401 unauthorized 1000 Token {0} not found
401 unauthorized 1001 Token {0} already expired
401 unauthorized 1006 Ip filter violated for ip client address [{0}]
401 unauthorized 1007 Ip filter [{0}] parsing failed
401 unauthorized 1008 Request rate policy violated for [{0}]
403 server refuses fo fulfill the rquest 1101 Application privilege View for licensed agenda Persons violated for person [all]
404 required resource does not exist on the server 1100 PersonId [{0}] not found
415 unsupported Media Type The request entity has a media type which the server or resource does not support. Only application/json and application/xml are supported
500 internal error Server exception description

Resource Description

PersonGetAllResp
NameDescriptionTypeAdditional information
Persons

Collection of Person

None.

Paging

PagingResp

None.

Response Formats

application/json

Sample:
{"Persons":[{"PersonId":"100200300","Name":"John","Surname":"Doo","OrganizationStructure":"Structure - Company - Office 1","Desc":null,"TimeLastChange":"\/Date(1733645350838)\/","Presence":1,"Lock":0,"Email":"","LoginName":"","EmployeePosition":"","DegreeInFrontName":null,"DegreeAfterName":null,"Sex":0,"UdsCollection":null},{"PersonId":"100200301","Name":"James","Surname":"Smith","OrganizationStructure":"Structure - Company - Office 1","Desc":null,"TimeLastChange":"\/Date(1733645350838)\/","Presence":0,"Lock":1,"Email":"james@outlook.com","LoginName":"xsmith","EmployeePosition":"","DegreeInFrontName":null,"DegreeAfterName":null,"Sex":0,"UdsCollection":null},{"PersonId":"100200302","Name":"Ian","Surname":"Parish","OrganizationStructure":"Structure - Company - Office 2","Desc":null,"TimeLastChange":"\/Date(1733645350838)\/","Presence":1,"Lock":0,"Email":"parish@outlook.com","LoginName":"parish","EmployeePosition":"thp","DegreeInFrontName":null,"DegreeAfterName":null,"Sex":0,"UdsCollection":null}],"Paging":{"CurrentPage":5,"PageSize":25,"TotalCount":128,"TotalPages":5}}

application/xml

Sample:

<Response>
  <Persons>
    <Person>
      <PersonId>100200300</PersonId>
      <Name>John</Name>
      <Surname>Doo</Surname>
      <OrganizationStructure>Structure - Company - Office 1</OrganizationStructure>
      <TimeLastChange>2024-12-08T08:09:10.8384812Z</TimeLastChange>
      <Presence>1</Presence>
      <Lock>0</Lock>
      <Email />
      <LoginName />
      <EmployeePosition />
      <Sex>0</Sex>
    </Person>
    <Person>
      <PersonId>100200301</PersonId>
      <Name>James</Name>
      <Surname>Smith</Surname>
      <OrganizationStructure>Structure - Company - Office 1</OrganizationStructure>
      <TimeLastChange>2024-12-08T08:09:10.8384812Z</TimeLastChange>
      <Presence>0</Presence>
      <Lock>1</Lock>
      <Email>james@outlook.com</Email>
      <LoginName>xsmith</LoginName>
      <EmployeePosition />
      <Sex>0</Sex>
    </Person>
    <Person>
      <PersonId>100200302</PersonId>
      <Name>Ian</Name>
      <Surname>Parish</Surname>
      <OrganizationStructure>Structure - Company - Office 2</OrganizationStructure>
      <TimeLastChange>2024-12-08T08:09:10.8384812Z</TimeLastChange>
      <Presence>1</Presence>
      <Lock>0</Lock>
      <Email>parish@outlook.com</Email>
      <LoginName>parish</LoginName>
      <EmployeePosition>thp</EmployeePosition>
      <Sex>0</Sex>
    </Person>
  </Persons>
  <Paging>
    <CurrentPage>5</CurrentPage>
    <PageSize>25</PageSize>
    <TotalCount>128</TotalCount>
    <TotalPages>5</TotalPages>
  </Paging>
</Response>

text/json

Sample:
{
  "Persons": [
    {
      "PersonId": "sample string 1",
      "Desc": "sample string 5",
      "Lock": 8,
      "Email": "sample string 9",
      "LoginName": "sample string 10",
      "EmployeePosition": "sample string 11",
      "DegreeInFrontName": "sample string 12",
      "DegreeAfterName": "sample string 13",
      "Sex": 14,
      "UdsCollection": [
        {
          "SystemName": "sample string 1",
          "Name": "sample string 2",
          "Value": "sample string 3",
          "IsExtern": 4,
          "DataType": "sample string 5"
        },
        {
          "SystemName": "sample string 1",
          "Name": "sample string 2",
          "Value": "sample string 3",
          "IsExtern": 4,
          "DataType": "sample string 5"
        }
      ]
    },
    {
      "PersonId": "sample string 1",
      "Desc": "sample string 5",
      "Lock": 8,
      "Email": "sample string 9",
      "LoginName": "sample string 10",
      "EmployeePosition": "sample string 11",
      "DegreeInFrontName": "sample string 12",
      "DegreeAfterName": "sample string 13",
      "Sex": 14,
      "UdsCollection": [
        {
          "SystemName": "sample string 1",
          "Name": "sample string 2",
          "Value": "sample string 3",
          "IsExtern": 4,
          "DataType": "sample string 5"
        },
        {
          "SystemName": "sample string 1",
          "Name": "sample string 2",
          "Value": "sample string 3",
          "IsExtern": 4,
          "DataType": "sample string 5"
        }
      ]
    }
  ],
  "Paging": {
    "CurrentPage": 1,
    "PageSize": 2,
    "TotalCount": 3,
    "TotalPages": 4
  }
}

text/xml

Sample:
<Response xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Persons>
    <Person>
      <PersonId>sample string 1</PersonId>
      <Desc>sample string 5</Desc>
      <Lock>8</Lock>
      <Email>sample string 9</Email>
      <LoginName>sample string 10</LoginName>
      <EmployeePosition>sample string 11</EmployeePosition>
      <DegreeInFrontName>sample string 12</DegreeInFrontName>
      <DegreeAfterName>sample string 13</DegreeAfterName>
      <Sex>14</Sex>
      <UdsCollection>
        <UdsOut>
          <SystemName>sample string 1</SystemName>
          <Name>sample string 2</Name>
          <Value>sample string 3</Value>
          <IsExtern>4</IsExtern>
          <DataType>sample string 5</DataType>
        </UdsOut>
        <UdsOut>
          <SystemName>sample string 1</SystemName>
          <Name>sample string 2</Name>
          <Value>sample string 3</Value>
          <IsExtern>4</IsExtern>
          <DataType>sample string 5</DataType>
        </UdsOut>
      </UdsCollection>
    </Person>
    <Person>
      <PersonId>sample string 1</PersonId>
      <Desc>sample string 5</Desc>
      <Lock>8</Lock>
      <Email>sample string 9</Email>
      <LoginName>sample string 10</LoginName>
      <EmployeePosition>sample string 11</EmployeePosition>
      <DegreeInFrontName>sample string 12</DegreeInFrontName>
      <DegreeAfterName>sample string 13</DegreeAfterName>
      <Sex>14</Sex>
      <UdsCollection>
        <UdsOut>
          <SystemName>sample string 1</SystemName>
          <Name>sample string 2</Name>
          <Value>sample string 3</Value>
          <IsExtern>4</IsExtern>
          <DataType>sample string 5</DataType>
        </UdsOut>
        <UdsOut>
          <SystemName>sample string 1</SystemName>
          <Name>sample string 2</Name>
          <Value>sample string 3</Value>
          <IsExtern>4</IsExtern>
          <DataType>sample string 5</DataType>
        </UdsOut>
      </UdsCollection>
    </Person>
  </Persons>
  <Paging>
    <CurrentPage>1</CurrentPage>
    <PageSize>2</PageSize>
    <TotalCount>3</TotalCount>
    <TotalPages>4</TotalPages>
  </Paging>
</Response>