With this resource, administrators can retrieve any employee's intervals over a given tsrange.

There are no syntactical limitations on the tsrange, but if too many records would be fetched, the return status will be 'DISPATCH_TOO_MANY_INTERVALS'. EOH }, 'interval/help' => { target => { GET => '_get_default', POST => '_post_default', PUT => '_put_default', DELETE => '_delete_default', }, target_module => 'App::Dochazka::REST::Dispatch::Interval', acl_profile => 'passerby', cli => 'interval help', description => 'Display available interval resources for given HTTP method', documentation => <<'EOH', =pod

Displays information on all interval resources available to the logged-in employee, according to her privlevel. EOH }, 'interval/iid' => { target => { POST => '_iid', }, target_module => 'App::Dochazka::REST::Dispatch::Interval', acl_profile => 'active', cli => 'interval iid $JSON', description => 'Update an existing interval object via POST request (iid must be included in request body)', documentation => <<'EOH', =pod

Enables existing interval objects to be updated by sending a POST request to the REST server. Along with the properties to be modified, the request body must include an 'iid' property, the value of which specifies the iid to be updated. EOH }, 'interval/iid/:iid' => { target => { GET => '_iid', PUT => '_iid', DELETE => '_iid', }, target_module => 'App::Dochazka::REST::Dispatch::Interval', acl_profile => { GET => 'active', PUT => 'active', DELETE => 'active', }, cli => 'interval iid $iid [$JSON]', description => 'GET, PUT, or DELETE an interval object by its iid', documentation => <<'EOH', =over

• GET

  Retrieves an interval object by its iid.

• PUT

  Updates the interval object whose iid is specified by the ':iid' URI parameter. The fields to be updated and their new values should be sent in the request body, e.g., like this:

  { "eid" : 34, "aid" : 1, "intvl" : '[ 2014-11-18 08:00, 2014-11-18 12:00 )' }

• DELETE

  Deletes the interval object whose iid is specified by the ':iid' URI parameter. As long as the interval does not overlap with a lock interval, the delete operation will probably work as expected.

ACL note: 'active' employees can update/delete only their own unlocked intervals. EOH }, 'interval/new' => { target => { POST => '_new', }, target_module => 'App::Dochazka::REST::Dispatch::Interval', acl_profile => 'active', cli => 'interval new $JSON', description => 'Add a new attendance data interval', documentation => <<'EOH', =pod

This is the resource by which employees add new attendance data to the database. It takes a request body containing, at the very least, aid and intvl properties. Additionally, it can contain long_desc, while administrators can also specify eid and remark. EOH }, 'interval/nick/:nick/:tsrange' => { target => { # GET => '_fetch_by_nick', GET => 'not_implemented', }, target_module => 'App::Dochazka::REST::Dispatch::Interval', acl_profile => 'admin', cli => 'interval nick $NICK $TSRANGE', description => 'Retrieve an arbitrary employee\'s intervals over the given tsrange', documentation => <<'EOH', =pod

With this resource, administrators can retrieve any employee's intervals over a given tsrange.

There are no syntactical limitations on the tsrange, but if too many records would be fetched, the return status will be 'DISPATCH_TOO_MANY_INTERVALS'. EOH }, 'interval/self/:tsrange' => { target => { # GET => '_fetch_own', GET => 'not_implemented', }, target_module => 'App::Dochazka::REST::Dispatch::Interval', acl_profile => 'inactive', cli => 'interval self $TSRANGE', description => 'Retrieve one\'s own intervals over the given tsrange', documentation => <<'EOH', =pod

With this resource, employees can retrieve their own attendance intervals over a given tsrange.

There are no syntactical limitations on the tsrange, but if too many records would be fetched, the return status will be 'DISPATCH_TOO_MANY_INTERVALS'. EOH },

});