---
title: "Record Fields"
canonical: "https://support.soutron.net/space/LMSAPI/2228306/Record%20Fields"
format: markdown
---
## <span style="color: #008000">GET </span><span style="color: #008000">/recordFields</span>

<span style="color: #000000">**Description**</span><span style="color: #0000ff">**:**</span> Get a list of all available fields.

| **Parameter** | **Example** | **Notes** |
| --- | --- | --- |
| Active | `Active=true` | <span style="color: #172b4d">Get only active fields using True/False (1/0)</span> |
| Lang | Lang=2057 | LCID of required caption language |
| Portal | `Portal=1` | ID of required portal |
| RecordFieldID | RecordFieldID=1 | Id of field to return. If Null/not supplied all fields will be returned. |
| Standard | Standard=RIS | Standard will return the field captions for RIS format if configured |
| FilterWithoutRecordTypes | FilterWithoutRecordTypes=true | True will exclude fields not assigned to a record type & therefore not containing any data. |

<span style="color: #000000">**Request**</span>**<span style="color: #0000ff">: </span>**<span style="color: #003366">/</span><span style="color: #003366">SoutronAPI/recordFields?Active=true&Lang=2057&Portal=1&RecordFieldID=1&Standard=RIS&FilterWithoutRecordTypes=true</span>

<details>
<summary>Response</summary>

```xml
<RecordFieldsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Soutron.API.ServiceModel.Catalogues">
	<Fields>
		<RecordFieldItem>
			<Active>true</Active>
			<AdditionalSearch>true</AdditionalSearch>
			<AllFieldsSearch>true</AllFieldsSearch>
			<Caption>CID</Caption>
				<Localizations>
					<RecordFieldLocalizationItem>
						<Caption>CID</Caption>
						<IsNeutral>true</IsNeutral>
						<LCID>2057</LCID>
						<PortalID i:nil="true"/>
						<Standard>Soutron</Standard>
					</RecordFieldLocalizationItem>
				</Localizations>
			<Public>true</Public>
			<RecordFieldID>1</RecordFieldID>
			<SeeAlso>false</SeeAlso>
			<SingleEntry>true</SingleEntry>
			<SuggestActive>false</SuggestActive>
			<Type>Integer</Type>
		</RecordFieldItem>
	</Fields>
</RecordFieldsResponse>
```
</details>

## <span style="color: #008000">GET /</span><span style="color: #008000">recordFields</span><span style="color: #008000">/{RecordFieldID</span><span style="color: #008000">}</span>

## <span style="color: #000000">**Description**</span><span style="color: #000000">**:**</span><span style="color: #0000ff">** **</span><span style="color: #172b4d">Get details for specified field settings.</span>

| **Parameter** | **Example** | **Notes** |
| --- | --- | --- |
| RecordFieldID<br>[Required] | /SoutronAPI/recordFields/1 | Any valid field ID can be passed as part of URL |

**Example: **/SoutronAPI/recordFields/1

<details>
<summary>Response</summary>

```xml
<RecordFieldsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Soutron.API.ServiceModel.Catalogues">
	<Fields>
		<RecordFieldItem>
			<Active>true</Active>
			<AdditionalSearch>true</AdditionalSearch>
			<AllFieldsSearch>true</AllFieldsSearch>
			<Caption>CID</Caption>
				<Localizations>
					<RecordFieldLocalizationItem>
						<Caption>CID</Caption>
						<IsNeutral>true</IsNeutral>
						<LCID>2057</LCID>
						<PortalID i:nil="true"/>
						<Standard>Soutron</Standard>
					</RecordFieldLocalizationItem>
				</Localizations>
			<Public>true</Public>
			<RecordFieldID>1</RecordFieldID>
			<SeeAlso>false</SeeAlso>
			<SingleEntry>true</SingleEntry>
			<SuggestActive>false</SuggestActive>
			<Type>Integer</Type>
		</RecordFieldItem>
	</Fields>
</RecordFieldsResponse>
```
</details>