NumericField

  • Available Since API Version – 2.0\

The NumericField type is used to represent numeric fields in Maximizer, including numeric user-defined fields. NumericField objects contain the following properties:

  • Value - A numeric value containing the value of the field. May be cleared by setting a null value. Has a "decimalplaces" property indicating the number of decimal places that are retained.\

  • DisplayValue - A string value containing the numeric value formatted for display.\

Basic Read Request

The following example illustrates the syntax for a request for the default value of a NumericField in a Read method call.

Request

{
  "Udf/$TYPEID(2345)":1
}

Response

{
  "Udf/$TYPEID(2345)":1234.56
}

Detailed Read Request

The following example illustrates the syntax for a request for all properties of a NumericField in a Read method call.

Request

{
  "Udf/$TYPEID(2345)":{
    "Value":1,
    "DisplayValue":1
  }
}

Response

{
  "Udf/$TYPEID(2345)":{
    "Value":1234.56,
    "DisplayValue":"1,234.56"
  }
}

Create/Update Request

The following example illustrates the syntax for including an NumericField in a Create or Update method call.

Request

{
  "Udf/$TYPEID(2345)":6543.21
}

Response

{
  "Udf/$TYPEID(2345)":6543.21
}