Trendsic Platform Service

<back to all web services

IncomingNotifications

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/IncomingNotifications/{Id}
GET,POST,PUT,DELETE,OPTIONS/v1/IncomingNotifications
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 IncomingNotificationObject:
    id: Optional[str] = None
    customer_id: Optional[str] = None
    message: Optional[str] = None
    notification_method: Optional[str] = None
    date_received: datetime.datetime = datetime.datetime(1, 1, 1)


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


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class IncomingNotifications(IncomingNotificationObject):
    api_key: Optional[str] = None

Python IncomingNotifications DTOs

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

HTTP + JSV

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

POST /v1/IncomingNotifications/{Id} HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	ApiKey: 00000000000000000000000000000000,
	Id: 00000000000000000000000000000000,
	CustomerId: 00000000000000000000000000000000,
	Message: String,
	NotificationMethod: 00000000000000000000000000000000,
	DateReceived: 0001-01-01
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	},
	IncomingNotifications: 
	[
		{
			Id: 00000000000000000000000000000000,
			CustomerId: 00000000000000000000000000000000,
			Message: String,
			NotificationMethod: 00000000000000000000000000000000,
			DateReceived: 0001-01-01
		}
	]
}