Parameter Reference

MagicINFO REST API 2.0 uses a vast array of parameters to control various aspects of your MagicINFO environment through API. The exact set of parameters used differs from function to function. Regardless what API functions you plan on using it is recommended to familiarise yourself with their names and descriptions.

A-Z	Parameter Name	Description	Type
A

B

C
	channelName	Defines the channel name when creating a schedule	String
	channelNo	Defines the channel number when creating a schedule	Integer
	contentId	Defines the content UID when controlling content (i.e. creating a playlist)	String
	contentType	Defines the content type when uploading new content (IMAGE, MOVIE, OFFICE, PDF, FLASH, SOUND, HTML, or URL)	String
	creatorId	Defines the Creator of a resource (i.e. when creating a playlist)	String
D
	defaultContentDuration	Defines the default conten duration in seconds when creating a playlist	Integer
	deleteMethod	Defines the type of deletion method to be used when deleting content (GO_TO_RECYCLEBIN, GO_TO_RECYCLEBIN_FORCE, or DELETE_FORCE)	String
	description	Defines the description of a resource (i.e. when editing a schedule)	String
	deviceIds	Defines the device MAC addresse(s) when controlling devices (i.e. approving unapproved devices)	Array, String
	deviceModelName	Defines the device model name when controlling devices (i.e. updating device information)	String
	deviceName	Defines the name of a device when controlling devices (i.e. approving unapproved devices)	String
	deviceType	Defines the type of a device when controlling devices (i.e. approving unapproved devices as SPLAYER)	String
	deviceTypeVersion	Defines the version of S Player of a device (i.e. when creating a playlist)	Integer
E
	email	Defines the email address of a user at the time of creation	String
	expiredDate	Defines the expiration date of an action when controlling devices (i.e. approving unapproved devices - 2020-01-01 00:00:00)	String
	exportType	Defines the type of report to generate when creating a POP detailed report (i.e. EXCEL or PDF)	String
F
	frameId	Defines the frame ID when creating a schedule	Integer
	frameName	Defines the frame name when creating a schedule	String
G

H

I
	isMainFrame	Defines whether the frame is the main frame when creating a schedule	Boolean
	isVwl	Defines the type of a playlist or schedule (non-videowall, videowall) when searching for a playlist of schedule (1 = non-videowall, 2 = videowall)	Integer
J
	jobPosition	Defines the job position of a user at the time of creation	String
K

L
	location	Defines the location of a resource (i.e. approving unapproved devices)	String
M
	mapLocation	Defines the geographic location of a resource (i.e. when updating device information)	String
	metaData	Defines the metadata of a resource (i.e. when creating a playlist)	String
	mediaType	Defines the type of content when creating a playlist (i.e. IMAGE, MOVIE, OFFICE, PDF, FLASH, SOUND, HTML, or URL)	String
	mobileNum	Defines the mobile phone number of a user at the time of creation	String
N
	newGroupName	Used to denote the new group name at the time of changing group name (i.e. changing device group name)	String
O

P
	pageSize	Defines the number of sets of values to return in HTTP response	Integer
	password	Defines the password of a user at the time of creation	String
	passwordConfirm	Used to confirm the user password at the time of changing user password	String
	playlistName	Defines the playlist name when creating a playlist	String
	playlistType	Defines the playlist type when creating a playlist (i.e. PREMIUM or LITE)	String
	phoneNum	Defines the phone number of a user at the time of creation	String
	productType	Defines the product type when creating a playlist (i.e. PREMIUM or LITE)	String
Q

R
	refreshInterval	Defines the refresh interval of URL & Web content at the time of uploading (i.e. 23:59:59)	String
	reason	Used to denote a reason for performing the action (i.e. deleting a user)	String
S
	searchCreator	Defines the name of the creator when searching for a resource (i.e. a playlist of schedule)	String
	searchText	Defines the search caption when searching for a resource (i.e. a playlist of schedule)	String
	sendCleanStorageFlag	Used to denote whether to clear the device's local storage space (i.e. when updating device information)	Boolean
	startIndex	Defines the starting index when returning sets of values in HTTP response	Integer
	startDate	Defines the start playback date and time when creating a schedule (i.e. 2020-01-01 00:00:00)	String
T
	tagIds	Defines tags to attach to content when creating a playlist	Array, String
	tagValues	Defines tag values to attach to content when creating a playlist (if using tags)	Array, String
	team	Defines the team of a user at the time of creation	String
U
	urlAddress	Defines the URL address at the time of uploading URL content	String
	urlContentName	Defines the URL content name at the time of uploading URL content	String
	userId	Defines the user ID of a user at the time of creation	String
	userName	Defines the user name of a user at the time of creation	String
V

W

X

Y

Z

Content

공간 도구

Parameter Reference