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

Retrieve scheduled shift of person, which are currently stored in the system. No priviliges required. Agenda "Scheduled shifts" has to be licensed. Data may also be restricted by record permission "Show attendance" of agenda "Persons".

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	None.
TimeTo	The end of the time range in format "yyyy-mm-ddThh:mi:ss". The value is included	date	None.
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
TimeLastChange	The last change time of the data record. Can be used to check manual modification of data record	date	Data type: DateTime

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	1100	PersonId [{0}] not found
404 required resource does not exist on the server	1132	No scheduled action for PersonId [{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

AttendanceGetScheduledShiftResp

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

Response Formats

application/json

Sample:

{"PersonId":"100200300","Shifts":[{"Name":"morning shift","Begin":"\/Date(1560578400000)\/","End":"\/Date(1560600000000)\/","Description":"","TimeLastChange":"\/Date(1732183509678)\/"},{"Name":"afternoon shift","Begin":"\/Date(1560600000000)\/","End":"\/Date(1560628800000)\/","Description":"","TimeLastChange":"\/Date(1732169349678)\/"},{"Name":"night shift","Begin":"\/Date(1560628800000)\/","End":"\/Date(1560657600000)\/","Description":"irregular","TimeLastChange":"\/Date(1732181349678)\/"}],"Paging":{"CurrentPage":1,"PageSize":25,"TotalCount":3,"TotalPages":1}}

application/xml

Sample:


<Response>
  <PersonId>100200300</PersonId>
  <Shifts>
    <Shift>
      <Name>morning shift</Name>
      <Begin>2019-06-15T08:00:00</Begin>
      <End>2019-06-15T14:00:00</End>
      <Description />
      <TimeLastChange>2024-11-21T10:05:09.678713Z</TimeLastChange>
    </Shift>
    <Shift>
      <Name>afternoon shift</Name>
      <Begin>2019-06-15T14:00:00</Begin>
      <End>2019-06-15T22:00:00</End>
      <Description />
      <TimeLastChange>2024-11-21T06:09:09.678713Z</TimeLastChange>
    </Shift>
    <Shift>
      <Name>night shift</Name>
      <Begin>2019-06-15T22:00:00</Begin>
      <End>2019-06-16T06:00:00</End>
      <Description>irregular</Description>
      <TimeLastChange>2024-11-21T09:29:09.678713Z</TimeLastChange>
    </Shift>
  </Shifts>
  <Paging>
    <CurrentPage>1</CurrentPage>
    <PageSize>25</PageSize>
    <TotalCount>3</TotalCount>
    <TotalPages>1</TotalPages>
  </Paging>
</Response>

text/json

Sample:

{
  "PersonId": "sample string 1",
  "Shifts": [
    {
      "Name": "sample string 1",
      "Begin": "2024-11-21T12:51:46.22378+01:00",
      "End": "2024-11-21T12:51:46.22378+01:00",
      "Description": "sample string 4",
      "TimeLastChange": "2024-11-21T12:51:46.22378+01:00"
    },
    {
      "Name": "sample string 1",
      "Begin": "2024-11-21T12:51:46.22378+01:00",
      "End": "2024-11-21T12:51:46.22378+01:00",
      "Description": "sample string 4",
      "TimeLastChange": "2024-11-21T12:51:46.22378+01:00"
    }
  ],
  "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>
  <Shifts>
    <Shift>
      <Name>sample string 1</Name>
      <Begin>2024-11-21T12:51:46.22378+01:00</Begin>
      <End>2024-11-21T12:51:46.22378+01:00</End>
      <Description>sample string 4</Description>
      <TimeLastChange>2024-11-21T12:51:46.22378+01:00</TimeLastChange>
    </Shift>
    <Shift>
      <Name>sample string 1</Name>
      <Begin>2024-11-21T12:51:46.22378+01:00</Begin>
      <End>2024-11-21T12:51:46.22378+01:00</End>
      <Description>sample string 4</Description>
      <TimeLastChange>2024-11-21T12:51:46.22378+01:00</TimeLastChange>
    </Shift>
  </Shifts>
  <Paging>
    <CurrentPage>1</CurrentPage>
    <PageSize>2</PageSize>
    <TotalCount>3</TotalCount>
    <TotalPages>4</TotalPages>
  </Paging>
</Response>