<back to all web services

GetAdministratorsMessage

The following routes are available for this service:
All Verbs/RestApi/Sitefinity/Analytics/GetUsers
All Verbs/RestApi/GetAdministrators
import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetAdministratorsMessage:
    site_id: Optional[str] = None
    take: int = 0
    skip: int = 0
    provider: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class AnalyticsUserNamePair:
    username: Optional[str] = None
    full_name: Optional[str] = None
    role: Optional[str] = None
    is_admin: bool = False
    user_i_d: Optional[str] = None
    avatar: Optional[str] = None
    provider: Optional[str] = None
    external_provider_name: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetAdministratorsData:
    users: Optional[List[AnalyticsUserNamePair]] = None
    total: int = 0

Python GetAdministratorsMessage DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /RestApi/Sitefinity/Analytics/GetUsers HTTP/1.1 
Host: www.asg.com.au 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<GetAdministratorsMessage xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Telerik.Sitefinity.Analytics.Server.Infrastructure.Services.ServiceStackServices.Model">
  <Provider>String</Provider>
  <SiteId>00000000-0000-0000-0000-000000000000</SiteId>
  <Skip>0</Skip>
  <Take>0</Take>
</GetAdministratorsMessage>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<GetAdministratorsData xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Telerik.Sitefinity.Analytics.Server.Infrastructure.Services.ServiceStackServices.Model">
  <Total>0</Total>
  <Users xmlns:d2p1="http://schemas.datacontract.org/2004/07/Telerik.Sitefinity.Analytics.Server.Core.Domain.Model">
    <d2p1:AnalyticsUserNamePair i:nil="true" />
  </Users>
</GetAdministratorsData>