Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: updated format

All device region entities are structured as follows:

entity:

[

Country string

] Country

 The country where the device is located (for example, "Germany")

[

CountryLongName string

] CountryLongName

The full name of the country in which the device is located (for example, "Federal Republic of Germany")

[

AdminAreaLevel1 string

] AdminAreaLevel1

The largest subnational administrative unit of a country (for example, "state" in the USA and "prefecture" in Japan) in which the device is located

[

AdminAreaLevel1LongName string

] AdminAreaLevel1LongName

The full name of the largest subnational administrative unit of a country in which the device is located

[

AdminAreaLevel2 string

] AdminAreaLevel2

The county name (within the United States), or a second-order civil entity below adminAreaLevel1, in which the device is located. 

[

AdminAreaLevel2LongName string

] AdminAreaLevel2LongName

The full county name (within the United States), or the full name of the second-order civil entity below adminAreaLevel1, in which the device is located.

[

Locality string

] Locality

The name of the city, town, or rural area in which the device is located

[

LocalityLongName string

] LocalityLongName

The full name of the city, town, or rural area in which the device is located

[

MinGPSLatitude Nullable<double>

] MinGPSLatitude

:  The minimum GPS latitude (a coordinate which designates a rectangle on the map to indicate the current region)

[

MaxGPSLatitude Nullable<double>

] MaxGPSLatitude

The maximum GPS latitude (a coordinate which designates a rectangle on the map to indicate the current region)

[

MinGPSLongitude Nullable<double>

] MinGPSLongitude

The minimum GPS longitude (a coordinate which designates a rectangle on the map to indicate the current region)

[

MaxGPSLongitude Nullable<double>

] MaxGPSLongitude

The maximum GPS longitude (a coordinate which designates a rectangle on the map to indicate the current region)

[

DevicesCount int

] DevicesCount

: The number of players on the network

[

DevicesHealthStatus DeviceHealthStatus[

]

]

DevicesHealthStatus

An aggregate of device status information. The array can contain the following string values: "Normal","Warning","Error", or "No Subscription". The presence of a value indicates that one or more devices is in that state.

[

LocationPath string

] LocationPath

: Includes the parts of the returned path (country, province, city, etc.) that are common to all players in a location (for example, if you query all players in California, "United States" would be a common to all players).