HP 3PAR Web Service API 1.3.1 Developer's Guide

When using tools that deserialize JSON into a class, this allows an omitted property of enumeration
type to be detected, since the member will not be assigned a non-zero value of a property and
will retain its default or preset value of 0.
For enumerations, the symbols used in this document are for convenience in referring to values of
enumerations, but are not part of the WSAPI. Integer values representing the symbols appear in
JSON objects. Clients can use any symbols with the integers.
JSON Types and API Types
JSON uses primitive types defined by IETF RFC 4627, including:
• string
• number
• boolean
• null
The properties returned in JSON output objects and the members provided in JSON input objects
use JSON primitive types with additional restrictions on valid values. Restrictions on values or
format are given names that appear in the Type column in Table 4 (page 19). These API types are
referenced in this guide in descriptions of JSON input and output.
Table 4 API Types
DescriptionType
JSON string with time in ISO 8601 format:8601
YYYY-MM-DDThh:mm:ssTZD,
where TZD is one of the following:
• Z
• +hh:mm
• -hh:mm
NOTE: For more information, see http://www.w3.org/TR/NOTE-datetime
The number of seconds since 01/01/1970 GMT.epoch
Also known as “Unix epoch.”
JSON string containing a hexadecimal value.Hex
JSON number restricted to a 32-bit signed integer where negative values are
ignored by the server, and treated as if not present.
igint32
JSON number restricted to a 32-bit signed integer.int32
JSON string containing six groups of two hexadecimal digits. The string may
or may not be separated by a hyphen (-); for example, either of the following
formats is possible:
MAC
• AC-16-2D-36-06-F7
• AC162D3606F7
A string of 27 or fewer characters, where a character is ‘a’ ‘z’, ‘A’ ‘Z’, ‘0’ ‘9’,
‘.’, ‘_’, or ‘ ‘.
Name27
• a–
z
• A–
Z
• 1–
9
Protocol and Message Format 19