Player Software

Search Player Versions

get

Search Player Versions

Query parameters

playerTypestringOptional

Filter by player type

playerVersionstringOptional

Filter by player version

playerCodeintegerOptional

Filter by player code

versionIdintegerOptional

Filter by version ID

playerShowVersionstringOptional

Filter by player show version name

sortBystring · enumOptional

Specifies which field the results are sorted by. Used together with sortDir

Possible values:

sortDirstring · enumOptional

Sort direction

Possible values:

Responses

200

successful operation

application/json

get/playersoftware

GET /api/playersoftware HTTP/1.1
Accept: */*

200

successful operation

[
  {
    "versionId": 1,
    "type": "text",
    "version": "text",
    "code": 1,
    "playerShowVersion": "text",
    "createdAt": "text",
    "modifiedAt": "text",
    "modifiedBy": "text",
    "fileName": "text",
    "size": 1,
    "md5": "text"
  }
]

Player Software Upload

post

Upload a new Player version file

Body

filesstring · binaryRequired

The Uploaded File

Responses

200

successful operation

No content

post/playersoftware

POST /api/playersoftware HTTP/1.1
Content-Type: multipart/form-data
Accept: */*
Content-Length: 18

{
  "files": "binary"
}

200

successful operation

No content

Search Player Version by ID

get

Get the Player Version object specified by the provided versionId

Path parameters

versionIdintegerRequired

Numeric ID of the Player Version to get

Responses

200

successful operation

application/json

Class PlayerVersion

versionIdinteger · nullableOptional

Version ID

typestring · nullableOptional

Player type

versionstring · nullableOptional

Version number

codeinteger · nullableOptional

Code number

playerShowVersionstring · nullableOptional

Player version to show

createdAtstring · nullableOptional

The Player Version created date

modifiedAtstring · nullableOptional

The Player Version modified date

modifiedBystring · nullableOptional

The name of the user that modified this Player Version last

fileNamestring · nullableOptional

The Player Version file name

sizeinteger · nullableOptional

The Player Version file size in bytes

md5string · nullableOptional

A MD5 checksum of the stored Player Version file

get/playersoftware/{versionId}

GET /api/playersoftware/{versionId} HTTP/1.1
Accept: */*

200

successful operation

{
  "versionId": 1,
  "type": "text",
  "version": "text",
  "code": 1,
  "playerShowVersion": "text",
  "createdAt": "text",
  "modifiedAt": "text",
  "modifiedBy": "text",
  "fileName": "text",
  "size": 1,
  "md5": "text"
}

Edit Player Version

put

Edit a Player Version file information

Path parameters

versionIdintegerRequired

The Version ID to Edit

Body

playerShowVersionstringOptional

The Name of the player version application, this will be displayed in Version dropdowns in Display Profile and Display

versionstringOptional

The Version number

codeintegerOptional

The Code number

Responses

200

successful operation

application/json

Class PlayerVersion

versionIdinteger · nullableOptional

Version ID

typestring · nullableOptional

Player type

versionstring · nullableOptional

Version number

codeinteger · nullableOptional

Code number

playerShowVersionstring · nullableOptional

Player version to show

createdAtstring · nullableOptional

The Player Version created date

modifiedAtstring · nullableOptional

The Player Version modified date

modifiedBystring · nullableOptional

The name of the user that modified this Player Version last

fileNamestring · nullableOptional

The Player Version file name

sizeinteger · nullableOptional

The Player Version file size in bytes

md5string · nullableOptional

A MD5 checksum of the stored Player Version file

put/playersoftware/{versionId}

PUT /api/playersoftware/{versionId} HTTP/1.1
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 54

"playerShowVersion='text'&version='text'&code=1"

200

successful operation

{
  "versionId": 1,
  "type": "text",
  "version": "text",
  "code": 1,
  "playerShowVersion": "text",
  "createdAt": "text",
  "modifiedAt": "text",
  "modifiedBy": "text",
  "fileName": "text",
  "size": 1,
  "md5": "text"
}

Delete Version

delete

Delete Version file from the Library and Player Versions table

Path parameters

versionIdintegerRequired

The Version ID to Delete

Responses

204

successful operation

No content

delete/playersoftware/{versionId}

DELETE /api/playersoftware/{versionId} HTTP/1.1
Accept: */*

204

successful operation

No content

Player Software Metadata

get

Returns distinct player types, versions and valid upload extensions for use in filter dropdowns and upload configuration

Responses

200

successful operation

No content

get/playersoftware/meta

GET /api/playersoftware/meta HTTP/1.1
Accept: */*

200

successful operation

No content

Download Player Version file

get

Download Player Version file

Path parameters

idintegerRequired

The Player Version ID to Download

Responses

200

successful operation

application/octet-stream

Responsestring · binary

get/playersoftware/download/{id}

GET /api/playersoftware/download/{id} HTTP/1.1
Accept: */*

200

successful operation

binary