Trendsic Platform Service

<back to all web services

SearchUsers

The following routes are available for this service:
GET/users/search
import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class UserSummary:
    user_id: Optional[str] = None
    user_name: Optional[str] = None
    email: Optional[str] = None
    created_utc: Optional[datetime.datetime] = None
    last_activity_utc: Optional[datetime.datetime] = None
    first_name: Optional[str] = None
    last_name: Optional[str] = None
    display_name: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class SearchUsersResponse:
    results: List[UserSummary] = field(default_factory=list)
    page: int = 0
    page_size: int = 0
    total: int = 0
    response_status: Optional[ResponseStatus] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class SearchUsers:
    q: Optional[str] = None
    page: Optional[int] = None
    page_size: Optional[int] = None

Python SearchUsers 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 /users/search HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsonl
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

{"Results":[{"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"}],"Page":0,"PageSize":0,"Total":0,"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}