Trendsic Platform Service

<back to all web services

CreateRoleRequest

Requires Authentication
The following routes are available for this service:
POST,OPTIONS/v1/Roles
"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 CreateRoleRequest {
    /** @param {{Code?:string,Name?:string,Description?:string,PermissionIds?:number[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Code;
    /** @type {string} */
    Name;
    /** @type {string} */
    Description;
    /** @type {number[]} */
    PermissionIds = [];
}

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

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

<CreateRoleRequest 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>
</CreateRoleRequest>

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>