Trendsic Platform Service

<back to all web services

NotificationRecipientRequest

Requires Authentication
Requires any of the roles:Agent, Administrator, Agent, Administrator, Agent, Administrator, Agent, Administrator
The following routes are available for this service:
GET,POST,PUT,DELETE,OPTIONS/v1/NotificationRecipient/{NotificationRecipientId}
GET,POST,PUT,DELETE,OPTIONS/v1/NotificationRecipient
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 NotificationRecipient:
    notification_recipient_id: int = 0
    notification_message_id: int = 0
    recipient_id: int = 0
    folder: Optional[str] = None
    is_starred: bool = False
    is_important: bool = False
    is_read: bool = False
    is_deleted: bool = False


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class NotificationRecipientExtended(NotificationRecipient):
    recipient_name: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class NotificationRecipientResponse:
    response_status: Optional[ResponseStatus] = None
    notification_recipient: List[NotificationRecipientExtended] = field(default_factory=list)


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class NotificationRecipientRequest:
    notification_recipient: List[NotificationRecipientExtended] = field(default_factory=list)

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

POST /v1/NotificationRecipient/{NotificationRecipientId} HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length

{"NotificationRecipient":[{"RecipientName":"String","NotificationRecipientId":0,"NotificationMessageId":0,"RecipientId":0,"Folder":"String","IsStarred":false,"IsImportant":false,"IsRead":false,"IsDeleted":false}]}
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

{"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}},"NotificationRecipient":[{"RecipientName":"String","NotificationRecipientId":0,"NotificationMessageId":0,"RecipientId":0,"Folder":"String","IsStarred":false,"IsImportant":false,"IsRead":false,"IsDeleted":false}]}