Available Since API Version – 2.0

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

Value - A numeric value containing the value of the field. May be cleared by setting a null value.
DisplayValue - A string value containing the integer value formatted for display.

Basic Read Request

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

Request

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

Response

{
  "Udf/$TYPEID(5678)":123456
}

Detailed Read Request

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

Request

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

Response

{
  "Udf/$TYPEID(5678)":{
    "Value":123456,
    "DisplayValue":"123456"
  }
}

Create/Update Request

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

Request

{
  "Udf/$TYPEID(5678)":654321
}

Response

{
  "Udf/$TYPEID(5678)":654321
}