Site access for single operator

x-ms-visibility: "important"

Get site access for a single operator based on the operator id. Site access is given in hierarchical format, traversal can be done by giving parentSiteId.

Path Parameters

operatorId string required

Unique operator identifier.

Query Parameters

page int32 required

Page to be fetched. Default: 1

limit int32 required

Limit (No. of records per page). Max value: 100. Default: 100.

sortKey string

Sort field to be used. Supported values are 'name'. Default: 'name'

sortDescending boolean

Set to 'true' to sort descending based on sort key. Default: 'false'

search string

Free text filter for sites based on site name

Responses

• 200
• 400
• 401

---

Paginated site access for the operator

application/json

Schema

Example (from schema)

---

Schema

page int32
limit int32
totalRecords int32
hasNextPage boolean
hasPreviousPage boolean
items object[]
Array [
id int64
name string
]

{
  "page": 0,
  "limit": 0,
  "totalRecords": 0,
  "hasNextPage": true,
  "hasPreviousPage": true,
  "items": [
    {
      "id": 0,
      "name": "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 authorised

Loading...