Archive:JSON-RPC API/v4 - Revision history

Karellen at 23:33, 27 August 2020

2020-08-27T23:33:50Z

← Older revision		Revision as of 23:33, 27 August 2020
Line 1:		Line 1:
	~~{{mininav\|[[Development]]\|[[JSON-RPC API]]}}~~

	Version 4 is a stable version of XBMC's JSON-RPC API and is published with the release of Eden. It is a complete re-write and re-structuring of version 2 and therefore isn't backwards compatible to it. The main reason for this was the need to make this version fully compatible with all the functionality, features and requirements of the [http://jsonrpc.org/spec.html JSON-RPC 2.0 specification]. This was a main concern during early development to make it easier for third party developers and applications to interact with XBMC's JSON-RPC API by using existing JSON-RPC libraries.		Version 4 is a stable version of XBMC's JSON-RPC API and is published with the release of Eden. It is a complete re-write and re-structuring of version 2 and therefore isn't backwards compatible to it. The main reason for this was the need to make this version fully compatible with all the functionality, features and requirements of the [http://jsonrpc.org/spec.html JSON-RPC 2.0 specification]. This was a main concern during early development to make it easier for third party developers and applications to interact with XBMC's JSON-RPC API by using existing JSON-RPC libraries.

Karellen: Karellen moved page JSON-RPC API/v4 to Archive:JSON-RPC API/v4 without leaving a redirect: Outdated

2020-08-27T23:33:11Z

Karellen moved page JSON-RPC API/v4 to Archive:JSON-RPC API/v4 without leaving a redirect: Outdated

← Older revision	Revision as of 23:33, 27 August 2020
(No difference)

Karellen at 23:18, 27 August 2020

2020-08-27T23:18:06Z

← Older revision		Revision as of 23:18, 27 August 2020
Line 1:		Line 1:
	{{mininav\|[[Development]]\|[[JSON-RPC API]]}}		{{mininav\|[[Development]]\|[[JSON-RPC API]]}}

	Version 4 is a stable version of XBMC's JSON-RPC API and is published with the release of Eden. It is a complete re-write and re-structuring of ~~[[JSON-RPC API/v2\|~~version 2]] and therefore isn't backwards compatible to it. The main reason for this was the need to make this version fully compatible with all the functionality, features and requirements of the [http://jsonrpc.org/spec.html JSON-RPC 2.0 specification]. This was a main concern during early development to make it easier for third party developers and applications to interact with XBMC's JSON-RPC API by using existing JSON-RPC libraries.		Version 4 is a stable version of XBMC's JSON-RPC API and is published with the release of Eden. It is a complete re-write and re-structuring of version 2 and therefore isn't backwards compatible to it. The main reason for this was the need to make this version fully compatible with all the functionality, features and requirements of the [http://jsonrpc.org/spec.html JSON-RPC 2.0 specification]. This was a main concern during early development to make it easier for third party developers and applications to interact with XBMC's JSON-RPC API by using existing JSON-RPC libraries.

	An rough and incomplete list of changes compared to version 2 can be found [[Archive:Eden_API_changes\|here]]. A more complete and detailed list can be found in the [http://forum.kodi.tv/showthread.php?t=98551 forum].		An rough and incomplete list of changes compared to version 2 can be found [[Archive:Eden_API_changes\|here]]. A more complete and detailed list can be found in the [http://forum.kodi.tv/showthread.php?t=98551 forum].
Line 27:		Line 27:

	== Documentation (JSON Schema) ==		== Documentation (JSON Schema) ==
	Starting with JSON-RPC API version 3 a new way of API documentation has been introduced. All methods and data types are described using [http://tools.ietf.org/html/draft-zyp-json-schema-03 JSON Schema]. This provides third party developers with an always complete and up-to-date documentation by calling ~~[[#~~JSONRPC.Introspect~~\|JSONRPC.Introspect]]~~ even during periods of heavy development. Furthermore the same method and data type specification that can be used by third party developers as a documentation is used by XBMC to check and verify method parameters and their values on every JSON-RPC request and allows to provide detailed error messages in case of a bad or missing parameter.		Starting with JSON-RPC API version 3 a new way of API documentation has been introduced. All methods and data types are described using [http://tools.ietf.org/html/draft-zyp-json-schema-03 JSON Schema]. This provides third party developers with an always complete and up-to-date documentation by calling JSONRPC.Introspect even during periods of heavy development. Furthermore the same method and data type specification that can be used by third party developers as a documentation is used by XBMC to check and verify method parameters and their values on every JSON-RPC request and allows to provide detailed error messages in case of a bad or missing parameter.

	=== Supported features of JSON Schema ===		=== Supported features of JSON Schema ===
Line 6,393:		Line 6,393:
	}</syntaxhighlight>}}		}</syntaxhighlight>}}

	~~== See also ==~~
	* [[JSON-RPC API]]
	* [[JSON-RPC API/v2\|JSON-RPC API v2 (Dharma)]]
	* [[JSON-RPC API/v6\|JSON-RPC API v6 (Frodo)]]

	== External links ==		== External links ==
Line 6,402:		Line 6,398:
	* [http://tools.ietf.org/html/draft-zyp-json-schema-03 A JSON Media Type for Describing the Structure and Meaning of JSON Documents (Draft 03)]		* [http://tools.ietf.org/html/draft-zyp-json-schema-03 A JSON Media Type for Describing the Structure and Meaning of JSON Documents (Draft 03)]

	[[Category:~~Development~~]]		[[Category:JSON-RPC]]

Karellen at 06:30, 18 June 2020

2020-06-18T06:30:29Z

← Older revision		Revision as of 06:30, 18 June 2020
Line 3:		Line 3:
	Version 4 is a stable version of XBMC's JSON-RPC API and is published with the release of Eden. It is a complete re-write and re-structuring of [[JSON-RPC API/v2\|version 2]] and therefore isn't backwards compatible to it. The main reason for this was the need to make this version fully compatible with all the functionality, features and requirements of the [http://jsonrpc.org/spec.html JSON-RPC 2.0 specification]. This was a main concern during early development to make it easier for third party developers and applications to interact with XBMC's JSON-RPC API by using existing JSON-RPC libraries.		Version 4 is a stable version of XBMC's JSON-RPC API and is published with the release of Eden. It is a complete re-write and re-structuring of [[JSON-RPC API/v2\|version 2]] and therefore isn't backwards compatible to it. The main reason for this was the need to make this version fully compatible with all the functionality, features and requirements of the [http://jsonrpc.org/spec.html JSON-RPC 2.0 specification]. This was a main concern during early development to make it easier for third party developers and applications to interact with XBMC's JSON-RPC API by using existing JSON-RPC libraries.

	An rough and incomplete list of changes compared to version 2 can be found [[~~Eden API Changes~~\|here]]. A more complete and detailed list can be found in the [http://forum.kodi.tv/showthread.php?t=98551 forum].		An rough and incomplete list of changes compared to version 2 can be found [[Archive:Eden_API_changes\|here]]. A more complete and detailed list can be found in the [http://forum.kodi.tv/showthread.php?t=98551 forum].

	{{TOC right}}		{{TOC right}}

Kibje: /* Error message */ syntaxhighlighter fix

2018-07-10T12:16:15Z

Error message: syntaxhighlighter fix

← Older revision		Revision as of 12:16, 10 July 2018
Line 152:		Line 152:
	{\|		{\|
	\|		\|
	<syntaxhighlight lang=~~"javascript"~~ enclose="div">		<syntaxhighlight lang=json enclose="div">
	{		{
	"type": "object",		"type": "object",

NedBot: web link corrections for xbmc -> kodi

2015-05-13T00:46:35Z

web link corrections for xbmc -> kodi

← Older revision		Revision as of 00:46, 13 May 2015
Line 3:		Line 3:
	Version 4 is a stable version of XBMC's JSON-RPC API and is published with the release of Eden. It is a complete re-write and re-structuring of [[JSON-RPC API/v2\|version 2]] and therefore isn't backwards compatible to it. The main reason for this was the need to make this version fully compatible with all the functionality, features and requirements of the [http://jsonrpc.org/spec.html JSON-RPC 2.0 specification]. This was a main concern during early development to make it easier for third party developers and applications to interact with XBMC's JSON-RPC API by using existing JSON-RPC libraries.		Version 4 is a stable version of XBMC's JSON-RPC API and is published with the release of Eden. It is a complete re-write and re-structuring of [[JSON-RPC API/v2\|version 2]] and therefore isn't backwards compatible to it. The main reason for this was the need to make this version fully compatible with all the functionality, features and requirements of the [http://jsonrpc.org/spec.html JSON-RPC 2.0 specification]. This was a main concern during early development to make it easier for third party developers and applications to interact with XBMC's JSON-RPC API by using existing JSON-RPC libraries.

	An rough and incomplete list of changes compared to version 2 can be found [[Eden API Changes\|here]]. A more complete and detailed list can be found in the [http://forum.~~xbmc~~.~~org~~/showthread.php?t=98551 forum].		An rough and incomplete list of changes compared to version 2 can be found [[Eden API Changes\|here]]. A more complete and detailed list can be found in the [http://forum.kodi.tv/showthread.php?t=98551 forum].

	{{TOC right}}		{{TOC right}}

NedBot: Bot: Automated text replacement (-{{subst:Name}} +Kodi)

2015-05-13T00:25:23Z

Bot: Automated text replacement (-{{subst:Name}} +Kodi)

← Older revision		Revision as of 00:25, 13 May 2015
Line 190:		Line 190:
	Application Application information and control		Application Application information and control
	System System controls and information		System System controls and information
	XBMC Dumping ground for very ~~{{subst:Name}}~~ specific operations		XBMC Dumping ground for very Kodi specific operations
	</pre>		</pre>
	\|}		\|}
Line 2,407:		Line 2,407:
	},		},
	"params": [],		"params": [],
	"description": "Puts the system running ~~{{subst:Name}}~~ into hibernate mode"		"description": "Puts the system running Kodi into hibernate mode"
	}</syntaxhighlight>}}		}</syntaxhighlight>}}

Line 2,437:		Line 2,437:
	},		},
	"params": [],		"params": [],
	"description": "Shuts the system running ~~{{subst:Name}}~~ down"		"description": "Shuts the system running Kodi down"
	}</syntaxhighlight>}}		}</syntaxhighlight>}}

Line 3,340:		Line 3,340:
	}		}
	],		],
	"description": "Retrieve info booleans about ~~{{subst:Name}}~~ and the system"		"description": "Retrieve info booleans about Kodi and the system"
	}</syntaxhighlight>}}		}</syntaxhighlight>}}

Line 3,372:		Line 3,372:
	}		}
	],		],
	"description": "Retrieve info labels about ~~{{subst:Name}}~~ and the system"		"description": "Retrieve info labels about Kodi and the system"
	}</syntaxhighlight>}}		}</syntaxhighlight>}}

NedBot: Robot: Substituting template: Name

2014-06-05T20:23:19Z

Robot: Substituting template: Name

← Older revision		Revision as of 20:23, 5 June 2014
Line 27:		Line 27:

	== Documentation (JSON Schema) ==		== Documentation (JSON Schema) ==
	Starting with JSON-RPC API version 3 a new way of API documentation has been introduced. All methods and data types are described using [http://tools.ietf.org/html/draft-zyp-json-schema-03 JSON Schema]. This provides third party developers with an always complete and up-to-date documentation by calling [[#JSONRPC.Introspect\|JSONRPC.Introspect]] even during periods of heavy development. Furthermore the same method and data type specification that can be used by third party developers as a documentation is used by ~~{{name}}~~ to check and verify method parameters and their values on every JSON-RPC request and allows to provide detailed error messages in case of a bad or missing parameter.		Starting with JSON-RPC API version 3 a new way of API documentation has been introduced. All methods and data types are described using [http://tools.ietf.org/html/draft-zyp-json-schema-03 JSON Schema]. This provides third party developers with an always complete and up-to-date documentation by calling [[#JSONRPC.Introspect\|JSONRPC.Introspect]] even during periods of heavy development. Furthermore the same method and data type specification that can be used by third party developers as a documentation is used by XBMC to check and verify method parameters and their values on every JSON-RPC request and allows to provide detailed error messages in case of a bad or missing parameter.

	=== Supported features of JSON Schema ===		=== Supported features of JSON Schema ===
Line 149:		Line 149:

	== Error message ==		== Error message ==
	If ~~{{name}}~~ detects a bad or missing parameter in a JSON-RPC request it returns an error object. The JSON schema description of that error object is		If XBMC detects a bad or missing parameter in a JSON-RPC request it returns an error object. The JSON schema description of that error object is
	{\|		{\|
	\|		\|
Line 177:		Line 177:

	== Namespaces ==		== Namespaces ==
	The ~~{{name}}~~ JSON-RPC API is split up into namespaces, which contain methods that can be called. These namespaces are:		The XBMC JSON-RPC API is split up into namespaces, which contain methods that can be called. These namespaces are:
	{\|		{\|
	\|		\|
Line 190:		Line 190:
	Application Application information and control		Application Application information and control
	System System controls and information		System System controls and information
	XBMC Dumping ground for very {{~~name~~}} specific operations		XBMC Dumping ground for very {{subst:Name}} specific operations
	</pre>		</pre>
	\|}		\|}
Line 2,396:		Line 2,396:

	==== System.Hibernate ====		==== System.Hibernate ====
	Puts the system running ~~{{name}}~~ into hibernate mode<br />		Puts the system running XBMC into hibernate mode<br />
	'''Permissions:'''		'''Permissions:'''
	* ControlPower		* ControlPower
Line 2,407:		Line 2,407:
	},		},
	"params": [],		"params": [],
	"description": "Puts the system running {{~~name~~}} into hibernate mode"		"description": "Puts the system running {{subst:Name}} into hibernate mode"
	}</syntaxhighlight>}}		}</syntaxhighlight>}}

Line 2,426:		Line 2,426:

	==== System.Shutdown ====		==== System.Shutdown ====
	Shuts the system running ~~{{name}}~~ down<br />		Shuts the system running XBMC down<br />
	'''Permissions:'''		'''Permissions:'''
	* ControlPower		* ControlPower
Line 2,437:		Line 2,437:
	},		},
	"params": [],		"params": [],
	"description": "Shuts the system running {{~~name~~}} down"		"description": "Shuts the system running {{subst:Name}} down"
	}</syntaxhighlight>}}		}</syntaxhighlight>}}

Line 3,311:		Line 3,311:
	}</syntaxhighlight>}}		}</syntaxhighlight>}}

	=== ~~{{name}}~~ ===		=== XBMC ===
	==== XBMC.GetInfoBooleans ====		==== XBMC.GetInfoBooleans ====
	Retrieve info booleans about ~~{{name}}~~ and the system<br />		Retrieve info booleans about XBMC and the system<br />
	'''Permissions:'''		'''Permissions:'''
	* ReadData		* ReadData
Line 3,340:		Line 3,340:
	}		}
	],		],
	"description": "Retrieve info booleans about {{~~name~~}} and the system"		"description": "Retrieve info booleans about {{subst:Name}} and the system"
	}</syntaxhighlight>}}		}</syntaxhighlight>}}

	==== XBMC.GetInfoLabels ====		==== XBMC.GetInfoLabels ====
	Retrieve info labels about ~~{{name}}~~ and the system<br />		Retrieve info labels about XBMC and the system<br />
	'''Permissions:'''		'''Permissions:'''
	* ReadData		* ReadData
Line 3,372:		Line 3,372:
	}		}
	],		],
	"description": "Retrieve info labels about {{~~name~~}} and the system"		"description": "Retrieve info labels about {{subst:Name}} and the system"
	}</syntaxhighlight>}}		}</syntaxhighlight>}}

NedBot: Bot: Automated text replacement (- XBMC + {{name}} )

2014-06-05T01:07:13Z

Bot: Automated text replacement (- XBMC + {{name}} )

← Older revision		Revision as of 01:07, 5 June 2014
Line 27:		Line 27:

	== Documentation (JSON Schema) ==		== Documentation (JSON Schema) ==
	Starting with JSON-RPC API version 3 a new way of API documentation has been introduced. All methods and data types are described using [http://tools.ietf.org/html/draft-zyp-json-schema-03 JSON Schema]. This provides third party developers with an always complete and up-to-date documentation by calling [[#JSONRPC.Introspect\|JSONRPC.Introspect]] even during periods of heavy development. Furthermore the same method and data type specification that can be used by third party developers as a documentation is used by ~~XBMC~~ to check and verify method parameters and their values on every JSON-RPC request and allows to provide detailed error messages in case of a bad or missing parameter.		Starting with JSON-RPC API version 3 a new way of API documentation has been introduced. All methods and data types are described using [http://tools.ietf.org/html/draft-zyp-json-schema-03 JSON Schema]. This provides third party developers with an always complete and up-to-date documentation by calling [[#JSONRPC.Introspect\|JSONRPC.Introspect]] even during periods of heavy development. Furthermore the same method and data type specification that can be used by third party developers as a documentation is used by {{name}} to check and verify method parameters and their values on every JSON-RPC request and allows to provide detailed error messages in case of a bad or missing parameter.

	=== Supported features of JSON Schema ===		=== Supported features of JSON Schema ===
Line 149:		Line 149:

	== Error message ==		== Error message ==
	If ~~XBMC~~ detects a bad or missing parameter in a JSON-RPC request it returns an error object. The JSON schema description of that error object is		If {{name}} detects a bad or missing parameter in a JSON-RPC request it returns an error object. The JSON schema description of that error object is
	{\|		{\|
	\|		\|
Line 177:		Line 177:

	== Namespaces ==		== Namespaces ==
	The ~~XBMC~~ JSON-RPC API is split up into namespaces, which contain methods that can be called. These namespaces are:		The {{name}} JSON-RPC API is split up into namespaces, which contain methods that can be called. These namespaces are:
	{\|		{\|
	\|		\|
Line 190:		Line 190:
	Application Application information and control		Application Application information and control
	System System controls and information		System System controls and information
	XBMC Dumping ground for very ~~XBMC~~ specific operations		XBMC Dumping ground for very {{name}} specific operations
	</pre>		</pre>
	\|}		\|}
Line 2,396:		Line 2,396:

	==== System.Hibernate ====		==== System.Hibernate ====
	Puts the system running ~~XBMC~~ into hibernate mode<br />		Puts the system running {{name}} into hibernate mode<br />
	'''Permissions:'''		'''Permissions:'''
	* ControlPower		* ControlPower
Line 2,407:		Line 2,407:
	},		},
	"params": [],		"params": [],
	"description": "Puts the system running ~~XBMC~~ into hibernate mode"		"description": "Puts the system running {{name}} into hibernate mode"
	}</syntaxhighlight>}}		}</syntaxhighlight>}}

Line 2,426:		Line 2,426:

	==== System.Shutdown ====		==== System.Shutdown ====
	Shuts the system running ~~XBMC~~ down<br />		Shuts the system running {{name}} down<br />
	'''Permissions:'''		'''Permissions:'''
	* ControlPower		* ControlPower
Line 2,437:		Line 2,437:
	},		},
	"params": [],		"params": [],
	"description": "Shuts the system running ~~XBMC~~ down"		"description": "Shuts the system running {{name}} down"
	}</syntaxhighlight>}}		}</syntaxhighlight>}}

Line 3,311:		Line 3,311:
	}</syntaxhighlight>}}		}</syntaxhighlight>}}

	=== ~~XBMC~~ ===		=== {{name}} ===
	==== XBMC.GetInfoBooleans ====		==== XBMC.GetInfoBooleans ====
	Retrieve info booleans about ~~XBMC~~ and the system<br />		Retrieve info booleans about {{name}} and the system<br />
	'''Permissions:'''		'''Permissions:'''
	* ReadData		* ReadData
Line 3,340:		Line 3,340:
	}		}
	],		],
	"description": "Retrieve info booleans about ~~XBMC~~ and the system"		"description": "Retrieve info booleans about {{name}} and the system"
	}</syntaxhighlight>}}		}</syntaxhighlight>}}

	==== XBMC.GetInfoLabels ====		==== XBMC.GetInfoLabels ====
	Retrieve info labels about ~~XBMC~~ and the system<br />		Retrieve info labels about {{name}} and the system<br />
	'''Permissions:'''		'''Permissions:'''
	* ReadData		* ReadData
Line 3,372:		Line 3,372:
	}		}
	],		],
	"description": "Retrieve info labels about ~~XBMC~~ and the system"		"description": "Retrieve info labels about {{name}} and the system"
	}</syntaxhighlight>}}		}</syntaxhighlight>}}

NedBot: Bot: automated adding of 'enclose="div"' to syntaxhighlight

2014-03-14T06:45:06Z

Bot: automated adding of 'enclose="div"' to syntaxhighlight

Show changes