Trendsic Platform Service

<back to all web services

GetUsersByRoleId

Requires Authentication
The following routes are available for this service:
GET/v1/roles/{RoleId}/users
"use strict";
export class UserSummary {
    /** @param {{UserId?:string,UserName?:string,Email?:string,CreatedUtc?:string,LastActivityUtc?:string,FirstName?:string,LastName?:string,DisplayName?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    UserId;
    /** @type {string} */
    UserName;
    /** @type {string} */
    Email;
    /** @type {?string} */
    CreatedUtc;
    /** @type {?string} */
    LastActivityUtc;
    /** @type {string} */
    FirstName;
    /** @type {string} */
    LastName;
    /** @type {string} */
    DisplayName;
}
export class GetUsersByRoleIdResponse {
    /** @param {{Users?:UserSummary[],ResponseStatus?:ResponseStatus}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {UserSummary[]} */
    Users = [];
    /** @type {ResponseStatus} */
    ResponseStatus;
}
export class GetUsersByRoleId {
    /** @param {{RoleId?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    RoleId;
}

JavaScript GetUsersByRoleId DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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

GET /v1/roles/{RoleId}/users HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/json

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"Users":[{"UserId":"00000000000000000000000000000000","UserName":"String","Email":"String","CreatedUtc":"0001-01-01T00:00:00.0000000","LastActivityUtc":"0001-01-01T00:00:00.0000000","FirstName":"String","LastName":"String","DisplayName":"String String"}],"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}