Trendsic Platform Service

<back to all web services

UserNotificationsRequest

Requires Authentication
Requires any of the roles:Worker, Agent, Administrator, Agent, Administrator
The following routes are available for this service:
GET,OPTIONS/v1/UserNotifications/{AgentId}
DELETE,OPTIONS/v1/UserNotifications/{NotificationId}
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 UserNotification:
    notification_id: int = 0
    agent_id: int = 0
    description: Optional[str] = None
    from_: Optional[str] = field(metadata=config(field_name='from'), default=None)
    created_date: datetime.datetime = datetime.datetime(1, 1, 1)
    type: Optional[str] = None
    url: Optional[str] = None
    ref_id: Optional[str] = None
    is_deleted: bool = False


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class UserNotificationsResponse:
    response_status: Optional[ResponseStatus] = None
    notifications: List[UserNotification] = field(default_factory=list)
    deleted: bool = False


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class UserNotificationsRequest:
    agent_id: int = 0
    notification_id: int = 0
    show_deleted: bool = False

Python UserNotificationsRequest 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.

GET /v1/UserNotifications/{AgentId} HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}},"Notifications":[{"NotificationId":0,"AgentId":0,"Description":"String","From":"String","CreatedDate":"0001-01-01T00:00:00.0000000","Type":"String","URL":"String","RefId":"String","IsDeleted":false}],"Deleted":false}