GET api/v1/dictionary/link/{link_code}

Provides the link types description that describes the linkage between records. Possible Values: link 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
link_code

string

Required

Body Parameters

None.

Response Information

Resource Description

Link code(s) and the definition

Collection of V1_GenericType
NameDescriptionTypeAdditional information
Type

Type Code

string

Required

Description

Description of the Type Code

string

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "Type": "sample string 1",
    "Description": "sample string 2"
  },
  {
    "Type": "sample string 1",
    "Description": "sample string 2"
  }
]

text/html

Sample:
[{"Type":"sample string 1","Description":"sample string 2"},{"Type":"sample string 1","Description":"sample string 2"}]

application/xml, text/xml

Sample:
<ArrayOfV1_GenericType xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/FF_API.Models.Dictionary.V1">
  <V1_GenericType>
    <Description>sample string 2</Description>
    <Type>sample string 1</Type>
  </V1_GenericType>
  <V1_GenericType>
    <Description>sample string 2</Description>
    <Type>sample string 1</Type>
  </V1_GenericType>
</ArrayOfV1_GenericType>