StringField

• Available Since API Version – 2.0\

The StringField type is used to represent alphanumeric fields in Maximizer. StringField objects contain the following properties:

• Value - The string value of the field. May include a "maxlength" property to indicate the maximum length of the field.\

Basic Read Request

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

Request

{
  "CompanyName":1
}

Response

{
  "CompanyName":"ABC Wine Shop"
}

Detailed Read Request

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

Request

{
  "CompanyName":{
    "Value":1
  }
}

Response

{
  "CompanyName":{
    "Value":"ABC Wine Shop"
  }
}

Create/Update Request

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

Request

{
  "CompanyName":"ABC Wine Shop"
}

Response

{
  "CompanyName":"ABC Wine Shop"
}