Get an overview of sites

x-ms-visibility: "important"

Retrieve the total count of sites and their statuses.

Query Parameters

siteId int64

Filter by site ID. The results will include data from all the subsites as well.

Responses

• 200
• 400
• 401

---

Overview of sites, including count and statuses.

application/json

Schema

Example (from schema)

---

Schema

sites object
total int32
ok int32
error int32
offline int32
errorSites object[]
Array [
siteId int64
siteName string
issueType int32
Possible values: [0, 1]
Default value: 0
latitude double nullable
longitude double nullable
address string
]
offlineSites object[]
Array [
siteId int64
siteName string
issueType int32
Possible values: [0, 1]
Default value: 0
latitude double nullable
longitude double nullable
address string
]

{
  "sites": {
    "total": 0,
    "ok": 0,
    "error": 0,
    "offline": 0,
    "errorSites": [
      {
        "siteId": 0,
        "siteName": "string",
        "issueType": 0,
        "latitude": 0,
        "longitude": 0,
        "address": "string"
      }
    ],
    "offlineSites": [
      {
        "siteId": 0,
        "siteName": "string",
        "issueType": 0,
        "latitude": 0,
        "longitude": 0,
        "address": "string"
      }
    ]
  }
}

Exception Details

application/json

Schema

Example (from schema)

---

Schema

errorCode string
message string
errorNumber int32
helpLink string

{
  "errorCode": "string",
  "message": "string",
  "errorNumber": 0,
  "helpLink": "string"
}

User not authorized

Loading...