Dandelion - API Documentation - Logs Module

Module Name: logs

Index

read

Endpoint: /api/logs/read

Method: GET

Parameters: [offset], [limit]

Parameter Type Default Required
logid int   false
offset int 0 false
limit int UD false

Description: Returns limit number of logs newest first. offset is used for pagination. If logid is sent, then only the log with that id is returned. No metadata is returned for a request using logid.

Example Return Data (array of logs):

{
	"data": {
		"logs": [{
			"id": "1",
			"date_created": "2015-02-12",
			"time_created": "12:24:53",
			"title": "Log title",
			"body": "Log content, contains HTML",
			"user_id": "1",
			"category": "Logs",
			"is_edited": "0",
			"fullname": "Admin",
			"can_edit": true
		}],
		"metadata": {
			"limit": "25",
			"logSize": "1000",
			"offset": "0",
			"resultCount": "25"
		}
	}
}

Returned Values:

Per Log

  • id (int) - ID number of log
  • date_created (string) - Date log was created formatted in Y-m-d
  • time_created (string) - Time log was created formated in H:i:s
  • title (string) - Title of log
  • body (string) - Body of log
  • user_id (int) - ID of user who created the log
  • category (string) - String representation of the log’s category
  • is_edited (bool) - Has the log been edited, 0 or 1
  • fullname (string) - Name of user who created log
  • can_edit (bool) - Does the user have permission to edit the log (for visual clues only, actual permissions are enforced server-side)

Metadata (not returned if logid is used)

  • limit (int) - User defined number of logs to return
  • logSize(int) - Number of total logs
  • offset (int) - Database ID offset used to get results
  • resultCount (int) - Number of logs returned

Permissions Needed:

  • Read log

⇑ Top

create

Endpoint: /api/logs/create

Method: POST

Parameters: title, body, cat

Parameter Type Default Required
title string   true
body string   true
cat string   true

Description: Create a new log with title and content body. cat should be a string of the category separated by colons for each level. E.g. “Logs:Networking”

Example Return Data:

{
	"data": "Message indicating success of failure"
}

Returned Values:

  • data (string) - Message that can be displayed to a user indicating either success or report an error if failed.

Permissions Needed:

  • Create log

⇑ Top

edit

Endpoint: /api/logs/edit

Method: POST

Parameters: logid, title, body, cat

Parameter Type Default Required
logid int   true
title string   true
body string   true
cat string   true

Description: Edit log with logid using title and content body. cat should be a string of the category separated by colons for each level. E.g. “Logs:Networking”

Example Return Data:

{
	"data": "Message indicating success of failure"
}

Returned Values:

  • data (string) - Message that can be displayed to a user indicating either success or report an error if failed.

Permissions Needed:

  • Edit log

⇑ Top

Endpoint: /api/logs/search

Method: GET

Parameters: query, [offset], [limit]

Parameter Type Default Required
query string   true
offset int 0 false
limit int UD false

Description: Returns limit number of logs matching query. offset is used for pagination. If you want to get all the logs that match the query, pass a rather large number as the limit.

Example Return Data (array of logs):

{
	"data": {
		"logs": [{
			"id": "1",
			"date_created": "2015-02-12",
			"time_created": "12:24:53",
			"title": "Log title",
			"body": "Log content, contains HTML",
			"user_id": "1",
			"category": "Logs",
			"is_edited": "0",
			"fullname": "Admin",
			"can_edit": true
		}],
		"metadata": {
			"limit": "25",
			"logSize": "1000",
			"offset": "0",
			"resultCount": "25"
		},
		"queryData": {}
	}
}

Returned Values:

Per Log

  • id (int) - ID number of log
  • date_created (string) - Date log was created formatted in Y-m-d
  • time_created (string) - Time log was created formated in H:i:s
  • title (string) - Title of log
  • body (string) - Body of log
  • user_id (int) - ID of user who created the log
  • category (string) - String representation of the log’s category
  • is_edited (bool) - Has the log been edited, 0 or 1
  • fullname (string) - Name of user who created log
  • can_edit (bool) - Does the user have permission to edit the log (for visual clues only, actual permissions are enforced server-side)

Metadata

  • limit (int) - User defined number of logs to return
  • logSize(int) - Number of total logs
  • offset (int) - Database ID offset used to get results
  • resultCount (int) - Number of logs returned

Query Data

A parsed representation of the query.

Permissions Needed:

  • Read log

Additional Information:

For the syntax of a search query, see the search documentation.

⇑ Top

⇐ API Documentation