Trendsic Platform Service

<back to all web services

CreateRoleRequest

Requires Authentication
The following routes are available for this service:
POST,OPTIONS/v1/Roles
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 CreateRoleRequest:
    code: Optional[str] = None
    name: Optional[str] = None
    description: Optional[str] = None
    permission_ids: List[int] = field(default_factory=list)

Python CreateRoleRequest 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.

POST /v1/Roles HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	Code: String,
	Name: String,
	Description: String,
	PermissionIds: 
	[
		0
	]
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

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