edinn Platform: User Guide

This section handles the devices configuration.

GET /devices

This method returns the list of devices visibles for the user.

Request parameters:

• company [mandatory]: the company name or id.
• session [mandatory]: the Id of the active session.

Response:

• status: returns "0" on success, and an error code in any other case.
• data: returns the list of processes and its descriptions.
• message: "Success" or a descriptive information of the error in any other case.

Example:

POST /devices

This method creates a device. The user must have the administrator role.

Request parameters (for additional information please review the devices configuration):

• company [mandatory]: the company name or id.
• session [mandatory]: the Id of the active session.
• id [mandatory]: the id of the device.
• ki: indicates with 1 (deprecated) if the device works off-line or on-line (0, recommended).
• supervise: indicates if the device must be checked by the supervisor service.
• nokeyb: indicates with 1 if the device has a touch screen and therefore a soft keyboard will be shown.
• adminexits: indicates with 1 if only the administrators can exit the application.
• autologout: indicates after how many minutes will the terminal auto log-out when there is no activity by the user. Set 0 to ignore.
• defratio: indicates the default ratio to be shown on the main form of the terminal.
• hidehelp: indicates with 1 if the contextual help icon must be hidden in the terminal.
• fdow: indicates at what day the week starts.
• logdetail: (not in use).
• datatype: type of data seen at "Data" at the main window. Options: standard, particular. At the particular option, particularization sequence should be introduced in this field. To get to know the particularization options please consult the Particularization of data grid on the Advanced Guide of this manual.  
• datacust: contains the tags to select the data to be shown in the custom data panel.
• demo: (not in use).
• allowmin: indicates with 1 if the terminal can be minimized to the Windows bar.
• resize: indicates the size of the application on the Windows screen.
• login: indicates the type of login for the operation terminal. Put 0 for the user and password login form, and 1 for the easy login (select user and type your PIN).
• mac: indicate the MAC address of the device.
• url: a URL, following the URL syntax of the system, that can be launched by the user from the login window.
• vistype: indicates the default panel that will be shown in the main window.
• scrwait: indicates the time in seconds of inactivity of the user that the operation terminal should wait, in the login screen, to activate the edinn screen saver.
• scrpresent: indicates the time in seconds for the edinn screen saver to show the next process of the list of processes managed by that device.
• preselecteam: indicates if the team of the user should be preselected in the team drop down lists.
• theme: indicates the color theme.
• area: working areas to which the device (terminal) is associated. The terminal will only be able to see the areas indicated here.
• process: processes to which the device (terminal) is associated. The terminal will only be able to see the processes indicated here.
• period: indicates the period of time to show for the device.

Example:

DELETE/devices/{id}

This method deletes a device. The user must have the administrator role.

Request attribute:

• id: the Id of the device to delete.

Request parameters:

• company [mandatory]: the company name or id.
• session [mandatory]: the Id of the active session.

Response:

• status: returns "0" on success, and an error code in any other case.
• data: returns the list of processes and its descriptions.
• message: "Success" or a descriptive information of the error in any other case.