Trendsic Platform Service

<back to all web services

GetUsersByRoleId

Requires Authentication
The following routes are available for this service:
GET/v1/roles/{RoleId}/users

export class UserSummary
{
    public UserId: string;
    public UserName: string;
    public Email: string;
    public CreatedUtc?: string;
    public LastActivityUtc?: string;
    public FirstName: string;
    public LastName: string;
    public DisplayName: string;

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

export class GetUsersByRoleIdResponse
{
    public Users: UserSummary[] = [];
    public ResponseStatus: ResponseStatus;

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

export class GetUsersByRoleId
{
    public RoleId: number;

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

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

<GetUsersByRoleIdResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
  <Users xmlns:d2p1="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal.Models">
    <d2p1:UserSummary>
      <d2p1:CreatedUtc>0001-01-01T00:00:00</d2p1:CreatedUtc>
      <d2p1:Email>String</d2p1:Email>
      <d2p1:FirstName>String</d2p1:FirstName>
      <d2p1:LastActivityUtc>0001-01-01T00:00:00</d2p1:LastActivityUtc>
      <d2p1:LastName>String</d2p1:LastName>
      <d2p1:UserId>00000000-0000-0000-0000-000000000000</d2p1:UserId>
      <d2p1:UserName>String</d2p1:UserName>
    </d2p1:UserSummary>
  </Users>
</GetUsersByRoleIdResponse>