GET api/companies/{id}

Get information about a specific company registered with Solera.

Required Scopes

ReferenceData.System

Request Information

URI Parameters

Name	Description	Type	Additional information
id	Either an 8 character company code, or the unique ID of the company.	string	Required

Body Parameters

None.

Response Information

Resource Description

Company

Name	Type	Additional information
Id	globally unique identifier	None.
CompanyCode	string	None.
Description	string	None.
Status	string	None.
Site	Site	None.

{
  "Id": "376e8e4b-b8fc-4ede-a1de-359034c2f2b8",
  "CompanyCode": "sample string 2",
  "Description": "sample string 3",
  "Status": "sample string 4",
  "Site": {
    "ID": "50b08435-61cc-43f7-9b9d-1971b3d25522",
    "Contact": {
      "ContactType": "sample string 1",
      "AbleToAuthorise": "sample string 2",
      "Name": "sample string 3",
      "Title": "sample string 4",
      "Forename": "sample string 5",
      "Surname": "sample string 6",
      "EMailAddress": "sample string 7",
      "Line01": "sample string 8",
      "Line02": "sample string 9",
      "Line03": "sample string 10",
      "Line04": "sample string 11",
      "Line05": "sample string 12",
      "PostCode": "sample string 13",
      "TelHome": "sample string 14",
      "TelBusiness": "sample string 15",
      "TelMobile": "sample string 16",
      "TelOther": "sample string 17",
      "Fax": "sample string 18"
    },
    "Address": {
      "ID": "ce1f96b9-4bfe-46cd-9b3a-6ec9a4b3f841",
      "AddressLine1": "sample string 2",
      "AddressLine2": "sample string 3",
      "AddressLine3": "sample string 4",
      "AddressLine4": "sample string 5",
      "AddressLine5": "sample string 6",
      "PostCode": "sample string 7"
    },
    "AKAName": "sample string 2",
    "CompanyName": "sample string 3",
    "SiteId": "sample string 4",
    "ExternalCode": "sample string 5"
  }
}

<Company xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AudaAPI.Models">
  <CompanyCode>sample string 2</CompanyCode>
  <Description>sample string 3</Description>
  <Id>376e8e4b-b8fc-4ede-a1de-359034c2f2b8</Id>
  <Site>
    <AKAName>sample string 2</AKAName>
    <Address>
      <AddressLine1>sample string 2</AddressLine1>
      <AddressLine2>sample string 3</AddressLine2>
      <AddressLine3>sample string 4</AddressLine3>
      <AddressLine4>sample string 5</AddressLine4>
      <AddressLine5>sample string 6</AddressLine5>
      <ID>ce1f96b9-4bfe-46cd-9b3a-6ec9a4b3f841</ID>
      <PostCode>sample string 7</PostCode>
    </Address>
    <CompanyName>sample string 3</CompanyName>
    <Contact>
      <AbleToAuthorise>sample string 2</AbleToAuthorise>
      <ContactType>sample string 1</ContactType>
      <EMailAddress>sample string 7</EMailAddress>
      <Fax>sample string 18</Fax>
      <Forename>sample string 5</Forename>
      <Line01>sample string 8</Line01>
      <Line02>sample string 9</Line02>
      <Line03>sample string 10</Line03>
      <Line04>sample string 11</Line04>
      <Line05>sample string 12</Line05>
      <Name>sample string 3</Name>
      <PostCode>sample string 13</PostCode>
      <Surname>sample string 6</Surname>
      <TelBusiness>sample string 15</TelBusiness>
      <TelHome>sample string 14</TelHome>
      <TelMobile>sample string 16</TelMobile>
      <TelOther>sample string 17</TelOther>
      <Title>sample string 4</Title>
    </Contact>
    <ExternalCode>sample string 5</ExternalCode>
    <ID>50b08435-61cc-43f7-9b9d-1971b3d25522</ID>
    <SiteId>sample string 4</SiteId>
  </Site>
  <Status>sample string 4</Status>
</Company>