This comand is used to get a list of Priorities from WHMCSPM2
Attributes
limitstart - Optional start at which result (default 0) limitnum - Optional limit at how many results (default 25) tasks - Optional display only task priorities (1 or 0) projects - Optional display only project priorities (1 or 0) adminonly - Optional display only admin priorities (1 or 0)
Example Command
$postfields["action"] = "whmcspm2getpriorities";
Returned Variables
action
result - error / success
totalresults
startnumber
numreturned
priorities - array of priorities converted to xml, json or NVP
- priority
- id
- name
- is_admindefault
- is_clientdefault
- is_task
- is_project
- position - display order
- is_adminonly
- rowbgcolor
- sbtextcolor
- sbbgcolor
XML Example:
whmcspm2getpriorities
success
3
0
3
1
Low
0
1
1
1
1
0
2
Medium
1
0
1
1
2
0
3
High
0
0
1
1
3
0
4
Urgent
0
0
1
1
4
1
JSON Example:
{
"result":"success",
"totalresults":3,
"startnumber":0,
"numreturned":3,
"priorities":{
"priority":[
{
"id":"1",
"name":"Low",
"is_admindefault":"0",
"is_clientdefault":"1",
"is_task":"1",
"is_project":"1",
"position":"1",
"is_adminonly":"0",
"rowbgcolor":"",
"sbtextcolor":"",
"sbbgcolor":""
},
{
"id":"2",
"name":"Medium",
"is_admindefault":"1",
"is_clientdefault":"0",
"is_task":"1",
"is_project":"1",
"position":"2",
"is_adminonly":"0",
"rowbgcolor":"",
"sbtextcolor":"",
"sbbgcolor":""
},
{
"id":"3",
"name":"High",
"is_admindefault":"0",
"is_clientdefault":"0",
"is_task":"1",
"is_project":"1",
"position":"3",
"is_adminonly":"0",
"rowbgcolor":"",
"sbtextcolor":"",
"sbbgcolor":""
},
{
"id":"4",
"name":"Urgent",
"is_admindefault":"0",
"is_clientdefault":"0",
"is_task":"1",
"is_project":"1",
"position":"4",
"is_adminonly":"1",
"rowbgcolor":"",
"sbtextcolor":"",
"sbbgcolor":""
}
]
}
}
NVP Example:
Array
(
[result] => success
[totalresults] => 3
[startnumber] => 0
[numreturned] => 3
[priorities] => Array
(
[priority] => Array
(
[0] => Array
(
[id] => 1
[name] => Low
[is_admindefault] => 0
[is_clientdefault] => 1
[is_task] => 1
[is_project] => 1
[position] => 1
[is_adminonly] => 0
[rowbgcolor] =>
[sbtextcolor] =>
[sbbgcolor] =>
)
[1] => Array
(
[id] => 2
[name] => Medium
[is_admindefault] => 1
[is_clientdefault] => 0
[is_task] => 1
[is_project] => 1
[position] => 2
[is_adminonly] => 0
[rowbgcolor] =>
[sbtextcolor] =>
[sbbgcolor] =>
)
[2] => Array
(
[id] => 3
[name] => High
[is_admindefault] => 0
[is_clientdefault] => 0
[is_task] => 1
[is_project] => 1
[position] => 3
[is_adminonly] => 0
[rowbgcolor] =>
[sbtextcolor] =>
[sbbgcolor] =>
)
[3] => Array
(
[id] => 4
[name] => Urgent
[is_admindefault] => 0
[is_clientdefault] => 0
[is_task] => 1
[is_project] => 1
[position] => 4
[is_adminonly] => 1
[rowbgcolor] =>
[sbtextcolor] =>
[sbbgcolor] =>
)
)
)
)
