Blazor Diffusion

<back to all web services

UserData

User
Requires Authentication
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 Likes:
    artifact_ids: List[int] = field(default_factory=list)
    album_ids: List[int] = field(default_factory=list)


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class AlbumResult:
    id: int = 0
    name: Optional[str] = None
    slug: Optional[str] = None
    album_ref: Optional[str] = None
    owner_ref: Optional[str] = None
    primary_artifact_id: Optional[int] = None
    score: int = 0
    artifact_ids: List[int] = field(default_factory=list)


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class UserResult:
    ref_id: Optional[str] = None
    handle: Optional[str] = None
    avatar: Optional[str] = None
    profile_url: Optional[str] = None
    likes: Optional[Likes] = None
    albums: List[AlbumResult] = field(default_factory=list)


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class UserProfile:
    display_name: Optional[str] = None
    avatar: Optional[str] = None
    handle: Optional[str] = None


class SignupType(str, Enum):
    UPDATES = 'Updates'
    BETA = 'Beta'


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class UserDataResponse:
    user: Optional[UserResult] = None
    profile: Optional[UserProfile] = None
    signups: List[SignupType] = field(default_factory=list)
    roles: List[str] = field(default_factory=list)
    response_status: Optional[ResponseStatus] = None


# @ValidateRequest(Validator="IsAuthenticated")
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class UserData(IPost):
    pass

Python UserData DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /json/reply/UserData HTTP/1.1 
Host: blazordiffusion.com 
Accept: application/json
Content-Type: application/json
Content-Length: length

{}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"user":{"refId":"String","handle":"String","avatar":"String","profileUrl":"String","likes":{"artifactIds":[0],"albumIds":[0]},"albums":[{"id":0,"name":"String","slug":"String","albumRef":"String","ownerRef":"String","primaryArtifactId":0,"score":0,"artifactIds":[0]}]},"profile":{"displayName":"String","avatar":"String","handle":"String"},"signups":["Updates"],"roles":["String"],"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}