Trendsic Platform Service

<back to all web services

GetUsersByRoleId

Requires Authentication
The following routes are available for this service:
GET/v1/roles/{RoleId}/users
import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class UserSummary:
    user_id: Optional[str] = None
    user_name: Optional[str] = None
    email: Optional[str] = None
    created_utc: Optional[datetime.datetime] = None
    last_activity_utc: Optional[datetime.datetime] = None
    first_name: Optional[str] = None
    last_name: Optional[str] = None
    display_name: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetUsersByRoleIdResponse:
    users: List[UserSummary] = field(default_factory=list)
    response_status: Optional[ResponseStatus] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetUsersByRoleId:
    role_id: int = 0

Python GetUsersByRoleId DTOs

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

HTTP + JSV

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: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	Users: 
	[
		{
			UserId: 00000000000000000000000000000000,
			UserName: String,
			Email: String,
			CreatedUtc: 0001-01-01,
			LastActivityUtc: 0001-01-01,
			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
		}
	}
}