<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 'package:servicestack/servicestack.dart';

class GetAdministratorsMessage implements IConvertible
{
    String? SiteId;
    int? Take;
    int? Skip;
    String? Provider;

    GetAdministratorsMessage({this.SiteId,this.Take,this.Skip,this.Provider});
    GetAdministratorsMessage.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        SiteId = json['SiteId'];
        Take = json['Take'];
        Skip = json['Skip'];
        Provider = json['Provider'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'SiteId': SiteId,
        'Take': Take,
        'Skip': Skip,
        'Provider': Provider
    };

    getTypeName() => "GetAdministratorsMessage";
    TypeContext? context = _ctx;
}

// @DataContract
class AnalyticsUserNamePair implements IConvertible
{
    // @DataMember
    String? Username;

    // @DataMember
    String? FullName;

    // @DataMember
    String? Role;

    // @DataMember
    bool? IsAdmin;

    // @DataMember
    String? UserID;

    // @DataMember
    String? Avatar;

    // @DataMember
    String? Provider;

    // @DataMember
    String? ExternalProviderName;

    AnalyticsUserNamePair({this.Username,this.FullName,this.Role,this.IsAdmin,this.UserID,this.Avatar,this.Provider,this.ExternalProviderName});
    AnalyticsUserNamePair.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        Username = json['Username'];
        FullName = json['FullName'];
        Role = json['Role'];
        IsAdmin = json['IsAdmin'];
        UserID = json['UserID'];
        Avatar = json['Avatar'];
        Provider = json['Provider'];
        ExternalProviderName = json['ExternalProviderName'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'Username': Username,
        'FullName': FullName,
        'Role': Role,
        'IsAdmin': IsAdmin,
        'UserID': UserID,
        'Avatar': Avatar,
        'Provider': Provider,
        'ExternalProviderName': ExternalProviderName
    };

    getTypeName() => "AnalyticsUserNamePair";
    TypeContext? context = _ctx;
}

class GetAdministratorsData implements IConvertible
{
    List<AnalyticsUserNamePair>? Users;
    int? Total;

    GetAdministratorsData({this.Users,this.Total});
    GetAdministratorsData.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        Users = JsonConverters.fromJson(json['Users'],'List<AnalyticsUserNamePair>',context!);
        Total = json['Total'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'Users': JsonConverters.toJson(Users,'List<AnalyticsUserNamePair>',context!),
        'Total': Total
    };

    getTypeName() => "GetAdministratorsData";
    TypeContext? context = _ctx;
}

TypeContext _ctx = TypeContext(library: 'www.asg.com.au', types: <String, TypeInfo> {
    'GetAdministratorsMessage': TypeInfo(TypeOf.Class, create:() => GetAdministratorsMessage()),
    'AnalyticsUserNamePair': TypeInfo(TypeOf.Class, create:() => AnalyticsUserNamePair()),
    'GetAdministratorsData': TypeInfo(TypeOf.Class, create:() => GetAdministratorsData()),
    'List<AnalyticsUserNamePair>': TypeInfo(TypeOf.Class, create:() => <AnalyticsUserNamePair>[]),
});

Dart 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>