GET api/v1/dictionary/enterprise/{enterprise_code}

Provides the definition of a provided enterprise code or all the current enterprise codes. Possible Values: enterprise code, ‘ALL’, or ‘all’.

Request Information

Headers

In order to receive live data, you must provide the necessary information to authenticate. This will require an API-Key, which is to be provided within the request header for every request. If an API-Key is not provided, sandbox data will be returned.

Name Description Type Additional Information
API-Key 32 Character GUID key String Required to return live information. If not provided, sandbox data will be returned.

URI Parameters

NameDescriptionTypeAdditional information
enterprise_code

The enterprise code to search for or 'All' returned codes

string

Required

Body Parameters

None.

Response Information

Resource Description

Enterprise code(s) and the definition

Collection of V1_Dictionary
NameDescriptionTypeAdditional information
Enterprise_Code

The Enterprise Code specific to an enterprise code

string

Required

Enterprise_Type_Code

Enterprise Type Code specific to an enterprise type code

string

None.

Definition

The definition or meaning of the term

string

None.

Unit_of_Measure

Unit of Measure

string

None.

Group_Item_Indicator

Group Item Indicator [Y- represents a Summary, N - represents Not a Summary of the Enterprise_Code]

string

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "Enterprise_Code": "sample string 1",
    "Enterprise_Type_Code": "sample string 2",
    "Definition": "sample string 3",
    "Unit_of_Measure": "sample string 4",
    "Group_Item_Indicator": "sample string 5"
  },
  {
    "Enterprise_Code": "sample string 1",
    "Enterprise_Type_Code": "sample string 2",
    "Definition": "sample string 3",
    "Unit_of_Measure": "sample string 4",
    "Group_Item_Indicator": "sample string 5"
  }
]

text/html

Sample:
[{"Enterprise_Code":"sample string 1","Enterprise_Type_Code":"sample string 2","Definition":"sample string 3","Unit_of_Measure":"sample string 4","Group_Item_Indicator":"sample string 5"},{"Enterprise_Code":"sample string 1","Enterprise_Type_Code":"sample string 2","Definition":"sample string 3","Unit_of_Measure":"sample string 4","Group_Item_Indicator":"sample string 5"}]

application/xml, text/xml

Sample:
<ArrayOfV1_Dictionary xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/FF_API.Models.Dictionary.V1">
  <V1_Dictionary>
    <Definition>sample string 3</Definition>
    <Enterprise_Code>sample string 1</Enterprise_Code>
    <Enterprise_Type_Code>sample string 2</Enterprise_Type_Code>
    <Group_Item_Indicator>sample string 5</Group_Item_Indicator>
    <Unit_of_Measure>sample string 4</Unit_of_Measure>
  </V1_Dictionary>
  <V1_Dictionary>
    <Definition>sample string 3</Definition>
    <Enterprise_Code>sample string 1</Enterprise_Code>
    <Enterprise_Type_Code>sample string 2</Enterprise_Type_Code>
    <Group_Item_Indicator>sample string 5</Group_Item_Indicator>
    <Unit_of_Measure>sample string 4</Unit_of_Measure>
  </V1_Dictionary>
</ArrayOfV1_Dictionary>