View

View information about one or more player plugins.

You can always view system-wide plugins. Customer-wide plugins can only be viewed by actors of that customer (or its accounts) or global actors. Account-specifc plugins can only be viewed by actors of that account, its customer or global actors.

Tokens

This action requires the following tokens:

  • playerplugin-read

Arguments

Required arguments are marked in bold, and optional arguments are marked in italics.

Argument Type Default Description
playerplugin Hash   Only show the player plugin with the given hash
searchdescription String   Only show player plugins containing the given string somewhere in the description
limit Integer 20 The maximum number of results to include in the output
offset Integer 0 The number of results to skip when outputting
orderfield String created

Defines the field to order the results by; can be any of the following:

  • created – Order by the date when the player plugin was created
  • modified – Order by the date when the player plugin was last modified
order String asc Sort the results by the field given in orderfield in ascending or descending order, by using ‘asc‘ or ‘desc‘ respectively

Output

This action produces the following extra headers on success, besides the default headers:

Name Type Description
count Integer The total number of results that would be returned when pagination would be disabled

This action produces the following output on success:

An array containing zero or more elements, each one being an object containing the following fields:

Name Type Description
id Hash Player plugin ID
jsurl String Player plugin javascript URL
cssurl String Player plugin CSS URL
name String Player plugin name
description String Player plugin description
datecreated DateTime When the player plugin was created
datemodified DateTime When the player plugin was last modified
account

Account for this player plugin

The value of this field is an object containing the following fields:

Name Type Description
id Hash Account ID
name String Account name
customer

Customer for this player plugin

The value of this field is an object containing the following fields:

Name Type Description
id Hash Customer ID
name String The name of this customer
datecreated DateTime When this customer was created
datemodified DateTime When this customer was last modified

Errors

This action will always return one of the default status codes.