Parameter

Type

Description

[IN]

Parameters described in Overview

Response

XML or JSON

[OUT]

XML or JSON containing companies the user has access to

Description

The Companies call retrieves a list of companies the user has access to.

Parameters

There are no additional parameters.

Return Values

Response – XML/JSON. A list of companies the user has access to.

The structure of the response is:

<Companies TotalRows=nnn TotalPages=nnn MorePages=True_or_False>
	<Company uuid={`{UUID_of_record}`}>
		<Number>Company number primary key</Number>
		<Our-Name>Company name</Our-Name>
		<Default>True or False – Whether this record is the user’s default company</Default>
	</Company>
</Companies>

{
"responsecode": 1,
"responsestatus": "OK",
"errorcode": 0,
"errormessage": "",
"totalrows": 1,
"totalpages": 1,
"responsemessage": "",
"pagerows": 0,
"pagenumber": 1,
"success": true,
"data": [
{
"uuid": "UUID",
"control_country": "UK",
"control_number": 1,
"control_ourname": "Company name",
"control_timezonecode": "UTCA",
"array_controldefault__control_number": true
}
]
}