GET attendance/getEventDescription?PageNumber={PageNumber}&PageSize={PageSize}&Sensor={Sensor}&Token={Token}

Retrieve all event description of the specific sensor. Application privilege "View" for licensed agenda "Global messages" required. No record permissions restriction implemented.

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)	string	Required
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}]
404 required resource does not exist on the server	1120	Sensor not found
404 required resource does not exist on the server	1123	No event description for sensor[{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

AttendanceGetEventDescriptionResp

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.
ChangedAt	The last change time of the announcement	date	None.
Events		Collection of EventDescription	None.
Paging		PagingResp	None.

Response Formats

application/json

Sample:

{"Sensor":"HwStructure - TSC/E S1","ChangedAt":null,"Events":[{"EventCode":49,"LocalizedAnnouncement":"Oběd, Obed, Lunch, Mittagessen, Ebéd"},{"EventCode":50,"LocalizedAnnouncement":"Služebně, Služobne, Official, Dienstlich, Szolgálati"},{"EventCode":51,"LocalizedAnnouncement":"Dovolená, Dovolenka, Vacation, Urlaub, Szabadság"}],"Paging":{"CurrentPage":1,"PageSize":25,"TotalCount":3,"TotalPages":1}}

application/xml

Sample:


<Response>
  <Sensor>HwStructure - TSC/E S1</Sensor>
  <ChangedAt d2p1:nil="true" xmlns:d2p1="http://www.w3.org/2001/XMLSchema-instance" />
  <Events>
    <Event>
      <EventCode>49</EventCode>
      <LocalizedAnnouncement>Oběd, Obed, Lunch, Mittagessen, Ebéd</LocalizedAnnouncement>
    </Event>
    <Event>
      <EventCode>50</EventCode>
      <LocalizedAnnouncement>Služebně, Služobne, Official, Dienstlich, Szolgálati</LocalizedAnnouncement>
    </Event>
    <Event>
      <EventCode>51</EventCode>
      <LocalizedAnnouncement>Dovolená, Dovolenka, Vacation, Urlaub, Szabadság</LocalizedAnnouncement>
    </Event>
  </Events>
  <Paging>
    <CurrentPage>1</CurrentPage>
    <PageSize>25</PageSize>
    <TotalCount>3</TotalCount>
    <TotalPages>1</TotalPages>
  </Paging>
</Response>

text/json

Sample:

{
  "Sensor": "sample string 1",
  "ChangedAt": "2024-11-21T13:10:59.8684307+01:00",
  "Events": [
    {
      "EventCode": 1,
      "LocalizedAnnouncement": "sample string 2"
    },
    {
      "EventCode": 1,
      "LocalizedAnnouncement": "sample string 2"
    }
  ],
  "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>
  <ChangedAt>2024-11-21T13:10:59.8684307+01:00</ChangedAt>
  <Events>
    <Event>
      <EventCode>1</EventCode>
      <LocalizedAnnouncement>sample string 2</LocalizedAnnouncement>
    </Event>
    <Event>
      <EventCode>1</EventCode>
      <LocalizedAnnouncement>sample string 2</LocalizedAnnouncement>
    </Event>
  </Events>
  <Paging>
    <CurrentPage>1</CurrentPage>
    <PageSize>2</PageSize>
    <TotalCount>3</TotalCount>
    <TotalPages>4</TotalPages>
  </Paging>
</Response>