GET attendance/getPassBySensor?PageNumber={PageNumber}&PageSize={PageSize}&Sensor={Sensor}&TimeFrom={TimeFrom}&TimeTo={TimeTo}&Token={Token}

Retrieve all passage data of the specific sensor 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]+)
Sensor	The name of the hardware unit (sensor). In case of duplicity of hardware unit names can be used full path of hardware unit as unique identification of the unit node within hardware tree structure	string	Required String length: inclusive between 0 and 1000
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	1120	Sensor 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

Resource Description

AttendanceGetPassBySensorResp

Name	Description	Type	Additional information
Sensor	The name of hardware unit (sensor), As default value is used MAC address and standard postfix (Sensor = S)	string	None.
Passes		Collection of SensorPass	None.
Paging		PagingResp	None.

Response Formats

application/json

Sample:

{"Sensor":"HwStructure - AAEEBBEEDD S1","Passes":[{"Date":"\/Date(1732183509397)\/","PersonId":"100200300","Direction":0,"EventCode":101,"IdentifierInternalNrLong":null},{"Date":"\/Date(1732187109397)\/","PersonId":"100200300","Direction":1,"EventCode":102,"IdentifierInternalNrLong":null},{"Date":"\/Date(1732190709397)\/","PersonId":"100200300","Direction":0,"EventCode":101,"IdentifierInternalNrLong":null}],"Paging":{"CurrentPage":1,"PageSize":25,"TotalCount":3,"TotalPages":1}}

application/xml

Sample:


<Response>
  <Sensor>HwStructure - AAEEBBEEDD S1</Sensor>
  <Passes>
    <Pass>
      <Date>2024-11-21T10:05:09.3973446Z</Date>
      <PersonId>100200300</PersonId>
      <Direction>0</Direction>
      <EventCode>101</EventCode>
    </Pass>
    <Pass>
      <Date>2024-11-21T11:05:09.3973446Z</Date>
      <PersonId>100200300</PersonId>
      <Direction>1</Direction>
      <EventCode>102</EventCode>
    </Pass>
    <Pass>
      <Date>2024-11-21T12:05:09.3973446Z</Date>
      <PersonId>100200300</PersonId>
      <Direction>0</Direction>
      <EventCode>101</EventCode>
    </Pass>
  </Passes>
  <Paging>
    <CurrentPage>1</CurrentPage>
    <PageSize>25</PageSize>
    <TotalCount>3</TotalCount>
    <TotalPages>1</TotalPages>
  </Paging>
</Response>

text/json

Sample:

{
  "Sensor": "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">
  <Sensor>sample string 1</Sensor>
  <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>