<back to all web services

GetAdministratorsMessage

The following routes are available for this service:
All Verbs/RestApi/Sitefinity/Analytics/GetUsers
All Verbs/RestApi/GetAdministrators

export class GetAdministratorsMessage
{
    public SiteId: string;
    public Take: number;
    public Skip: number;
    public Provider: string;

    public constructor(init?: Partial<GetAdministratorsMessage>) { (Object as any).assign(this, init); }
}

// @DataContract
export class AnalyticsUserNamePair
{
    // @DataMember
    public Username: string;

    // @DataMember
    public FullName: string;

    // @DataMember
    public Role: string;

    // @DataMember
    public IsAdmin: boolean;

    // @DataMember
    public UserID: string;

    // @DataMember
    public Avatar: string;

    // @DataMember
    public Provider: string;

    // @DataMember
    public ExternalProviderName: string;

    public constructor(init?: Partial<AnalyticsUserNamePair>) { (Object as any).assign(this, init); }
}

export class GetAdministratorsData
{
    public Users: AnalyticsUserNamePair[];
    public Total: number;

    public constructor(init?: Partial<GetAdministratorsData>) { (Object as any).assign(this, init); }
}

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