Trendsic Platform Service

<back to all web services

BroadcastRequest

Requires Authentication
Requires any of the roles:Agent, Administrator
The following routes are available for this service:
GET,OPTIONS/v1/Broadcast/{BroadcastId}
GET,OPTIONS/v1/Broadcast
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 Broadcast:
    broadcast_id: int = 0
    broadcast_title: Optional[str] = None
    broadcast_description: Optional[str] = None
    broadcast_begin: datetime.datetime = datetime.datetime(1, 1, 1)
    broadcast_begin_time: Optional[str] = None
    broadcast_end: datetime.datetime = datetime.datetime(1, 1, 1)
    broadcast_end_time: Optional[str] = None


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


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class BroadcastRequest:
    broadcast: List[Broadcast] = field(default_factory=list)

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

GET /v1/Broadcast/{BroadcastId} HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsv

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
		}
	},
	Broadcast: 
	[
		{
			BroadcastId: 0,
			BroadcastTitle: String,
			BroadcastDescription: String,
			BroadcastBegin: 0001-01-01,
			BroadcastBeginTime: String,
			BroadcastEnd: 0001-01-01,
			BroadcastEndTime: String
		}
	]
}