NAME
App::Dochazka::REST::Docs::Resources - Documentation of REST resources
DESCRIPTION
This is a POD-only module containing documentation on all the REST resources defined in ResourceDefs.pm. This module is auto-generated.
RESOURCES
/
Allowed methods: CONNECT, DELETE, GET, OPTIONS, POST, PUT, TRACE
This resource is the parent of all resources that do not specify a parent in their resource definition.
activity
Allowed methods: CONNECT, DELETE, GET, OPTIONS, POST, PUT, TRACE
Parent for activity resources
activity/aid
Allowed methods: POST
Enables existing activity 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 'aid' property, the value of which specifies the AID to be updated.
activity/aid/:aid
GET
Retrieves an activity object by its AID.
PUT
Updates the activity object whose AID is specified by the ':aid' URI parameter. The fields to be updated and their new values should be sent in the request body, e.g., like this:
{ "long_desc" : "new description", "disabled" : "f" }DELETE
Deletes the activity object whose AID is specified by the ':aid' URI parameter. This will work only if nothing in the database refers to this activity.
Allowed methods: DELETE, GET, PUT
This resource allows the user to GET, PUT, or DELETE an activity object by its AID.
activity/all
Allowed methods: GET
Retrieves all activity objects in the database (excluding disabled activities).
activity/all/disabled
Allowed methods: GET
Retrieves all activity objects in the database (including disabled activities).
activity/code
Allowed methods: POST
This resource enables existing activity objects to be updated, and new activity objects to be inserted, by sending a POST request to the REST server. Along with the properties to be modified/inserted, the request body must include an 'code' property, the value of which specifies the activity to be updated.
activity/code/:code
GET
Retrieves an activity object by its code.
PUT
Inserts new or updates existing activity object whose code is specified by the ':code' URI parameter. The fields to be updated and their new values should be sent in the request body, e.g., like this:
{ "long_desc" : "new description", "disabled" : "f" }DELETE
Deletes an activity object by its code whose code is specified by the ':code' URI parameter. This will work only if nothing in the database refers to this activity.
Allowed methods: DELETE, GET, PUT
With this resource, a user can GET, PUT, or DELETE an activity object by its code.
bugreport
Allowed methods: GET
Returns a JSON structure containing instructions for reporting bugs.
component
Allowed methods: CONNECT, DELETE, GET, OPTIONS, POST, PUT, TRACE
Parent for component resources
component/all
Allowed methods: GET
Retrieves all component objects in the database.
component/cid
Allowed methods: POST
Enables existing component 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 'cid' property, the value of which specifies the cid to be updated.
component/cid/:cid
GET
Retrieves an component object by its cid.
PUT
Updates the component object whose cid is specified by the ':cid' URI parameter. The fields to be updated and their new values should be sent in the request body, e.g., like this:
{ "path" : "new/path", "source" : "new source", "acl" : "inactive" }DELETE
Deletes the component object whose cid is specified by the ':cid' URI parameter. This will work only if nothing in the database refers to this component.
Allowed methods: DELETE, GET, PUT
This resource allows the user to GET, PUT, or DELETE an component object by its cid.
component/path
Allowed methods: POST
This resource enables existing component objects to be updated, and new component objects to be inserted, by sending a POST request to the REST server. Along with the properties to be modified/inserted, the request body must include an 'path' property, the value of which specifies the component to be updated.
configinfo
Allowed methods: GET
Returns a list of directories that were scanned for configuration files.
dbstatus
Allowed methods: GET
This resource checks the employee's database connection and reports on its status. The result - either "UP" or "DOWN" - will be encapsulated in a payload like this:
{ "dbstatus" : "UP" }Each employee gets her own database connection when she logs in to Dochazka. Calling this resource causes the server to execute a 'ping' on the connection. If the ping test fails, the server will attempt to open a new connection. Only if this, too, fails will "DOWN" be returned.
docu
Allowed methods: CONNECT, DELETE, GET, OPTIONS, POST, PUT, TRACE
This resource provides access to on-line documentation through its subresources: 'docu/pod', 'docu/html', and 'docu/text'.
To get documentation on a resource, send a POST reqeuest for one of these subresources, including the resource name in the request entity as a bare JSON string (i.e. in double quotes).
docu/html
Allowed methods: POST
This resource provides access to on-line help documentation. It expects to find a resource name (e.g. "employee/eid/:eid" including the double-quotes, and without leading or trailing slash) in the request body. It generates HTML from the resource documentation's POD source code.
docu/pod
Allowed methods: POST
This resource provides access to on-line help documentation in POD format. It expects to find a resource name (e.g. "employee/eid/:eid" including the double-quotes, and without leading or trailing slash) in the request body. It returns a string containing the POD source code of the resource documentation.
docu/text
Allowed methods: POST
This resource provides access to on-line help documentation. It expects to find a resource name (e.g. "employee/eid/:eid" including the double-quotes, and without leading or trailing slash) in the request body. It returns a plain text rendering of the POD source of the resource documentation.
echo
Allowed methods: POST
This resource simply takes whatever content body was sent and echoes it back in the response body.
employee
Allowed methods: CONNECT, DELETE, GET, OPTIONS, POST, PUT, TRACE
Parent for employee resources
employee/count/?:priv
passerby
inactive
active
admin
Allowed methods: GET
If ':priv' is not specified, gets the total number of employees in the database. This includes employees of all privilege levels, including not only administrators and active employees, but inactives and passerbies as well.
If ':priv' is specified, gets the total number of employees with the given privlevel. Valid privlevels are:
employee/current
GET
Displays the profile of the currently logged-in employee. The information is limited to just the employee object itself.
POST
Provides a way for an employee to update certain fields of her own employee profile. Exactly which fields can be updated may differ from site to site (see the DOCHAZKA_PROFILE_EDITABLE_FIELDS site parameter).
Allowed methods: GET, POST
With this resource, we can retrieve (GET) and edit (POST) our own employee profile.
employee/current/priv
Allowed methods: GET
Displays the "full profile" of the currently logged-in employee. The information includes the full employee object (taken from the 'current_emp' property) as well as the employee's current privlevel and schedule, which are looked up from the database.
employee/eid
Allowed methods: POST
This resource provides a way to update employee objects using the POST method, provided the employee's EID is provided in the content body. The properties to be modified should also be included, e.g.:
{ "eid" : 43, "fullname" : "Foo Bariful" }This would change the 'fullname' property of the employee with EID 43 to "Foo Bariful" (provided such an employee exists).
ACL note: 'inactive' and 'active' employees can use this resource to modify their own employee profile. Exactly which fields can be updated may differ from site to site (see the DOCHAZKA_PROFILE_EDITABLE_FIELDS site parameter).
employee/eid/:eid
GET
Retrieves an employee object by its EID.
PUT
Updates the "employee profile" (employee object) of the employee with the given EID. For example, if the request body was:
{ "fullname" : "Foo Bariful" }the request would change the 'fullname' property of the employee with EID 43 (provided such an employee exists) to "Foo Bariful". Any 'eid' property provided in the content body will be ignored.
ACL note: 'inactive' and 'active' employees can use this resource to modify their own employee profile. Exactly which fields can be updated may differ from site to site (see the DOCHAZKA_PROFILE_EDITABLE_FIELDS site parameter).
DELETE
Deletes the employee with the given EID (will only work if the EID exists and nothing in the database refers to it).
Allowed methods: DELETE, GET, PUT
With this resource, we can look up an employee by exact match (GET), update an existing employee (PUT), or delete an employee (DELETE).
employee/eid/:eid/minimal
Allowed methods: GET
This resource enables any employee to get minimal information on any other employee. Useful for EID to nick conversion or to look up another employee's email address or name.
employee/eid/:eid/team
Allowed methods: GET
This resource enables administrators to list the nicks of team members of an arbitrary employee - i.e. that employee\'s direct reports.
employee/list/?:priv
Allowed methods: GET
This resource enables the administrator to easily list the nicks of employees. If priv is not given, all employees are listed.
employee/nick
Allowed methods: POST
This resource provides a way to insert/update employee objects using the POST method, provided the employee's nick is provided in the content body.
Consider, for example, the following request body:
{ "nick" : "foobar", "fullname" : "Foo Bariful" }If an employee "foobar" exists, such a request would change the 'fullname' property of that employee to "Foo Bariful". On the other hand, if the employee doesn't exist this HTTP request would cause a new employee 'foobar' to be created.
ACL note: 'inactive' and 'active' employees can use this resource to modify their own employee profile. Exactly which fields can be updated may differ from site to site (see the DOCHAZKA_PROFILE_EDITABLE_FIELDS site parameter).
employee/nick/:nick
GET
Retrieves employee object(s) by exact match. For example:
GET employee/nick/foobarwould look for an employee whose nick is 'foobar'.
PUT
Inserts a new employee or updates an existing one (exact match only). If a 'nick' property is provided in the content body and its value is different from the nick provided in the URI, the employee's nick will be changed to the value provided in the content body.
ACL note: 'inactive' and 'active' employees can use this resource to modify their own employee profile. Exactly which fields can be updated may differ from site to site (see the DOCHAZKA_PROFILE_EDITABLE_FIELDS site parameter).
DELETE
Deletes an employee (exact match only). This will work only if the exact nick exists and nothing else in the database refers to the employee in question.
Allowed methods: DELETE, GET, PUT
Retrieves (GET), updates/inserts (PUT), and/or deletes (DELETE) the employee specified by the ':nick' parameter.
employee/nick/:nick/ldap
Allowed methods: GET, PUT
This resource enables any employee to perform an LDAP lookup on any other employee.
employee/nick/:nick/minimal
Allowed methods: GET
This resource enables any employee to get minimal information on any other employee. Useful for nick to EID conversion or to look up another employee's email address or name.
employee/nick/:nick/team
Allowed methods: GET
This resource enables administrators to list the nicks of team members of an arbitrary employee - i.e. that employee\'s direct reports.
employee/search
Allowed methods: CONNECT, DELETE, GET, OPTIONS, POST, PUT, TRACE
See child resources.
employee/search/nick/:key
Allowed methods: GET
Look up employee profiles using a search key, which can optionally contain a wildcard ('%'). For example:
GET employee/search/nick/foo%would return a list of employees whose nick starts with 'foo'.
Note that if the user provides no wildcard characters in the key, they will implicitly be added. Example: a search for 'foo' would be converted to '%foo%'. For a literal nick lookup, use the 'employee/nick/:nick' resource.
employee/sec_id/:sec_id
Allowed methods: GET
Retrieves an employee object by the secondary ID (must be an exact match)
employee/sec_id/:sec_id/minimal
Allowed methods: GET
This resource enables any employee to get minimal information on any other employee. Useful for sec_id to EID conversion or to look up another employee's email address or name.
employee/self
GET
Displays the profile of the currently logged-in employee. The information is limited to just the employee object itself.
POST
Provides a way for an employee to update certain fields of her own employee profile. Exactly which fields can be updated may differ from site to site (see the DOCHAZKA_PROFILE_EDITABLE_FIELDS site parameter).
Allowed methods: GET, POST
With this resource, we can retrieve (GET) and/or edit (POST) our own employee profile.
employee/self/priv
Allowed methods: GET
Displays the "full profile" of the currently logged-in employee. The information includes the full employee object (taken from the 'current_emp' property) as well as the employee's current privlevel and schedule, which are looked up from the database.
employee/team
Allowed methods: GET
This resource enables supervisors to easily list the nicks of employees in their team - i.e. their direct reports.
forbidden
Allowed methods: CONNECT, DELETE, GET, OPTIONS, POST, PUT, TRACE
This resource returns 403 Forbidden for all allowed methods, regardless of user.
Implementation note: this can be accomplished for any resource by including an 'acl_profile' property with the value 'undef' or any unrecognized privilege level string (like "foobar").
genreport
Allowed methods: GET, POST
The "POST genreport" resource generates reports from Mason templates. The resource takes a request body with one mandatory property, "path" (corresponding to the path of a Mason component relative to the component root), and one optional property, "parameters", which should be a hash of parameter names and values.
The resource handler checks (1) if the component exists in the database, (2) whether current employee has sufficient permissions to generate the report (by comparing the employee's privlevel with the ACL profile of the component), and (3) validates the parameters, if any, by applying the validation rules specified in the component object. Iff all of these conditions are met, the component is called with the provided parameters.
holiday/:tsrange
Allowed methods: GET
This resource takes a tsrange and returns a list of holidays (dates) that fall within that tsrange.
interval
Allowed methods: CONNECT, DELETE, GET, OPTIONS, POST, PUT, TRACE
Parent for interval resources
interval/:self/:ts/:psqlint
Allowed methods: DELETE, GET
This is just like 'interval/self/:tsrange' except that the time range is specified by giving a timestamp and a PostgreSQL time interval, e.g "1 week 3 days".
interval/eid/:eid/:ts/:psqlint
Allowed methods: DELETE, GET
This is just like 'interval/eid/:eid/:tsrange' except that the time range is specified by giving a timestamp and a PostgreSQL time interval, e.g "1 week 3 days".
interval/eid/:eid/:tsrange
Allowed methods: DELETE, GET
With this resource, administrators can retrieve any employee's intervals over a given tsrange, and active employees can do the same with their own intervals.
Before any records are returned, the tsrange is checked to see if it overlaps with any privlevel or schedule changes - in which case an error is returned. This is so interval report-generators do not have to handle changes in employee status.
By default, the number of intervals returned is limited to 500. This number can be changed via the DOCHAZKA_INTERVAL_SELECT_LIMIT site configuration parameter (set to 'undef' for no limit).
interval/iid
Allowed methods: POST
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.
interval/iid/:iid
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.
Allowed methods: DELETE, GET, PUT
This resource makes it possible to GET, PUT, or DELETE an interval object by its IID.
ACL note: 'active' employees can update/delete only their own unlocked intervals.
interval/new
Allowed methods: POST
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.
interval/nick/:nick/:ts/:psqlint
Allowed methods: DELETE, GET
This is just like 'interval/nick/:nick/:tsrange' except that the time range is specified by giving a timestamp and a PostgreSQL time interval, e.g "1 week 3 days".
interval/nick/:nick/:tsrange
Allowed methods: DELETE, GET
With this resource, administrators can retrieve any employee's intervals over a given tsrange, and active employees can do the same with their own intervals.
Before any records are returned, the tsrange is checked to see if it overlaps with any privlevel or schedule changes - in which case an error is returned. This is so interval report-generators do not have to handle changes in employee status.
By default, the number of intervals returned is limited to 500. This number can be changed via the DOCHAZKA_INTERVAL_SELECT_LIMIT site configuration parameter (set to 'undef' for no limit).
interval/self/:tsrange
Allowed methods: DELETE, GET
With this resource, employees can retrieve their own attendance intervals over a given tsrange.
Before any records are returned, the tsrange is checked to see if it overlaps with any privlevel or schedule changes - in which case an error is returned. This is so interval report-generators do not have to handle changes in employee status.
By default, the number of intervals returned is limited to 500. This number can be changed via the DOCHAZKA_INTERVAL_SELECT_LIMIT site configuration parameter (set to 'undef' for no limit).
interval/summary/eid/:eid/:tsrange
Allowed methods: GET
With this resource, employees can generate summaries of their attendance intervals over a given period.
interval/fillup
Allowed methods: GET, POST
Parent for interval fillup resources
lock
Allowed methods: CONNECT, DELETE, GET, OPTIONS, POST, PUT, TRACE
Parent for lock resources
lock/eid/:eid/:tsrange
Allowed methods: GET
With this resource, administrators can retrieve any employee's locks 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_RECORDS_FOUND.
lock/lid
Allowed methods: POST
Enables existing lock 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 'lid' property, the value of which specifies the lid to be updated.
lock/lid/:lid
GET
Retrieves an lock object by its lid.
PUT
Updates the lock object whose lid is specified by the ':lid' URI parameter. The fields to be updated and their new values should be sent in the request body, e.g., like this:
{ "eid" : 34, "intvl" : '[ 2014-11-18 00:00, 2014-11-18 24:00 )' }DELETE
Deletes the lock object whose lid is specified by the ':lid' URI parameter.
Allowed methods: DELETE, GET, PUT
This resource makes it possible to GET, PUT, or DELETE an lock object by its LID.
ACL note: 'active' employees can view only their own locks, and of course admin privilege is required to modify or remove a lock.
lock/new
Allowed methods: POST
This is the resource by which the attendance data entered by an employee for a given time period can be "locked" to prevent any subsequent modifications. It takes a request body containing, at the very least, an intvl property specifying the tsrange to lock. Additionally, administrators can specify remark and eid properties.
lock/nick/:nick/:tsrange
Allowed methods: GET
With this resource, administrators can retrieve any employee's locks 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_RECORDS_FOUND.
lock/self/:tsrange
Allowed methods: GET
With this resource, employees can retrieve their own attendance locks 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_RECORDS_FOUND.
noop
Allowed methods: CONNECT, DELETE, GET, OPTIONS, POST, PUT, TRACE
Regardless of anything, this resource does nothing at all.
param/:type/:param
Allowed methods: DELETE, GET, PUT
This resource can be used to look up (GET) meta, core, and site parameters, as well as to set (PUT) and delete (DELETE) meta parameters.
priv
Allowed methods: CONNECT, DELETE, GET, OPTIONS, POST, PUT, TRACE
This resource presents a list of subresources, all related to employee privileges.
priv/eid/:eid/?:ts
Allowed methods: GET
This resource retrieves the privlevel of an arbitrary employee specified by EID.
If no timestamp is given, the present privlevel is retrieved. If a timestamp is present, the privlevel as of that timestamp is retrieved.
priv/history
Allowed methods: CONNECT, DELETE, GET, OPTIONS, POST, PUT, TRACE
This resource presents a list of subresources, all related to privilege histories.
priv/history/eid/:eid
GET
Retrieves the "privhistory", or history of changes in privilege level, of the employee with the given EID.
POST
Adds a record to the privhistory of the given employee. The content body should contain two properties: "effective" (a timestamp) and "priv" (one of "passerby", "inactive", "active", or "admin").
It is assumed that schedule histories will be built up record-by-record; insertion of multiple history records in a single request is not supported.
Allowed methods: GET, POST
Retrieves entire history of privilege level changes for employee with the given EID (GET); or, with an appropriate content body, adds (POST) a record to employee\'s privhistory.
Update note: histories can be updated by adding new records and deleting old ones. Existing history records cannot be changed. Adds/deletes should be performed with due care - especially with regard to existing employee attendance data (if any).
priv/history/eid/:eid/:tsrange
Allowed methods: GET
Retrieves a slice (given by the tsrange argument) of the employee's "privhistory" (history of changes in privilege level).
priv/history/nick/:nick
GET
Retrieves the "privhistory", or history of changes in privilege level, of the employee with the given nick.
POST
Adds a record to the privhistory of the given employee. The content body should contain two properties: "effective" (a timestamp) and "priv" (one of "passerby", "inactive", "active", or "admin").
It is assumed that schedule histories will be built up record-by-record; insertion of multiple history records in a single request is not supported.
Allowed methods: GET, POST
Retrieves entire history of privilege level changes for employee with the given nick (GET); or, with an appropriate content body, adds (PUT) a record to employee\'s privhistory.
Update note: histories can be updated by adding new records and deleting old ones. Existing history records cannot be changed. Adds/deletes should be performed with due care - especially with regard to existing employee attendance data (if any).
priv/history/nick/:nick/:tsrange
Allowed methods: GET
Retrieves a slice (given by the tsrange argument) of the employee's "privhistory" (history of changes in privilege level).
priv/history/phid/:phid
GET
Retrieves a privhistory record by its PHID.
POST
Updates a privilege history record by its PHID. The 'phid' and 'eid' properties cannot be changed in this way.
DELETE
Deletes a privhistory record by its PHID.
Allowed methods: DELETE, GET, POST
Retrieves (GET), updates (POST), or deletes (DELETE) a single privilege history record by its PHID.
(N.B.: history records can be added using POST requests on "priv/history/eid/:eid" or "priv/history/nick/:nick")
priv/history/self/?:tsrange
Allowed methods: GET
This resource retrieves the "privhistory", or history of changes in privilege level, of the present employee. Optionally, the listing can be limited to a specific tsrange such as
"[2014-01-01, 2014-12-31)"priv/nick/:nick/?:ts
Allowed methods: GET
This resource retrieves the privlevel of an arbitrary employee specified by nick.
If no timestamp is given, the present privlevel is retrieved. If a timestamp is present, the privlevel as of that timestamp is retrieved.
priv/self/?:ts
Allowed methods: GET
This resource retrieves the privlevel of the caller (currently logged-in employee).
If no timestamp is given, the present privlevel is retrieved. If a timestamp is present, the privlevel as of that timestamp is retrieved.
schedule
Allowed methods: CONNECT, DELETE, GET, OPTIONS, POST, PUT, TRACE
This resource presents a list of "child" resources (subresources), all of which are related to schedules.
schedule/all
Allowed methods: GET
This resource returns a list (array) of all schedules for which the 'disabled' field has either not been set or has been set to 'false'.
schedule/all/disabled
Allowed methods: GET
This resource returns a list (array) of all schedules, regardless of the contents of the 'disabled' field.
schedule/eid/:eid/?:ts
Allowed methods: GET
This resource retrieves the schedule of an arbitrary employee specified by EID.
If no timestamp is given, the current schedule is retrieved. If a timestamp is present, the schedule as of that timestamp is retrieved.
schedule/history
Allowed methods: CONNECT, DELETE, GET, OPTIONS, POST, PUT, TRACE
This resource presents a list of subresources, all related to schedule histories.
schedule/history/eid/:eid
GET
Retrieves the full history of schedule changes of the employee with the given EID. For partial history, see 'schedule/history/eid/:eid/:tsrange'.
POST
Adds a record to the schedule history of the given employee. The content body should contain two properties: "effective" (a timestamp) and "sid" (the ID of the schedule).
It is assumed that schedule histories will be built up record-by-record; insertion of multiple history records in a single request is not supported.
Allowed methods: GET, POST
Retrieves entire history of schedule changes for employee with the given EID (GET); or, with an appropriate content body, adds (POST) a record to employee\'s schedule history.
Update note: histories can be updated by adding new records and deleting old ones. Existing history records cannot be changed. Adds/deletes should be performed with due care - especially with regard to existing employee attendance data (if any).
schedule/history/eid/:eid/:tsrange
Allowed methods: GET
Retrieves a slice (given by the tsrange argument) of the employee's "schedule history" (history of changes in schedule).
schedule/history/nick/:nick
GET
Retrieves the full history of schedule changes of the employee with the given nick. For partial histories, see 'schedule/history/nick/:nick/:tsrange'.
POST
Adds a record to the schedule history of the given employee. The content body should contain two properties: "effective" (a timestamp) and "sid" (the ID of the schedule).
It is assumed that schedule histories will be built up record-by-record; insertion of multiple history records in a single request is not supported.
Allowed methods: GET, POST
Retrieves entire history of schedule changes for employee with the given nick (GET); or, with an appropriate content body, adds (PUT) a record to employee\'s schedule history.
Update note: histories can be updated by adding new records and deleting old ones. Existing history records cannot be changed. Adds/deletes should be performed with due care - especially with regard to existing employee attendance data (if any).
schedule/history/nick/:nick/:tsrange
Allowed methods: GET
Retrieves a slice (given by the tsrange argument) of the employee's "schedule history" (history of changes in schedule).
schedule/history/self/?:tsrange
Allowed methods: GET
This resource retrieves the "schedule history", or history of changes in schedule, of the present employee. Optionally, the listing can be limited to a specific tsrange such as
"[2014-01-01, 2014-12-31)"schedule/history/shid/:shid
GET
Retrieves a schedule history record by its SHID.
POST
Updates a schedule history record by its SHID. The 'shid' and 'eid' properties cannot be changed in this way.
DELETE
Deletes a schedule history record by its SHID.
Allowed methods: DELETE, GET, POST
Retrieves (GET), updates (POST), or deletes (DELETE) a single schedule history record by its SHID.
(N.B.: history records can be added using POST requests on "schedule/history/eid/:eid" or "schedule/history/nick/:nick")
schedule/new
Allowed methods: POST
Given a set of intervals, all of which must fall within a single contiguous 168-hour (7-day) period, this resource performs all actions necessary to either create a new schedule from those intervals or verify that an equivalent schedule already exists.
Sample JSON:
{ "schedule" : [
"[2014-09-22 08:00, 2014-09-22 12:00)",
"[2014-09-22 12:30, 2014-09-22 16:30)",
"[2014-09-23 08:00, 2014-09-23 12:00)",
"[2014-09-23 12:30, 2014-09-23 16:30)",
"[2014-09-24 08:00, 2014-09-24 12:00)",
"[2014-09-24 12:30, 2014-09-24 16:30)",
"[2014-09-25 08:00, 2014-09-25 12:00)",
"[2014-09-25 12:30, 2014-09-25 16:30)"
] }(Optionally, an scode can be assigned by including an "scode" property.)
Read on for details:
First, a set of scratch intervals is created in the 'schedintvls' table. If this succeeds, an INSERT operation is used to create a new record in the 'schedule' table. This operation has two possible successful outcomes depending on whether such a schedule already existed in the database, or not. The status codes for these outcomes are DISPATCH_SCHEDULE_OK and DISPATCH_SCHEDULE_INSERT_OK, respectively.
In both cases, the underlying scratch intervals are deleted automatically. (All operations on the 'schedintlvs' table are supposed to be hidden from Dochazka clients.)
Note that many sets of intervals can map to a single schedule (the conversion process is only interested in the day of the week), so this resource may return DISPATCH_SCHEDULE_OK more often than you think.
Whether or not the exact schedule existed already, if the underlying database operation is successful the payload will contain three properties: 'sid' (the SID assigned to the schedule containing the intervals), 'intervals' (the intervals themselves), and 'schedule' (the intervals as they appear after being converted into the format suitable for insertion into the 'schedule' table).
N.B. At present there is no way to just check for the existence of a schedule corresponding to a given set of intervals.
schedule/nick/:nick/?:ts
Allowed methods: GET
This resource retrieves the schedule of an arbitrary employee specified by nick.
If no timestamp is given, the current schedule is retrieved. If a timestamp is present, the schedule as of that timestamp is retrieved.
schedule/scode/:scode
GET
An integer scode must be given as an URI parameter. If a schedule with this scode is found, it is returned in the payload.
PUT
This resource/method provides a way to set (modify) the 'scode', 'remark' and/or 'disabled' fields of a schedule record. Simply provide the property (or properties) and the new value(s) in the request body, e.g.:
{ "scode" : "WIGWAM" }or
{ "remark" : "foobar", "disabled" : "t" }Properties other than these three cannot be modified using this resource.
DELETE
The scode must be given as an URI parameter. If found, the schedule with that scode will be deleted in an atomic operation. If the operation is sucessful the return status will be "OK".
Allowed methods: DELETE, GET, PUT
This resource makes it possible to GET, PUT, or DELETE a schedule by its scode.
schedule/self/?:ts
Allowed methods: GET
This resource retrieves the schedule of the caller (currently logged-in employee).
If no timestamp is given, the current schedule is retrieved. If a timestamp is present, the schedule as of that timestamp is retrieved.
schedule/sid/:sid
GET
An integer SID must be given as an URI parameter. If a schedule with this SID is found, it is returned in the payload.
PUT
This resource/method provides a way to set (modify) the 'scode', 'remark' and/or 'disabled' fields of a schedule record. Simply provide the property (or properties) and the new value(s) in the request body, e.g.:
{ "scode" : "WIGWAM" }or
{ "remark" : "foobar", "disabled" : "t" }Properties other than these three cannot be modified using this resource.
DELETE
An integer SID must be given as an URI parameter. If found, the schedule with that SID will be deleted in an atomic operation. If the operation is sucessful the return status will be "OK".
Allowed methods: DELETE, GET, PUT
This resource makes it possible to GET, PUT, or DELETE a schedule by its SID.
session
Allowed methods: GET
Dumps the current session data (server-side).
version
Allowed methods: GET
Shows the software version running on the present instance. The version displayed is taken from the $VERSION package variable of the package specified in the MREST_APPLICATION_MODULE site parameter.
whoami
Allowed methods: GET
Displays the profile of the currently logged-in employee (same as "employee/current")
AUTHOR
Nathan Cutler ncutler@suse.cz