GET api/industry

Get industries.

Requires Authorisation

The api request must supply authenticated token in a custom variable in the request header. The custom variable name is configured in web.config. The default name of the custom variable is “X-Fern-Token”.

Requires Api License and User Access

The api requires license and user permission for API ID, GETapi/industry. The user permission can be defined on User Settings screen in Abacus. For license, please contact Fern manager.

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Response Codes

Success Status:

  • OK (200), please see resource description below.

Failed Status(es):

Resource Description

Returns an array of all industries.

Collection of IndustryDto
NameDescriptionTypeAdditional information
IndustryID

Unique Identifier of Industry record.

integer Read-Only.
Name

Indicates Name of this industry.

string Required
DefaultItem

Indicates whether this industry code is selected by default.

boolean Optional

Response Formats

application/json, text/json

Sample:
[
  {
    "industryID": 1,
    "name": "sample string 1",
    "defaultItem": true
  },
  {
    "industryID": 1,
    "name": "sample string 1",
    "defaultItem": true
  }
]

application/xml, text/xml

Sample:
<ArrayOfIndustryDto xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Fern.Abacus.ObjectModel.Dto.CU">
  <IndustryDto>
    <DefaultItem>true</DefaultItem>
    <IndustryID>1</IndustryID>
    <Name>sample string 1</Name>
  </IndustryDto>
  <IndustryDto>
    <DefaultItem>true</DefaultItem>
    <IndustryID>1</IndustryID>
    <Name>sample string 1</Name>
  </IndustryDto>
</ArrayOfIndustryDto>