Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

All devices players region entities are structured as follows:

entity:

  • [string] Country:  The country where the device is located (for example, "Germany")
  • [string] CountryLongName: The full name of the country in which the device is located (for example, "Federal Republic of Germany")
  • [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
  • [string] AdminAreaLevel1LongName: The full name of the largest subnational administrative unit of a country in which the device is located
  • [string] AdminAreaLevel2: The county name (within the United States), or a second-order civil entity below adminAreaLevel1, in which the device is located. 
  • [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.
  • [string] Locality: The name of the city, town, or rural area in which the device is located
  • [string] LocalityLongName: The full name of the city, town, or rural area in which the device is located
  • [double?] MinGPSLatitude:  The minimum GPS latitude (a coordinate which designates a rectangle on the map to indicate the current region)
  • [double?] MaxGPSLatitude: The maximum GPS latitude (a coordinate which designates a rectangle on the map to indicate the current region)
  • [double?] MinGPSLongitude: The minimum GPS longitude (a coordinate which designates a rectangle on the map to indicate the current region)
  • [double?] MaxGPSLongitude: The maximum GPS longitude (a coordinate which designates a rectangle on the map to indicate the current region)
  • [int] DevicesCount: The number of players on the network
  • [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.
  • [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).