When a list of properties is returned for display only, a different format is used than for those that can be edited. Since the JSON for properties is returned by many APIs, their format is listed here.
Property Value Structure
Property values return an array of details that describe the value details. Values are of a specific type, such as text or numbers. The JSON will include nulls for values types that are not populated.
In the example below, the value for a contact's first name is returned. The contact property only has a single value, so there is not description used. If the value was for a phone number, the description would include details like home, work, fax, etc. Since "John' is a string of text, it is only displayed for value, which is used for text properties.
Name |
Type |
Description |
|---|---|---|
description |
String |
Only populated for properties that are multi-value that include a value description. |
value |
String |
The text value for the property. |
valueDateUtc |
String |
The Date value for the property. |
valueDatetimeUtc |
String |
The DateTime value for the property. |
valueInt |
Number |
The Integer value for the property. |
valueNumber |
Number |
The Number value for the property. |
An example of this structure is below.
{ "description": null, } |
Property Data for Display Only
Name |
Type |
Description |
|---|---|---|
propertyID |
String |
The ID of the property. |
values |
Array |
An array of property values. See above for the structure of property values. |
