<back to all web services

GetAdministratorsMessage

The following routes are available for this service:
All Verbs/RestApi/Sitefinity/Analytics/GetUsers
All Verbs/RestApi/GetAdministrators
"use strict";
export class GetAdministratorsMessage {
    /** @param {{SiteId?:string,Take?:number,Skip?:number,Provider?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    SiteId;
    /** @type {number} */
    Take;
    /** @type {number} */
    Skip;
    /** @type {string} */
    Provider;
}
export class AnalyticsUserNamePair {
    /** @param {{Username?:string,FullName?:string,Role?:string,IsAdmin?:boolean,UserID?:string,Avatar?:string,Provider?:string,ExternalProviderName?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Username;
    /** @type {string} */
    FullName;
    /** @type {string} */
    Role;
    /** @type {boolean} */
    IsAdmin;
    /** @type {string} */
    UserID;
    /** @type {string} */
    Avatar;
    /** @type {string} */
    Provider;
    /** @type {string} */
    ExternalProviderName;
}
export class GetAdministratorsData {
    /** @param {{Users?:AnalyticsUserNamePair[],Total?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {AnalyticsUserNamePair[]} */
    Users;
    /** @type {number} */
    Total;
}

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