Trendsic Platform Service

<back to all web services

GetRoleByIdRequest

Requires Authentication
The following routes are available for this service:
GET,OPTIONS/v1/Roles/{RoleId}
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 Permission:
    permission_id: int = 0
    module: Optional[str] = None
    resource: Optional[str] = None
    action: Optional[str] = None
    name: Optional[str] = None
    description: Optional[str] = None
    tags: Optional[str] = None
    sort_order: int = 0
    is_active: bool = False
    created_utc: datetime.datetime = datetime.datetime(1, 1, 1)
    code: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class Role:
    role_id: int = 0
    tenant_id: Optional[str] = None
    code: Optional[str] = None
    name: Optional[str] = None
    description: Optional[str] = None
    is_system: bool = False
    is_active: bool = False
    created_utc: datetime.datetime = datetime.datetime(1, 1, 1)
    permissions: List[Permission] = field(default_factory=list)


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

Python GetRoleByIdRequest 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} HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"RoleId":0,"TenantId":"00000000000000000000000000000000","Code":"String","Name":"String","Description":"String","IsSystem":false,"IsActive":false,"CreatedUtc":"0001-01-01T00:00:00.0000000","Permissions":[{"PermissionId":0,"Module":"String","Resource":"String","Action":"String","Name":"String","Description":"String","Tags":"String","SortOrder":0,"IsActive":false,"CreatedUtc":"0001-01-01T00:00:00.0000000","Code":"String"}]}