Trendsic Platform Service

<back to all web services

GetRoleByIdRequest

Requires Authentication
The following routes are available for this service:
GET,OPTIONS/v1/Roles/{RoleId}

export class Permission
{
    public PermissionId: number;
    public Module: string;
    public Resource: string;
    public Action: string;
    public Name: string;
    public Description: string;
    public Tags: string;
    public SortOrder: number;
    public IsActive: boolean;
    public CreatedUtc: string;
    public Code: string;

    public constructor(init?: Partial<Permission>) { (Object as any).assign(this, init); }
}

export class Role
{
    public RoleId: number;
    public TenantId: string;
    public Code: string;
    public Name: string;
    public Description: string;
    public IsSystem: boolean;
    public IsActive: boolean;
    public CreatedUtc: string;
    public Permissions: Permission[] = [];

    public constructor(init?: Partial<Role>) { (Object as any).assign(this, init); }
}

export class GetRoleByIdRequest
{
    public RoleId: number;

    public constructor(init?: Partial<GetRoleByIdRequest>) { (Object as any).assign(this, init); }
}

TypeScript GetRoleByIdRequest 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.

GET /v1/Roles/{RoleId} HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/xml
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>