This comand is used to get a list of Statuses 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 statuses (1 or 0) projects - Optional display only project statuses (1 or 0) adminonly - Optional display only admin statuses (1 or 0)
Example Command
$postfields["action"] = "whmcspm2getstatuses";
Returned Variables
action
result - error / success
totalresults
startnumber
numreturned
statuses - array of statuses converted to xml, json or NVP
- status
- id
- name
- is_closed
- is_admindefault
- is_clientdefault
- is_task
- is_project
- position - display order
- is_adminonly
- rowbgcolor
- sbtextcolor
- sbbgcolor
XML Example:
<whmcsapi>
<action>whmcspm2getstatuses</action>
<result>success</results>
<totalresults>3</totalresults>
<startnumber>0</startnumber>
<numreturned>3</numreturned>
<statuses>
<status>
<id>1</id>
<name>Active</name>
<is_closed>0</is_closed>
<is_admindefault>1</is_admindefault>
<is_clientdefault>0</is_clientdefault>
<is_task>1</is_task>
<is_project>1</is_project>
<position>0</position>
<is_adminonly>0</is_adminonly>
<rowbgcolor></rowbgcolor>
<sbtextcolor></sbtextcolor>
<sbbgcolor></sbbgcolor>
</status>
<status>
<id>2</id>
<name>Pending</name>
<is_closed>0</is_closed>
<is_admindefault>0</is_admindefault>
<is_clientdefault>1</is_clientdefault>
<is_task>1</is_task>
<is_project>1</is_project>
<position>1</position>
<is_adminonly>0</is_adminonly>
<rowbgcolor></rowbgcolor>
<sbtextcolor></sbtextcolor>
<sbbgcolor></sbbgcolor>
</status>
<status>
<id>3</id>
<name>Closed</name>
<is_closed>1</is_closed>
<is_admindefault>0</is_admindefault>
<is_clientdefault>0</is_clientdefault>
<is_task>1</is_task>
<is_project>1</is_project>
<position>3</position>
<is_adminonly>0</is_adminonly>
<rowbgcolor></rowbgcolor>
<sbtextcolor></sbtextcolor>
<sbbgcolor></sbbgcolor>
</status>
<status>
<id>3</id>
<name>On Hold</name>
<is_closed>0</is_closed>
<is_admindefault>0</is_admindefault>
<is_clientdefault>0</is_clientdefault>
<is_task>1</is_task>
<is_project>1</is_project>
<position>2</position>
<is_adminonly>1</is_adminonly>
<rowbgcolor></rowbgcolor>
<sbtextcolor></sbtextcolor>
<sbbgcolor></sbbgcolor>
</status>
</statuses>
</whmcsapi>
JSON Example:
{
"result":"success",
"totalresults":3,
"startnumber":0,
"numreturned":3,
"statuses":{
"status":[
{
"id":"1",
"name":"Active",
"is_closed":"0",
"is_admindefault":"1",
"is_clientdefault":"0",
"is_task":"1",
"is_project":"1",
"position":"0",
"is_adminonly":"0",
"rowbgcolor":"",
"sbtextcolor":"",
"sbbgcolor":""
},
{
"id":"2",
"name":"Pending",
"is_closed":"0",
"is_admindefault":"0",
"is_clientdefault":"1",
"is_task":"1",
"is_project":"1",
"position":"1",
"is_adminonly":"0",
"rowbgcolor":"",
"sbtextcolor":"",
"sbbgcolor":""
},
{
"id":"3",
"name":"Closed",
"is_closed":"1",
"is_admindefault":"0",
"is_clientdefault":"0",
"is_task":"1",
"is_project":"1",
"position":"3",
"is_adminonly":"0",
"rowbgcolor":"",
"sbtextcolor":"",
"sbbgcolor":""
},
{
"id":"3",
"name":"On Hold",
"is_closed":"0",
"is_admindefault":"0",
"is_clientdefault":"0",
"is_task":"1",
"is_project":"1",
"position":"2",
"is_adminonly":"1",
"rowbgcolor":"",
"sbtextcolor":"",
"sbbgcolor":""
}
]
}
}
NVP Example:
Array
(
[result] => success
[totalresults] => 3
[startnumber] => 0
[numreturned] => 3
[statuses] => Array
(
[status] => Array
(
[0] => Array
(
[id] => 1
[name] => Active
[is_closed] => 0
[is_admindefault] => 1
[is_clientdefault] => 0
[is_task] => 1
[is_project] => 1
[position] => 0
[is_adminonly] => 0
[rowbgcolor] =>
[sbtextcolor] =>
[sbbgcolor] =>
)
[1] => Array
(
[id] => 2
[name] => Pending
[is_closed] => 0
[is_admindefault] => 0
[is_clientdefault] => 1
[is_task] => 1
[is_project] => 1
[position] => 1
[is_adminonly] => 0
[rowbgcolor] =>
[sbtextcolor] =>
[sbbgcolor] =>
)
[2] => Array
(
[id] => 3
[name] => Closed
[is_closed] => 1
[is_admindefault] => 0
[is_clientdefault] => 0
[is_task] => 1
[is_project] => 1
[position] => 3
[is_adminonly] => 0
[rowbgcolor] =>
[sbtextcolor] =>
[sbbgcolor] =>
)
[3] => Array
(
[id] => 3
[name] => On Hold
[is_closed] => 0
[is_admindefault] => 0
[is_clientdefault] => 0
[is_task] => 1
[is_project] => 1
[position] => 2
[is_adminonly] => 1
[rowbgcolor] =>
[sbtextcolor] =>
[sbbgcolor] =>
)
)
)
)
