Trendsic Platform Service

<back to all web services

GetRoleByIdRequest

Requires Authentication
The following routes are available for this service:
GET,OPTIONS/v1/Roles/{RoleId}
"use strict";
export class Permission {
    /** @param {{PermissionId?:number,Module?:string,Resource?:string,Action?:string,Name?:string,Description?:string,Tags?:string,SortOrder?:number,IsActive?:boolean,CreatedUtc?:string,Code?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    PermissionId;
    /** @type {string} */
    Module;
    /** @type {string} */
    Resource;
    /** @type {string} */
    Action;
    /** @type {string} */
    Name;
    /** @type {string} */
    Description;
    /** @type {string} */
    Tags;
    /** @type {number} */
    SortOrder;
    /** @type {boolean} */
    IsActive;
    /** @type {string} */
    CreatedUtc;
    /** @type {string} */
    Code;
}
export class Role {
    /** @param {{RoleId?:number,TenantId?:string,Code?:string,Name?:string,Description?:string,IsSystem?:boolean,IsActive?:boolean,CreatedUtc?:string,Permissions?:Permission[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    RoleId;
    /** @type {string} */
    TenantId;
    /** @type {string} */
    Code;
    /** @type {string} */
    Name;
    /** @type {string} */
    Description;
    /** @type {boolean} */
    IsSystem;
    /** @type {boolean} */
    IsActive;
    /** @type {string} */
    CreatedUtc;
    /** @type {Permission[]} */
    Permissions = [];
}
export class GetRoleByIdRequest {
    /** @param {{RoleId?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    RoleId;
}

JavaScript GetRoleByIdRequest DTOs

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

HTTP + OTHER

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: text/jsonl

HTTP/1.1 200 OK
Content-Type: text/jsonl
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"}]}