GET api/UserDefinedField

Gets a list of user defined fields.

Request Information

URI Parameters

(i.e.queryString parameters in the form ?param1={param1}&param2={param2})

None.

Body Parameters

None.

Response Information

Resource Description

UserDefinedFieldView

Name	Description	Type	Additional information
FieldName	A unique name used to identify a field	string	None.
Description	The Description is displayed on the employees Addition Field window	string	None.
PageName	The name of the tab for the user defined field	string	None.
DataType	The type of data is in the user defined field, ie. Numeric, text etc	string	None.
DataValue	The value of the data. If the Data Type is Lookup, this field will be a list separated by semi-colons, eg. Accounts; Support; Administration etc	string	None.
FieldSize	The number of characters that can be entered	integer	None.
DefaultValue	The value will display in the user defined fields for an employee	string	None.

Response Formats

application/json, text/json

Sample:

{
  "fieldName": "sample string 1",
  "description": "sample string 2",
  "pageName": "sample string 3",
  "dataType": "sample string 4",
  "dataValue": "sample string 5",
  "fieldSize": 6,
  "defaultValue": "sample string 7"
}

application/xml, text/xml

Sample:

<UserDefinedFieldView xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <FieldName>sample string 1</FieldName>
  <Description>sample string 2</Description>
  <PageName>sample string 3</PageName>
  <DataType>sample string 4</DataType>
  <DataValue>sample string 5</DataValue>
  <FieldSize>6</FieldSize>
  <DefaultValue>sample string 7</DefaultValue>
</UserDefinedFieldView>