Region Data Type

Regions are localized states/provinces/municipalities within a country.

Properties
name data type description
name string The long name of the region. Like Utah / Ontario / Chongqing
code string The localized code for the region. Like UT. This will be the country code if there is no municipality code.
country Country The country this region resides in.
position number The position this region should have in drop-downs.
Properties inherited from BaseHibernateEntity
id number The unique internal ID of the object.
version number For internal use only. This is the serialization recorder for optimistic locking of several objects between sessions.
Properties inherited from BaseEntity
violations array of SimpleViolation A list of constraint violations, if any, that this object has.

Example

{
  "name" : "...",
  "code" : "...",
  "country" : {
    "name" : "...",
    "code" : "...",
    "codeAlt" : "...",
    "phoneCode" : 12345,
    "position" : 12345,
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  },
  "position" : 12345,
  "id" : 12345,
  "version" : 12345,
  "violations" : [ {
    "propertyName" : "...",
    "failureMessage" : "...",
    "stackTrace" : "..."
  }, {
    "propertyName" : "...",
    "failureMessage" : "...",
    "stackTrace" : "..."
  } ]
}