JSON Properties
JSON properties are either optional, required, immutable, or ignored. The definitions are as follows:
Property | Description |
|---|---|
Optional | If the property is not provided on a PUT or POST, the server uses the default value for PUT requests or the current value stored on the server for POST. (Example: the description of a session). |
Required | If the property is not provided on a PUT or POST, an error is returned stating that the property must be provided. (Example: the timestamp of a HotMark). |
Ignored | Ignored properties are informational only in responses and are ignored for PUT and POST requests. |
Immutable | Immutable properties cannot be changed. If a PUT or POST request attempts to change or assign an immutable property, an error is returned. |