GET api/Company/GetCompaniesToDisplayById/{id}

Returns companies that are enabled on the display. Used for display side, not admin. Will return an empty object if id not found

Request Information

URI Parameters

Name	Description	Type	Additional information
id		integer	Required

Body Parameters

None.

Response Information

Resource Description

Companies

Name	Description	Type	Additional information
Id		integer	None.
Name		string	None.
Type		integer	None.
Website		string	None.
Overview		string	None.
Regions	bitwise value 1=Americas, 2=Asia, 4=Europe	integer	None.
Logo		string	None.
Enabled	If true, company is available for display on site, otherwise not	boolean	None.
OverallCA	Not being currently used, moved to correlation table	integer	None.
OverallCP	Not being currently used, moved to correlation table	integer	None.
AccessLevel	Level of access that members of company will have. Default level of zero is no access, 10=level 1, 20 = level 2 and so on	integer	None.
Display	True will mean the company is available for comparison	boolean	None.
Tagline		string	None.
Headquarters		string	None.
Employees		string	None.
Ticker		string	None.
Revenue		string	None.
RecentHappenings		string	None.
NumPipeLineDrugs		integer	None.
PipeLineDrugs		string	None.
EntityType		integer	None.
Phone		string	None.
OldImportId		integer	None.
SubscriptionIndustryId		integer	None.
SubscriptionSegmentId		integer	None.
MemberSince		date	None.
DemoMode		boolean	None.
Ownership		CompanyOwnership	None.
Email		string	None.
SocialMedia		string	None.

Response Formats

application/json, text/json, text/html

Sample:

{
  "Id": 1,
  "Name": "sample string 2",
  "Type": 3,
  "Website": "sample string 4",
  "Overview": "sample string 5",
  "Regions": 6,
  "Logo": "sample string 7",
  "Enabled": true,
  "OverallCA": 9,
  "OverallCP": 10,
  "AccessLevel": 11,
  "Display": true,
  "Tagline": "sample string 13",
  "Headquarters": "sample string 14",
  "Employees": "sample string 15",
  "Ticker": "sample string 16",
  "Revenue": "sample string 17",
  "RecentHappenings": "sample string 18",
  "NumPipeLineDrugs": 19,
  "PipeLineDrugs": "sample string 20",
  "EntityType": 21,
  "Phone": "sample string 22",
  "OldImportId": 23,
  "SubscriptionIndustryId": 24,
  "SubscriptionSegmentId": 25,
  "MemberSince": "2024-10-30T05:12:53.0947822-07:00",
  "DemoMode": true,
  "Ownership": 0,
  "Email": "sample string 28",
  "SocialMedia": "sample string 29"
}

application/xml, text/xml

Sample:

<Companies xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/NiceAPI.Managers">
  <AccessLevel>11</AccessLevel>
  <DemoMode>true</DemoMode>
  <Display>true</Display>
  <Email>sample string 28</Email>
  <Employees>sample string 15</Employees>
  <Enabled>true</Enabled>
  <EntityType>21</EntityType>
  <Headquarters>sample string 14</Headquarters>
  <Id>1</Id>
  <Logo>sample string 7</Logo>
  <MemberSince>2024-10-30T05:12:53.0947822-07:00</MemberSince>
  <Name>sample string 2</Name>
  <NumPipeLineDrugs>19</NumPipeLineDrugs>
  <OldImportId>23</OldImportId>
  <OverallCA>9</OverallCA>
  <OverallCP>10</OverallCP>
  <Overview>sample string 5</Overview>
  <Ownership>Unset</Ownership>
  <Phone>sample string 22</Phone>
  <PipeLineDrugs>sample string 20</PipeLineDrugs>
  <RecentHappenings>sample string 18</RecentHappenings>
  <Regions>6</Regions>
  <Revenue>sample string 17</Revenue>
  <SocialMedia>sample string 29</SocialMedia>
  <SubscriptionIndustryId>24</SubscriptionIndustryId>
  <SubscriptionSegmentId>25</SubscriptionSegmentId>
  <Tagline>sample string 13</Tagline>
  <Ticker>sample string 16</Ticker>
  <Type>3</Type>
  <Website>sample string 4</Website>
</Companies>