| Requires any of the roles: | Worker, Agent, Administrator, Agent, Administrator |
| 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 .xml suffix or ?format=xml
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/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<UserNotificationsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
<Deleted>false</Deleted>
<Notifications>
<UserNotification>
<AgentId>0</AgentId>
<CreatedDate>0001-01-01T00:00:00</CreatedDate>
<Description>String</Description>
<From>String</From>
<IsDeleted>false</IsDeleted>
<NotificationId>0</NotificationId>
<RefId>String</RefId>
<Type>String</Type>
<URL>String</URL>
</UserNotification>
</Notifications>
<ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
<d2p1:ErrorCode>String</d2p1:ErrorCode>
<d2p1:Message>String</d2p1:Message>
<d2p1:StackTrace>String</d2p1:StackTrace>
<d2p1:Errors>
<d2p1:ResponseError>
<d2p1:ErrorCode>String</d2p1:ErrorCode>
<d2p1:FieldName>String</d2p1:FieldName>
<d2p1:Message>String</d2p1:Message>
<d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d5p1:KeyValueOfstringstring>
<d5p1:Key>String</d5p1:Key>
<d5p1:Value>String</d5p1:Value>
</d5p1:KeyValueOfstringstring>
</d2p1:Meta>
</d2p1:ResponseError>
</d2p1:Errors>
<d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d3p1:KeyValueOfstringstring>
<d3p1:Key>String</d3p1:Key>
<d3p1:Value>String</d3p1:Value>
</d3p1:KeyValueOfstringstring>
</d2p1:Meta>
</ResponseStatus>
</UserNotificationsResponse>