- Available Since API Version – 2.4\
The PhoneField type is used to represent phone number fields in Maximizer. PhoneField objects contain the following properties:
-
Default - A BooleanField indicating if this phone number is selected as the default phone number for the entry.\
-
Description - A StringField containing the description field for the phone number.\
-
Number - A StringField containing the phone number value.\
-
Extension - A StringField containing the extension for the phone number.\
Basic Read Request
The following example illustrates the syntax for a request for the default value of a PhoneField in a Read method call.
Request
{
"Phone":1
}
Response
{
"Phone":"123-456-7890"
}
Detailed Read Request
The following example illustrates the syntax for a request for all properties of a PhoneField in a Read method call.
Request
{
"Phone":{
"Default":1,
"Description":1,
"Number":1,
"Extension":1
}
}
Response
{
"Phone":{
"Default":true,
"Description":"Main",
"Number":"123-456-7890",
"Extension":"x321"
}
}
Create/Update Request
The following example illustrates the syntax for including a PhoneField in a Create or Update method call.
Request
{
"Phone":{
"Description":"Work",
"Number":"321-654-0987"
}
}
Response
{
"Phone":{
"Description":"Work",
"Number":"321-654-0987"
}
}