GET attendance/getPassByPerson?PageNumber={PageNumber}&PageSize={PageSize}&PersonId={PersonId}&TimeFrom={TimeFrom}&TimeTo={TimeTo}&Token={Token}

Retrieve all passage data of the specific person from all sensors in requested time range. Application privilege "View" for licensed agenda "Events" required. Data may also be restricted by record permission "Data monitoring" of agenda "Persons" and by HW Structure permission - privilege "Data monitoring

Request Information

Authorization

Authorization by token required

Availability

Method can be used

URI Parameters

Name	Description	Type	Additional information
PageNumber	Page number	integer	Matching regular expression pattern: ([0-9]+)
PageSize	Number of the records on the page	integer	Matching regular expression pattern: ([0-9]+)
PersonId	Unique identification of the person in the system	string	Required String length: inclusive between 0 and 100
TimeFrom	The begin of the time range in format "yyyy-mm-ddThh:mi:ss". The value is included	date	Required Data type: DateTime
TimeTo	The end of the time range in format "yyyy-mm-ddThh:mi:ss". The value is included	date	Required Data type: DateTime
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 Code	Error Number	Description
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 request	1121	Show passes for [{0}] privilege violated
404 required resource does not exist on the server	1100	Person not found
404 required resource does not exist on the server	1121	No passes for [{0}] 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

AttendanceGetPassByPersonResp

Name	Description	Type	Additional information
PersonId	Unique identification of the person in the system	string	None.
Passes		Collection of PersonPass	None.
Paging		PagingResp	None.

Response Formats

application/json

Sample:

{"PersonId":"100200300","Passes":[{"Date":"\/Date(1729228393606)\/","SensorName":"HwStructure - 0010BBEE01 S1","Direction":0,"EventCode":101,"IdentifierInternalNrLong":null},{"Date":"\/Date(1729231993606)\/","SensorName":"HwStructure - 0010BBEE02 S2","Direction":1,"EventCode":102,"IdentifierInternalNrLong":null},{"Date":"\/Date(1729235593606)\/","SensorName":"HwStructure - 0010BBEE03 S1","Direction":0,"EventCode":101,"IdentifierInternalNrLong":null}],"Paging":null}

application/xml

Sample:


<Response>
  <PersonId>100200300</PersonId>
  <Passes>
    <Pass>
      <Date>2024-10-18T05:13:13.6065282Z</Date>
      <SensorName>HwStructure - 0010BBEE01 S1</SensorName>
      <Direction>0</Direction>
      <EventCode>101</EventCode>
    </Pass>
    <Pass>
      <Date>2024-10-18T06:13:13.6065282Z</Date>
      <SensorName>HwStructure - 0010BBEE02 S2</SensorName>
      <Direction>1</Direction>
      <EventCode>102</EventCode>
    </Pass>
    <Pass>
      <Date>2024-10-18T07:13:13.6065282Z</Date>
      <SensorName>HwStructure - 0010BBEE03 S1</SensorName>
      <Direction>0</Direction>
      <EventCode>101</EventCode>
    </Pass>
  </Passes>
</Response>

text/json

Sample:

{
  "PersonId": "sample string 1",
  "Passes": [
    {
      "IdentifierInternalNrLong": "sample string 5"
    },
    {
      "IdentifierInternalNrLong": "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">
  <PersonId>sample string 1</PersonId>
  <Passes>
    <Pass>
      <IdentifierInternalNrLong>sample string 5</IdentifierInternalNrLong>
    </Pass>
    <Pass>
      <IdentifierInternalNrLong>sample string 5</IdentifierInternalNrLong>
    </Pass>
  </Passes>
  <Paging>
    <CurrentPage>1</CurrentPage>
    <PageSize>2</PageSize>
    <TotalCount>3</TotalCount>
    <TotalPages>4</TotalPages>
  </Paging>
</Response>