Trendsic Platform Service

UpdateRoleRequest

The following routes are available for this service:
PUT,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 UpdateRoleRequest:
    role_id: int = 0
    code: Optional[str] = None
    name: Optional[str] = None
    description: Optional[str] = None
    permission_ids: List[int] = field(default_factory=list)

Python UpdateRoleRequest DTOs

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

HTTP + XML

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

PUT /v1/Roles/{RoleId} HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<UpdateRoleRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <Code>String</Code>
  <Description>String</Description>
  <Name>String</Name>
  <PermissionIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>0</d2p1:int>
  </PermissionIds>
  <RoleId>0</RoleId>
</UpdateRoleRequest>

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

<Role xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal.Models">
  <Code>String</Code>
  <CreatedUtc>0001-01-01T00:00:00</CreatedUtc>
  <Description>String</Description>
  <IsActive>false</IsActive>
  <IsSystem>false</IsSystem>
  <Name>String</Name>
  <Permissions>
    <Permission>
      <Action>String</Action>
      <Code>String</Code>
      <CreatedUtc>0001-01-01T00:00:00</CreatedUtc>
      <Description>String</Description>
      <IsActive>false</IsActive>
      <Module>String</Module>
      <Name>String</Name>
      <PermissionId>0</PermissionId>
      <Resource>String</Resource>
      <SortOrder>0</SortOrder>
      <Tags>String</Tags>
    </Permission>
  </Permissions>
  <RoleId>0</RoleId>
  <TenantId>00000000-0000-0000-0000-000000000000</TenantId>
</Role>