Trendsic Platform Service

<back to all web services

GetUsersByRoleId

Requires Authentication
The following routes are available for this service:
GET/v1/roles/{RoleId}/users
GetUsersByRoleId Parameters:
NameParameterData TypeRequiredDescription
RoleIdpathintNo
GetUsersByRoleIdResponse Parameters:
NameParameterData TypeRequiredDescription
UsersformList<UserSummary>No
ResponseStatusformResponseStatusNo
UserSummary Parameters:
NameParameterData TypeRequiredDescription
UserIdformGuidNo
UserNameformstringNo
EmailformstringNo
CreatedUtcformDateTime?No
LastActivityUtcformDateTime?No
FirstNameformstringNo
LastNameformstringNo
DisplayNameformstringNo

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

HTTP + CSV

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: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"Users":[{"UserId":"00000000000000000000000000000000","UserName":"String","Email":"String","CreatedUtc":"0001-01-01T00:00:00.0000000","LastActivityUtc":"0001-01-01T00:00:00.0000000","FirstName":"String","LastName":"String","DisplayName":"String String"}],"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}