<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 .csv suffix or ?format=csv

HTTP + CSV

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: text/csv
Content-Type: text/csv
Content-Length: length

{"Take":0,"Skip":0,"Provider":"String"}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"Users":[{}],"Total":0}