GET api/Companies

Lists the practice and any subsidiary companies defined.

Request

(empty)

Response

Body

Content Type: application/xml or application/json
Basic details of the companies or an error message.

XML JSON
<Response> <Result> <Practice> <ID>long</ID> <!--Contact number (unique ID)--> <FileAs>string</FileAs> <!--File-as name--> </Practice> <SubsidiaryCompanies> <!--Array of 'Item'--> <Item> <ID>long</ID> <!--Contact number (unique ID)--> <FileAs>string</FileAs> <!--File-as name--> <Code>string</Code> <!--File number prefix--> <HasPermission>bool</HasPermission> <!--Whether the member has access--> </Item> </SubsidiaryCompanies> </Result> <Message>string</Message> <!--Error message--> </Response>
{ "Result": { "Practice": { "ID": "long", // Contact number (unique ID) "FileAs": "string" // File-as name }, "SubsidiaryCompanies": [{ "ID": "long", // Contact number (unique ID) "FileAs": "string", // File-as name "Code": "string", // File number prefix "HasPermission": "bool" // Whether the member has access }] }, "Message": "string" // Error message }

XML JSON

<Response>                                     
  <Result>                                     
    <Practice>                                 
      <ID>long</ID>                            <!--Contact number (unique ID)--> 
      <FileAs>string</FileAs>                  <!--File-as name--> 
    </Practice>                                
    <SubsidiaryCompanies>                      <!--Array of 'Item'--> 
      <Item>                                   
        <ID>long</ID>                          <!--Contact number (unique ID)--> 
        <FileAs>string</FileAs>                <!--File-as name--> 
        <Code>string</Code>                    <!--File number prefix--> 
        <HasPermission>bool</HasPermission>    <!--Whether the member has access--> 
      </Item>                                  
    </SubsidiaryCompanies>                     
  </Result>                                    
  <Message>string</Message>                    <!--Error message--> 
</Response>

{                                  
   "Result": {                     
      "Practice": {                
         "ID": "long",             // Contact number (unique ID)
         "FileAs": "string"        // File-as name
      },                           
      "SubsidiaryCompanies": [{    
         "ID": "long",             // Contact number (unique ID)
         "FileAs": "string",       // File-as name
         "Code": "string",         // File number prefix
         "HasPermission": "bool"   // Whether the member has access
      }]                           
   },                              
   "Message": "string"             // Error message
}

Status Codes

Code	Condition
200 OK	The operation completed successfully.
401 Unauthorized	Access token is invalid, expired or not specified.
406 Not Acceptable	Content type specified in the Accept header isn't supported.
500 Internal Server Error	An internal error occurred.