Trendsic Platform Service

<back to all web services

GetRolesRequest

Requires Authentication
The following routes are available for this service:
GET,OPTIONS/v1/Roles
<?php namespace dtos;

use DateTime;
use Exception;
use DateInterval;
use JsonSerializable;
use ServiceStack\{IReturn,IReturnVoid,IGet,IPost,IPut,IDelete,IPatch,IMeta,IHasSessionId,IHasBearerToken,IHasVersion};
use ServiceStack\{ICrud,ICreateDb,IUpdateDb,IPatchDb,IDeleteDb,ISaveDb,AuditBase,QueryDb,QueryDb2,QueryData,QueryData2,QueryResponse};
use ServiceStack\{ResponseStatus,ResponseError,EmptyResponse,IdResponse,ArrayList,KeyValuePair2,StringResponse,StringsResponse,Tuple2,Tuple3,ByteArray};
use ServiceStack\{JsonConverters,Returns,TypeContext};


class GetRolesRequest implements JsonSerializable
{
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        return empty($o) ? new class(){} : $o;
    }
}

PHP GetRolesRequest 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 HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ArrayOfRole xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal.Models">
  <Role>
    <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>
</ArrayOfRole>